reusables 0.5.0

General Helpers and File Management

import reusables

reusables.extract_all("test/test_structure.zip", "my_archive")
# All files in the zip will be extracted into directory "my_archive"

reusables.config_dict('my_config.cfg')
# {'Section 1': {'key 1': 'value 1', 'key2': 'Value2'}, 'Section 2': {}}

reusables.find_all_files(".", ext=reusables.exts.pictures)
# ['/home/user/background.jpg', '/home/user/private.png']

reusables.count_all_files(".")
# 405

reusables.file_hash("test_structure.zip", hash_type="sha256")
# 'bc11af55928ab89771b9a141fa526a5b8a3dbc7d6870fece9b91af5d345a75ea'

reusables.safe_path('/home/user/eViL User\0\\/newdir$^&*/new^%file.txt')
# '/home/user/eViL User__/newdir____/new__file.txt'

Cookie Management

Firefox and Chrome Cookie management. (Chrome requires SQLite 3.8 or greater.)

fox = reusables.FirefoxCookies()
# Automatically uses the DB of the default profile, can specify db=<path>

fox.add_cookie("example.com", "MyCookie", "Cookie contents!")

fox.find_cookies(host="Example")
# [{'host': u'example.com', 'name': u'MyCookie', 'value': u'Cookie contents!'}]

fox.delete_cookie("example.com", "MyCookie")

Namespace

Dictionary management class, similar to Bunch, but designed so that sub-dictionaries are recursively made into namespaces.

my_breakfast = {"spam": {"eggs": {"sausage": {"bacon": "yummy"}}}}
namespace_breakfast = reusables.Namespace(**my_breakfast)

print(namespace_breakfast.spam.eggs.sausage.bacon)
# yummy

print(namespace_breakfast.spam.eggs['sausage'].bacon)
# yummy

str(namespace_breakfast['spam'].eggs)
# "{'sausage': {'bacon': 'yummy'}}"

namespace_breakfast.to_dict()
#{'spam': {'eggs': {'sausage': {'bacon': 'yummy'}}}}

dict(namespace_breakfast)
# {'spam': <Namespace: {'eggs': {'sausage': {'bacon': '...>}
# This is NOT the same as .to_dict() as it is not recursive

DateTime

Easy formatting for datetime objects. It also adds auto parsing for ISO formatted time.

current_time = reusables.DateTime() # same as datetime.datetime.now(), as DateTime object

current_time.format("Wake up {son}, it's {hours}:{minutes} {periods}!"
                    "I don't care if it's a {day-fullname}, {command}!",
                    son="John",
                    command="Get out of bed!")
# "Wake up John, it's 09:51 AM! I don't care if it's a Saturday, Get out of bed!!"

Examples based on Mon Mar 28 13:27:11 2016

Logging

logger = reusables.get_logger(__name__)
# By default it adds a stream logger to sys.stderr

logger.info("Test")
# 2016-04-25 19:32:45,542 __main__     INFO     Test

There are multiple log formatters provided, as well as additional helper functions

reusables.remove_stream_handlers(logger)
# remove_file_handlers() and remove_all_handlers() also available

stream_handler = reusables.get_stream_handler(log_format=reusables.log_detailed_format)
logger.addHandler(stream_handler)
logger.info("Example log entry")
# 2016-04-25 19:42:52,633 : 315147 MainThread : reusables.log INFO Example log entry

Because ReStructuredText tables don’t preserve whitespace (even with literals), which is important to show distinction in these formatters, here’s it in a code block instead.

+------------------------+--------------------------------------------------------------------------------------+
| Formatter              | Example Output                                                                       |
+========================+======================================================================================+
| log_easy_read_format   | 2016-04-26 21:17:51,225 - example_logger  INFO      example log message              |
|                        | 2016-04-26 21:17:59,074 - example_logger  ERROR     Something broke                  |
+------------------------+--------------------------------------------------------------------------------------+
| log_detailed_format    | 2016-04-26 21:17:51,225 :  7020 MainThread : example_logger INFO example log message |
|                        | 2016-04-26 21:17:59,074 : 14868 MainThread : example_logger ERROR Something broke    |
+------------------------+--------------------------------------------------------------------------------------+
| log_level_first_format | INFO - example_logger - 2016-04-26 21:17:51,225 - example log message                |
|                        | ERROR - example_logger - 2016-04-26 21:17:59,074 - Something broke                   |
+------------------------+--------------------------------------------------------------------------------------+
| log_threaded_format    | 7020 MainThread : example log message                                                |
|                        | 14868 MainThread : Something broke                                                   |
+------------------------+--------------------------------------------------------------------------------------+
| log_easy_thread_format |  7020 MainThread : example_logger  INFO      example log message                     |
|                        | 14868 MainThread : example_logger  ERROR     Something broke                         |
+------------------------+--------------------------------------------------------------------------------------+
| log_common_format      | 2016-04-26 21:17:51,225 - example_logger - INFO - example log message                |
|                        | 2016-04-26 21:17:59,074 - example_logger - ERROR - Something broke                   |
+------------------------+--------------------------------------------------------------------------------------+

Extension Groups

It’s common to be looking for a specific type of file.

if file_path.endswith(reusables.exts.pictures):
    print("{} is a picture file".format(file_path))

That’s right, str.endswith (as well as str.startswith) accept a tuple to search.

Wrappers

There are tons of wrappers for caching and saving inputs and outputs, this is a different take that requires the function returns a result not yet provided.

@reusables.unique(max_retries=100, error_text="All UIDs taken!")
def gen_small_uid():
    import random
    return random.randint(0, 100)