tracktolib 0.45.0__tar.gz → 0.46.1__tar.gz

{tracktolib-0.45.0 → tracktolib-0.46.1}/PKG-INFO

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

{tracktolib-0.45.0 → tracktolib-0.46.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tracktolib"
-version = "0.45.0"
+version = "0.46.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.45.0"
+version = "0.46.1"
 tag_format = "$version"
 version_files = [
     "pyproject.toml:version"

{tracktolib-0.45.0 → tracktolib-0.46.1}/setup.py

@@ -20,7 +20,7 @@ extras_require = \
 
 setup_kwargs = {
     'name': 'tracktolib',
-    'version': '0.45.0',
+    'version': '0.46.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.45.0 → tracktolib-0.46.1}/tracktolib/api.py

@@ -24,6 +24,7 @@ from .utils import json_serial
 
 try:
     from fastapi import params, APIRouter
+    from fastapi.routing import APIRoute
     from fastapi.responses import JSONResponse
     from pydantic.alias_generators import to_camel
     from pydantic import BaseModel, ConfigDict
@@ -205,14 +206,56 @@ _NoneType = type(None)
 
 class IgnoreConfig(BaseModel):
     endpoints: dict[str, dict[Method, bool]]
-    ignore_default: bool = True
+    ignore_missing: bool = True
 
 
-def _get_ignore_config() -> IgnoreConfig | None:
+def get_ignore_config() -> IgnoreConfig | None:
     _config = os.getenv("IGNORE_CONFIG")
     return IgnoreConfig.model_validate_json(_config) if _config else None
 
 
+def set_ignore_config(config: str | IgnoreConfig):
+    if isinstance(config, str):
+        config = IgnoreConfig.model_validate_json(config)
+    os.environ["IGNORE_CONFIG"] = config.model_dump_json()
+
+
+def _filter_route(route: APIRoute, ignored_route: dict[Method, bool], ignore_missing: bool) -> APIRoute | None:
+    # If no config is provided and default is to ignore missing, return the route
+    if ignored_route is None and not ignore_missing:
+        return route
+
+    has_methods = False
+    enabled_methods = {method for method, has_access in ignored_route.items() if has_access}
+    for method in list(route.methods):
+        # If the config is not specified, we remove the method if ignore_missing is True
+        if method not in ignored_route:
+            if ignore_missing:
+                route.methods -= {method}
+                continue
+            else:
+                has_methods = True
+                continue
+        elif method not in enabled_methods:
+            route.methods -= {method}
+        else:
+            has_methods = True
+
+    if not has_methods:
+        return None
+    return route
+
+
+def filter_routes(routes: list[APIRoute], ignore_config: IgnoreConfig) -> list[APIRoute]:
+    _routes = []
+    for route in routes:
+        _ignored_route = ignore_config.endpoints.get(route.path)
+        _route = _filter_route(route, _ignored_route or {}, ignore_missing=ignore_config.ignore_missing)
+        if _route is not None:
+            _routes.append(_route)
+    return _routes
+
+
 def _get_return_type(fn):
     return_type = get_type_hints(fn)["return"]
     _args = get_args(return_type)
@@ -228,14 +271,8 @@ def add_endpoint(
     *,
     dependencies: Dependencies = None,
 ):
-    _ignore_config = _get_ignore_config()
+    _ignore_config = get_ignore_config()
     for _method, _meta in endpoint.methods.items():
-        # Do not add endpoint if it is not in the ignore config
-        if _ignore_config is not None:
-            _has_access = _ignore_config.endpoints.get(path, {}).get(_method, not _ignore_config.ignore_default)
-            if not _has_access:
-                continue
-        #
         _fn = _meta["fn"]
         _status_code = _meta["status_code"]
         _dependencies = _meta["dependencies"]