notalib 1.2.0

A collection of utility functions & classes

notalib

Collection of small Python utility functions and classes. Some are written by me, some are taken from StackOverflow and customized (I tried to provide links to original sources where possible). This repo never aimed to be a library of any sort (but now it is).

Install

pip install notalib

Or with poetry:

poetry add notalib

Maintenance & bugfixes

While I try to fix bugs, add new features, and review any PRs when I have time, there're no promises and no set timeframes, even if a bug is critical. That's a project I do in my free time, free of charge.

If that's not enough for you or you have an urgent request, there are paid maintenance options (bugfixing, features, expedite PR review, 24h security responses). Contact me for prices: [e-mail]

Also feel free to just send me money:

• MasterCard: 5559 4925 7484 0297
• PayPal: paypal.me/thisism1kc

Donations are always appreciated, even if you send 10$.

Utils included

notalib.array.as_chunks :fire:

Iterates over your array in chunks of at most N elements.

from notalib.array import as_chunks

arr = [1,2,3,4,5]
for chunk in as_chunks(arr, 2):
    print(chunk)
# [1,2]
# [3,4]
# [5]

notalib.array.ensure_iterable :fire:

Keeps iterable things like lists intact, turns single values into single-element lists. Useful for functions that can accept both.

ensure_iterable([1,2,3])  # --> [1,2,3]
ensure_iterable((1,2,3))  # --> (1,2,3)
ensure_iterable(1)        # --> [1]
ensure_iterable('smth')   # --> ['smth']

def my_function(one_or_multiple_args):
    for arg in ensure_iterable(one_or_multiple_args):
        ...
        
my_function(['log', 'smog'])
my_function('dog')

notalib.combinator.Combinator :fire:

notalib.date.parse_month

notalib.date.parse_date

notalib.date.normalize_date :fire:

notalib.date.get_week_number

Returns the number of the week by date

get_week_number(arrow.get('2021-12-31'))
# 53
get_week_number(arrow.get('2022-01-01'))
# 1
get_week_number(arrow.get('2022-01-06'))
# 2

notalib.dict.find_field

notalib.dict.find_value

notalib.dict.normalize_dict :fire:

notalib.dict.filter_dict

Filters dictionary by keys_to_filter set.

src = {
	'Some...': "BODY",
	'once': "told me",
	'the world': "is gonna roll me",
}
res = filtered_dict(src, ("Some...", "once"))
res
# {'Some...': 'BODY', 'once': 'told me'}
res = filtered_dict(src, [])
res
# {}

notalib.format.format_long_list

notalib.hypertext.strip_tags :fire:

notalib.hypertext.TablePrinter :fire:

Prints an HTML table, row by row, from the given data, using attrs or dictionary keys as columns.

Two ways to use it:

• Call header() / entry() / footer() manually

from notalib.hypertext import TablePrinter
t = TablePrinter(['a', 'b'])
t.header()
# '<table><thead><tr><th>a</th><th>b</th></tr></thead><tbody>'
t.entry({'a': 1, 'b': 2})
# '<tr><td>1</td><td>2</td></tr>\n'
t.entry({'a': 11, 'b': 22})
# '<tr><td>11</td><td>22</td></tr>\n'
t.footer()
# '</tbody></table>'

• Pass an iterable to iterator_over()

from notalib.hypertext import TablePrinter
t = TablePrinter(['a', 'b'])
list(t.iterator_over([ {'a': 11, 'b': 22} ]))
# ['<table><thead><tr><th>a</th><th>b</th></tr></thead><tbody>',
#  '<tr><td>11</td><td>22</td></tr>\n',
#  '</tbody></table>']

notalib.polosa.polosa :fire: :fire: :fire: :fire: :fire:

18023/2000000   294.8/sec   Processing transaction ID#84378473 (2020-01-04)

The CLI progress indicator you've always dreamt of: shows current and total if available, measures current speed, can show your comments for each element, makes sure not to slow down your terminal with frequent updates. See this short demo.

Cheat sheet

## Basic usage
with polosa() as p:
    p.tick()
# 467344   201.2/sec

## Specify total number of elements:
with polosa(total=1337) as p:
# 26/1337   1.2/sec

## Print something useful about every element:
p.tick(caption=my_order.time_created)
# 1723910/2000000   319231.2/sec   2020-01-01 15:37:00

notalib.range.Range

notalib.time.Timing :fire:

Measures time spent on executing your code. Killer feature: it can be used as a reusable context.

timing = Timing()
...
with timing:
    do_something()
# That's it, do something with the measurement
log(f'Operation took {timing.result} sec')

If you just want to print measurements into console, there's a shorthand:

timing = Timing(auto_print=True)
...
with timing:
    do_something()

notalib.trendsetter.Trendsetter :fire:

Pandas-related

notalib.pandas.pandasplus.row_to_dict

Django-related

notalib.django.auth.StaticBackend

notalib.django.auth.SettingsBackend

notalib.django.xauth

Endpoints for easier authentication in APIs. Requires Django REST framework.

Provides endpoints:

• /xauth/check — returns code 200 if client is authenticated (or global permissions are set to AllowAny), 403 if not
• /xauth/auth-post — authenticates a client; accepts two POST parameters username and password; returns code 200 on success and 403 on failure

How to use:

1. Make sure Django REST framework is installed.
2. Add 'notalib.django_xauth' to INSTALLED_APPS.
3. Run manage.py migrate django_xauth (doesn't actually change your DB).
4. Add something like this to your urls.py: path('xauth/', include('notalib.django_xauth.urls')),

notalib.django.colorlog.ColorFormatter

notalib.django.filterset :fire:

notalib.django.formplus.MonthField

notalib.django.formplus.ChoiceWithDefault

notalib.django.formplus.IntegerArrayField

notalib.django.formplus.StringArrayField

notalib.django.formplus.MonthArrayField

notalib.django.request_time_middleware.RequestTimeLoggingMiddleware

notalib.django.stream.stream_json

Stream all elements of iterable object as JSON array using the StreamingHttpResponse class.

class SomeViewSet(...):
    ...
    
    def list(self, request, *args, **kwargs):
        ...
        return stream_json(data)