My project utils package, that I use in my projects.
Project description
Dev utils
For what?
I made this project to avoid copy-pasting with utils in my projects. I was aiming to simplify working with sqlalchemy, FastAPI and other libs.
Install
Package has optional dependencies, so if you use it in some specific cases, install only needed dependencies.
For profiling:
pip install "python-dev-utils[profiling]"
For SQLAlchemy filters:
pip install "python-dev-utils[sqlalchemy_filters]"
For FastAPI verbose HTTP exceptions:
pip install "python-dev-utils[fastapi_exceptions]"
For extract OpenAPI cli.
pip install "python-dev-utils[extract_openapi]"
Profiling
Profiling utils. Now available 2 profilers and 2 middlewares (FastAPI) for such profilers:
- SQLAlchemyQueryProfiler - profile entire sqlalchemy query - it text, params, duration.
- SQLAlchemyQueryCounter - count sqlalchemy queries.
SQLAlchemy Filters
Converters for SQLAlchemy filters. Now available 3 converters:
- Simple filter converter (key-value with equals operator).
- Advanced filter converter (key-value with custom operators).
- Django filter converter (Django filters adapter with double underscore lookups).
Filters must be provided in a dict or list or dicts and will be applied sequentially.
Simple filters
Simple filters are simle. There are key
- value
dicts (you can use one dict with all filters,
or list of dicts. There is no difference), which converts to SQLAlchemy filters with ==
operator.
filter_spec = [
{'field_name_1': 123, 'field_name_2': 'value'},
{'other_name_1': 'other_value', 'other_name_2': 123},
# ...
]
No other specific usages presents. it is simple.
Advanced filters
Advanced filters continues the idea of simple-filter, but add operator key.
{
"field": "my_field",
"value": 25,
"operator": ">",
}
or
[
{
"field": "my_id_field",
"value": [1,2,3,4,5],
"operator": "contains",
},
{
"field": "my_bool_field",
"value": False,
"operator": "is_not",
},
]
This is the list of operators that can be used:
=
>
<
>
'<=
is
is_not
between
contains
Django filters
Django filters implements django ORM adapter for filters. You can use filters like
my_field__iexact=25
or my_dt_field__date__ge=datetime.date(2023, 3, 12)
. See django
documentation for more information.
Now implements all field filters, except nester relationships.
This is the list of operators that can be used:
exact
iexact
contains
icontains
in
gt
gte
lt
lte
startswith
istartswith
endswith
iendswith
range
date
year
iso_year
month
day
week
week_day
iso_week_day
quarter
time
hour
minute
second
isnull
regex
iregex
FastAPI Verbose HTTP exceptions
Verbose exceptions with single format. This utils was inspired by drf-exceptions-hog, but implemented for FastAPI.
To work with this util you must add exception handlers in your FastAPI project like this:
from fastapi import FastAPI
from dev_utils.fastapi.verbose_http_exceptions.handlers import (
apply_verbose_http_exception_handler,
apply_all_handlers,
)
app = FastAPI()
apply_all_handlers(app)
# or
apply_verbose_http_exception_handler(app)
# See document-strings of functions for more information.
Then all (or some specific part of) your exceptions will be returned to users in JSON like this:
{
"code": "validation_error",
"type": "literal_error",
"message": "Input should be 1 or 2",
"attr": "a",
"location": "query",
}
or this (multiple exceptions supported too):
{
"code": "multiple",
"type": "multiple",
"message": "Multiple exceptions ocurred. Please check list for details.",
"attr": null,
"location": null,
"nested_errors": [
{
"code": "validation_error",
"type": "literal_error",
"message": "Input should be 1 or 2",
"attr": "a",
"location": "query",
},
{
"code": "validation_error",
"type": "missing",
"message": "Field required",
"attr": "b",
"location": "query",
}
]
}
apply_all_handler
function also has override_422_openapi
param (default True). You can turn
it off to avoid overriding 422 errors in your application OpenAPI schema.
Export OpenAPI
If you want to export your OpenAPI schema from FastAPI application via CLI, you can use OpenAPI exporter from this package.
python3 -m dev_utils.fastapi.openapi.exporter \
"main:app" \
--app-dir "my/path/to/main" \
--out "custom_name.json"
CLI params:
"main:app"
- path to app with format "file_name:name_of_app_var"--app-dir
- directory of app file contains.--out
- custom file name and format (JSON and YAML available).
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.
Source Distribution
Built Distribution
Hashes for python_dev_utils-1.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0810b43bfdd447330492cf96b66e5da271bb28163bebca4dfe0f2c015fbad462 |
|
MD5 | a45bef4919d63fdb56643597a8afdb46 |
|
BLAKE2b-256 | d2fccb324c48152e2981d797ca6b6324c03db1c0bce36cd63ca7af6c2331c35a |