tracktolib 0.47.0__tar.gz → 0.47.2__tar.gz

{tracktolib-0.47.0 → tracktolib-0.47.2}/PKG-INFO

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

{tracktolib-0.47.0 → tracktolib-0.47.2}/pyproject.toml

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

{tracktolib-0.47.0 → tracktolib-0.47.2}/setup.py

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

@@ -19,7 +19,7 @@ from typing import (
     get_origin,
 )
 
-from .utils import json_serial
+from .utils import json_serial, get_first_line
 
 try:
     from fastapi import params, APIRouter
@@ -66,6 +66,9 @@ class MethodMeta(TypedDict):
     path: str | None
     response_model: Type[BaseModel | None | Sequence[BaseModel]] | None
     openapi_extra: dict[str, Any] | None
+    name: str | None
+    summary: str | None
+    description: str | None
 
 
 @dataclass
@@ -83,6 +86,9 @@ class Endpoint:
         path: str | None = None,
         model: Type[B] | None = None,
         openapi_extra: dict[str, Any] | None = None,
+        name: str | None = None,
+        summary: str | None = None,
+        description: str | None = None,
     ):
         return _get_method_wrapper(
             cls=self,
@@ -92,6 +98,9 @@ class Endpoint:
             path=path,
             model=model,
             openapi_extra=openapi_extra,
+            name=name,
+            summary=summary,
+            description=description,
         )
 
     def post(
@@ -102,6 +111,9 @@ class Endpoint:
         path: str | None = None,
         model: Type[B] | None = None,
         openapi_extra: dict[str, Any] | None = None,
+        name: str | None = None,
+        summary: str | None = None,
+        description: str | None = None,
     ):
         return _get_method_wrapper(
             cls=self,
@@ -111,6 +123,9 @@ class Endpoint:
             path=path,
             model=model,
             openapi_extra=openapi_extra,
+            name=name,
+            summary=summary,
+            description=description,
         )
 
     def put(
@@ -120,6 +135,9 @@ class Endpoint:
         path: str | None = None,
         model: Type[B] | None = None,
         openapi_extra: dict[str, Any] | None = None,
+        name: str | None = None,
+        summary: str | None = None,
+        description: str | None = None,
     ):
         return _get_method_wrapper(
             cls=self,
@@ -129,6 +147,9 @@ class Endpoint:
             path=path,
             model=model,
             openapi_extra=openapi_extra,
+            name=name,
+            summary=summary,
+            description=description,
         )
 
     def delete(
@@ -138,6 +159,9 @@ class Endpoint:
         path: str | None = None,
         model: Type[B] | None = None,
         openapi_extra: dict[str, Any] | None = None,
+        name: str | None = None,
+        summary: str | None = None,
+        description: str | None = None,
     ):
         return _get_method_wrapper(
             cls=self,
@@ -147,6 +171,9 @@ class Endpoint:
             path=path,
             model=model,
             openapi_extra=openapi_extra,
+            name=name,
+            summary=summary,
+            description=description,
         )
 
     def patch(
@@ -156,6 +183,9 @@ class Endpoint:
         path: str | None = None,
         model: Type[B] | None = None,
         openapi_extra: dict[str, Any] | None = None,
+        name: str | None = None,
+        summary: str | None = None,
+        description: str | None = None,
     ):
         return _get_method_wrapper(
             cls=self,
@@ -165,6 +195,9 @@ class Endpoint:
             path=path,
             model=model,
             openapi_extra=openapi_extra,
+            name=name,
+            summary=summary,
+            description=description,
         )
 
 
@@ -177,6 +210,9 @@ def _get_method_wrapper(
     path: str | None = None,
     model: Type[B] | None = None,
     openapi_extra: dict[str, Any] | None = None,
+    name: str | None = None,
+    summary: str | None = None,
+    description: str | None = None,
 ):
     def _set_method_wrapper(func: EnpointFn):
         if model is not None:
@@ -193,6 +229,9 @@ def _get_method_wrapper(
             "path": path,
             "response_model": model,
             "openapi_extra": _openapi_extra,
+            "name": name,
+            "summary": summary,
+            "description": description,
         }
         cls._methods[method] = _meta
 
@@ -223,6 +262,9 @@ def add_endpoint(
         _dependencies = _meta["dependencies"]
         _path = _meta["path"]
         _response_model = _meta["response_model"]
+        _name = _meta.get("name")
+        _summary = _meta.get("summary")
+        _description = _meta.get("description")
         if not _response_model:
             try:
                 _response_model = _get_return_type(_fn)
@@ -231,15 +273,21 @@ def add_endpoint(
 
         full_path = path if not _path else f"{path}/{_path}"
 
-        if not getdoc(_fn):
+        description = getdoc(_fn)
+        if not description:
             warnings.warn(f"Docstring is missing for {_method} {path}")
+        else:
+            _name = _name if _name else get_first_line(description)
+            _summary = _summary if _summary else get_first_line(description)
 
         # Todo: add warning name is not None
         router.add_api_route(
             full_path,
             _fn,
             methods=[_method],
-            name=getdoc(_fn),
+            name=_name,
+            summary=_summary,
+            description=description,
             response_model=_response_model,
             status_code=_status_code,
             dependencies=[*(_dependencies or []), *(dependencies or [])],

{tracktolib-0.47.0 → tracktolib-0.47.2}/tracktolib/pg/utils.py

@@ -13,7 +13,7 @@ try:
     import asyncpg
     from rich.progress import Progress
 except ImportError:
-    raise ImportError('Please install tracktolib with "pg" to use this module')
+    raise ImportError('Please install asyncpg, rich or tracktolib with "pg" to use this module')
 
 from asyncpg.exceptions import (
     CheckViolationError,

{tracktolib-0.47.0 → tracktolib-0.47.2}/tracktolib/pg_sync.py

@@ -126,9 +126,12 @@ def insert_csv(
     exclude_columns: Iterable[str] | None = None,
     delimiter: LiteralString = ",",
     block_size: int = 1000,
+    on_conflict: LiteralString = "ON CONFLICT DO NOTHING",
 ):
-    _tmp_table, _tmp_query, _insert_query = get_tmp_table_query(schema, table)
-    _columns = csv_path.open().readline()
+    _columns = cast(LiteralString, csv_path.open().readline())
+    _tmp_table, _tmp_query, _insert_query = get_tmp_table_query(
+        schema, table, columns=_columns.split(","), on_conflict=on_conflict
+    )
     _query: Query = query or cast(
         LiteralString,
         f"""

{tracktolib-0.47.0 → tracktolib-0.47.2}/tracktolib/utils.py

@@ -184,3 +184,8 @@ def deep_reload(m: ModuleType):
     sub_mods = [_mod for _mod in sys.modules if _mod == m.__name__ or _mod.startswith(f"{m.__name__}.")]
     for pkg in sorted(sub_mods, key=lambda item: item.count("."), reverse=True):
         importlib.reload(sys.modules[pkg])
+
+
+def get_first_line(lines: str) -> str:
+    _lines = lines.split("\n")
+    return _lines[0] if _lines else lines