A collection of utility functions & classes
Project description
notalib
![Coverage Status](https://pypi-camo.freetls.fastly.net/d1d7ab6f682c837ab0f1eb05058ff06b18964481/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6d316b632f6e6f74616c69622f62616467652e7376673f6272616e63683d6d6173746572)
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
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.dict.find_field
notalib.dict.find_value
notalib.dict.normalize_dict :fire:
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.StaticBackend
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 parametersusername
andpassword
; returns code 200 on success and 403 on failure
How to use:
- Make sure Django REST framework is installed.
- Add
'notalib.django_xauth'
to INSTALLED_APPS. - Run
manage.py migrate django_xauth
(doesn't actually change your DB). - 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.