tracktolib 0.38.1__tar.gz → 0.39.1__tar.gz

{tracktolib-0.38.1 → tracktolib-0.39.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tracktolib
-Version: 0.38.1
+Version: 0.39.1
 Summary: Utility library for python
 Home-page: https://github.com/tracktor/tracktolib
 License: MIT

{tracktolib-0.38.1 → tracktolib-0.39.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tracktolib"
-version = "0.38.1"
+version = "0.39.1"
 description = "Utility library for python"
 authors = ["Julien Brayere <julien.brayere@tracktor.fr>"]
 license = "MIT"
@@ -70,7 +70,7 @@ pythonPlatform = "Linux"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.38.1"
+version = "0.39.1"
 tag_format = "$version"
 version_files = [
     "pyproject.toml:version"

{tracktolib-0.38.1 → tracktolib-0.39.1}/setup.py

@@ -20,7 +20,7 @@ extras_require = \
 
 setup_kwargs = {
     'name': 'tracktolib',
-    'version': '0.38.1',
+    'version': '0.39.1',
     'description': 'Utility library for python',
     'long_description': "# Tracktolib\n\n[![Python versions](https://img.shields.io/pypi/pyversions/tracktolib)](https://pypi.python.org/pypi/tracktolib)\n[![Latest PyPI version](https://img.shields.io/pypi/v/tracktolib?logo=pypi)](https://pypi.python.org/pypi/tracktolib)\n[![CircleCI](https://circleci.com/gh/Tracktor/tracktolib/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/Tracktor/tracktolib?branch=master)\n\nUtility library for python\n\n# Installation\n\nYou can choose to not install all the dependencies by specifying\nthe [extra](https://python-poetry.org/docs/cli/#options-4) parameter such as:\n\n```bash\npoetry add tracktolib@latest -E pg-sync -E tests --group dev \n```\n\nHere we only install the utilities using `psycopg` (pg-sync) and `deepdiff` (tests) for the dev environment.\n\n# Utilities\n\n- **log**\n\nUtility functions for logging.\n\n```python\nimport logging\nfrom tracktolib.logs import init_logging\n\nlogger = logging.getLogger()\nformatter, stream_handler = init_logging(logger, 'json', version='0.0.1')\n```\n\n- **pg**\n\nUtility functions for [asyncpg](https://github.com/MagicStack/asyncpg)\n\n- **pg-sync**\n\nUtility functions based on psycopg such as `fetch_one`, `insert_many`, `fetch_count` ...\n\nTo use the functions, create a `Connection` using psycopg: `conn = psycopg2.connect()`\n\n*fetch_one*\n\n```python\nfrom pg.pg_sync import (\n    insert_many, fetch_one, fetch_count, fetch_all\n)\n\ndata = [\n    {'foo': 'bar', 'value': 1},\n    {'foo': 'baz', 'value': 2}\n]\ninsert_many(conn, 'public.test', data)  # Will insert the 2 dict\nquery = 'SELECT foo from public.test order by value asc'\nvalue = fetch_one(conn, query, required=True)  # Will return {'foo': 'bar'}, raise an error is not found\nassert fetch_count(conn, 'public.test') == 2\nquery = 'SELECT * from public.test order by value asc'\nassert fetch_all(conn, query) == data\n\n```\n\n- **tests**\n\nUtility functions for testing\n\n- **s3-minio**\n\nUtility functions for [minio](https://min.io/docs/minio/linux/developers/python/API.html)\n\n- **s3**\n\nUtility functions for [aiobotocore](https://github.com/aio-libs/aiobotocore)\n\n- **logs**\n\nUtility functions to initialize the logging formatting and streams\n\n- **http**\n\nUtility functions using [httpx](https://www.python-httpx.org/)\n\n- **api**\n\nUtility functions using [fastapi](https://fastapi.tiangolo.com/)\n",
     'author': 'Julien Brayere',

{tracktolib-0.38.1 → tracktolib-0.39.1}/tracktolib/api.py

@@ -13,6 +13,7 @@ from .utils import json_serial, to_camel_case
 try:
     from fastapi import params, APIRouter
     from fastapi.responses import JSONResponse
+    import pydantic
     from pydantic import BaseModel
     import starlette.status
 except ImportError:
@@ -53,7 +54,7 @@ class MethodMeta(TypedDict):
     dependencies: Dependencies
     path: str | None
     response_model: Type[BaseModel | None | Sequence[BaseModel]] | None
-
+    openapi_extra: dict[str, Any] | None
 
 @dataclass
 class Endpoint:
@@ -67,52 +68,62 @@ class Endpoint:
     def get(self, status_code: StatusCode = None,
             dependencies: Dependencies = None,
             path: str | None = None,
-            model: Type[B] | None = None):
+            model: Type[B] | None = None,
+            openapi_extra: dict[str, Any] | None = None):
         return _get_method_wrapper(cls=self, method='GET',
                                    status_code=status_code,
                                    dependencies=dependencies,
                                    path=path,
-                                   model=model)
+                                   model=model,
+                                   openapi_extra=openapi_extra)
 
     def post(self, *, status_code: StatusCode = None,
              dependencies: Dependencies = None,
              path: str | None = None,
-             model: Type[B] | None = None):
+             model: Type[B] | None = None,
+             openapi_extra: dict[str, Any] | None = None):
         return _get_method_wrapper(cls=self, method='POST',
                                    status_code=status_code,
                                    dependencies=dependencies,
                                    path=path,
-                                   model=model)
+                                   model=model,
+                                   openapi_extra=openapi_extra)
 
     def put(self, status_code: StatusCode = None,
             dependencies: Dependencies = None,
             path: str | None = None,
-            model: Type[B] | None = None):
+            model: Type[B] | None = None,
+            openapi_extra: dict[str, Any] | None = None):
         return _get_method_wrapper(cls=self, method='PUT',
                                    status_code=status_code,
                                    dependencies=dependencies,
                                    path=path,
-                                   model=model)
+                                   model=model,
+                                   openapi_extra=openapi_extra)
 
     def delete(self, status_code: StatusCode = None,
                dependencies: Dependencies = None,
                path: str | None = None,
-               model: Type[B] | None = None):
+               model: Type[B] | None = None,
+               openapi_extra: dict[str, Any] | None = None):
         return _get_method_wrapper(cls=self, method='DELETE',
                                    status_code=status_code,
                                    dependencies=dependencies,
                                    path=path,
-                                   model=model)
+                                   model=model,
+                                   openapi_extra=openapi_extra)
 
     def patch(self, status_code: StatusCode = None,
               dependencies: Dependencies = None,
               path: str | None = None,
-              model: Type[B] | None = None):
+              model: Type[B] | None = None,
+              openapi_extra: dict[str, Any] | None = None):
         return _get_method_wrapper(cls=self, method='PATCH',
                                    status_code=status_code,
                                    dependencies=dependencies,
                                    path=path,
-                                   model=model)
+                                   model=model,
+                                   openapi_extra=openapi_extra)
 
 
 def _get_method_wrapper(cls: Endpoint, method: Method,
@@ -120,14 +131,16 @@ def _get_method_wrapper(cls: Endpoint, method: Method,
                         status_code: StatusCode = None,
                         dependencies: Dependencies = None,
                         path: str | None = None,
-                        model: Type[B] | None = None):
+                        model: Type[B] | None = None,
+                        openapi_extra: dict[str, Any] | None = None):
     def _set_method_wrapper(func: EnpointFn):
         _meta: MethodMeta = {
             'fn': func,
             'status_code': status_code,
             'dependencies': dependencies,
             'path': path,
-            'response_model': model
+            'response_model': model,
+            'openapi_extra': openapi_extra
         }
         cls._methods[method] = _meta
 
@@ -169,7 +182,8 @@ def add_endpoint(path: str,
                              name=getdoc(_fn),
                              response_model=_response_model,
                              status_code=_status_code,
-                             dependencies=[*(_dependencies or []), *(dependencies or [])])
+                             dependencies=[*(_dependencies or []), *(dependencies or [])],
+                             openapi_extra=_meta.get('openapi_extra'))
 
 
 @dataclass(init=False)
@@ -187,11 +201,15 @@ class JSONSerialResponse(JSONResponse):
         ).encode("utf-8")
 
 
-class CamelCaseModel(BaseModel):
-    class Config:
-        alias_generator = to_camel_case
-        allow_population_by_field_name = True
-
+if pydantic.__version__ < '2.0.0':
+    class CamelCaseModel(BaseModel): # type: ignore
+        class Config:
+            alias_generator = to_camel_case
+            allow_population_by_field_name = True
+else:
+    class CamelCaseModel(BaseModel):
+        def __init__(self):
+            raise NotImplementedError('Please use pydantic < 2.0.0')
 
 def check_status(resp, status: int = starlette.status.HTTP_200_OK):
     assert resp.status_code == status, json.dumps(resp.json(), indent=4)