ul-api-utils 9.0.0a2__tar.gz → 9.0.0a4__tar.gz

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 9.0.0a2
+Version: 9.0.0a4
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/setup.py

@@ -9,7 +9,7 @@ with open(path.join(HERE, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='ul-api-utils',
-    version='9.0.0a2',
+    version='9.0.0a4',
     description='Python api utils',
     author='Unic-lab',
     long_description=long_description,
@@ -87,7 +87,7 @@ setup(
         # "opentelemetry-instrumentation-requests==0.27b0",
         # "opentelemetry-exporter-jaeger==1.8.0",
         # "opentelemetry-instrumentation-sqlalchemy==0.27b0",
-        # "ul-db-utils==5.0.0a3",        # ACTUALIZE, BUT DO NOT UNCOMMENT PLEASE
+        # "ul-db-utils==5.0.0a5",        # ACTUALIZE, BUT DO NOT UNCOMMENT PLEASE
         # "ul-py-tool==2.1.3",        # ACTUALIZE, BUT DO NOT UNCOMMENT PLEASE
     ],
 )

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/ul_api_utils/api_resource/api_request.py

@@ -1,6 +1,7 @@
 import json
 from typing import NamedTuple, Iterable, Any, List, Tuple, Dict, Optional
 
+from flask_sqlalchemy.query import Query
 from pydantic import model_validator, BaseModel
 
 from ul_api_utils.errors import SimpleValidateApiError
@@ -14,11 +15,7 @@ class ApiRequestQueryPagination(NamedTuple):
     offset: int
     per_page: int
 
-    def mk_sqlalchemy_pagination(self, items: Iterable[Any], total: int, query: Any = None) -> 'ApiPagination':
-        if has_already_imported_db():
-            from flask_sqlalchemy import Pagination
-            return Pagination(total=total, query=query, per_page=self.per_page, page=self.page, items=items)  # type: ignore
-        assert query is None
+    def mk_item_pagination(self, items: Iterable[Any], total: int) -> ApiPagination:
         return ApiPagination(
             total=total,
             per_page=self.per_page,
@@ -26,6 +23,12 @@ class ApiRequestQueryPagination(NamedTuple):
             items=items,
         )
 
+    # TODO: Not sure that is worked. Check it if will be found usages
+    def mk_sqlalchemy_pagination(self, items: Iterable[Any], total: int, query: Query = None) -> 'ApiPagination':
+        if has_already_imported_db() and query:
+            return query.paginate(total=total, query=query, per_page=self.per_page, page=self.page, items=items)  # type: ignore
+        return self.mk_item_pagination(items, total)
+
 
 class ApiRequestQuerySortBy(NamedTuple):
     params: List[Tuple[str, str]]

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/ul_api_utils/api_resource/api_resource.py

@@ -293,13 +293,10 @@ class ApiResource:
         mimetype: Optional[str],  # it will be auto-detected by extension if mimetype==None
         as_attachment: bool = False,
         download_name: Optional[str] = None,
-        attachment_filename: Optional[str] = None,
         conditional: bool = True,
         etag: Union[bool, str] = True,
-        add_etags: Optional[bool] = None,
         last_modified: Optional[Union[datetime, int, float]] = None,
         max_age: Optional[Union[int, Callable[[Optional[str]], Optional[int]]]] = None,
-        cache_timeout: Optional[int] = None,
     ) -> FileApiResponse:
         ApiResourceType.FILE.validate(self._type)
         if isinstance(path_or_file, str) and not os.path.exists(path_or_file):
@@ -311,13 +308,10 @@ class ApiResource:
             mimetype=mimetype,
             as_attachment=as_attachment,
             download_name=download_name,
-            attachment_filename=attachment_filename,
             conditional=conditional,
             etag=etag,
-            add_etags=add_etags,
             last_modified=last_modified,
             max_age=max_age,
-            cache_timeout=cache_timeout,
         )
 
     def response_created_ok(self, payload: 'TPayloadInputUnion', total_count: Optional[int] = None) -> JsonApiResponse[Any]:

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/ul_api_utils/api_resource/api_response.py

@@ -93,13 +93,10 @@ class FileApiResponse(ApiResponse):
     mimetype: Optional[str] = None  # it will be auto-detected by extension if mimetype==None
     as_attachment: bool = False
     download_name: Optional[str] = None
-    attachment_filename: Optional[str] = None
     conditional: bool = True
     etag: Union[bool, str] = True
-    add_etags: Optional[bool] = None
     last_modified: Optional[Union[datetime, int, float]] = None
     max_age: Optional[Union[int, Callable[[Optional[str]], Optional[int]]]] = None
-    cache_timeout: Optional[int] = None
 
     @classmethod
     def _internal_use__mk_schema(cls, inner_type: Optional[Type[BaseModel]]) -> Type[BaseModel]:
@@ -113,13 +110,10 @@ class FileApiResponse(ApiResponse):
             mimetype=self.mimetype,
             as_attachment=self.as_attachment,
             download_name=self.download_name,
-            attachment_filename=self.attachment_filename,
             conditional=self.conditional,
             etag=self.etag,
-            add_etags=self.add_etags,
             last_modified=self.last_modified,
             max_age=self.max_age,
-            cache_timeout=self.cache_timeout,
         )
 
         resp.headers.update(self.headers)

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/ul_api_utils/modules/api_sdk.py

@@ -45,7 +45,7 @@ from ul_api_utils.utils.cached_per_request import cached_per_request
 from ul_api_utils.utils.constants import TKwargs
 from ul_api_utils.utils.jinja.t_url_for import t_url_for
 from ul_api_utils.utils.jinja.to_pretty_json import to_pretty_json
-from ul_api_utils.utils.json_encoder import CustomJSONEncoder, SocketIOJsonWrapper
+from ul_api_utils.utils.json_encoder import CustomJSONProvider, SocketIOJsonWrapper
 from ul_api_utils.utils.load_modules import load_modules_by_template
 from ul_api_utils.utils.uuid_converter import UUID4Converter
 
@@ -225,7 +225,7 @@ class ApiSdk:
         )
         self._flask_app_cache = flask_app
 
-        flask_app.json_encoder = CustomJSONEncoder  # type: ignore
+        flask_app.json = CustomJSONProvider(flask_app)  # type: ignore
 
         flask_app.url_map.converters['uuid'] = UUID4Converter
 

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/ul_api_utils/utils/json_encoder.py

@@ -7,9 +7,18 @@ from enum import Enum
 from json import JSONEncoder
 from typing import Dict, Any, Union, List, Optional, TYPE_CHECKING
 from uuid import UUID
+
+from flask.json.provider import DefaultJSONProvider
 from frozendict import frozendict
 from pydantic import BaseModel
 
+from flask_sqlalchemy.query import Query
+from flask_sqlalchemy.model import Model, DefaultMeta
+
+from sqlalchemy.orm import Query, registry
+
+from ul_db_utils.modules.postgres_modules.db import DbModel
+from ul_db_utils.model.base_model import BaseModel as DbBaseModel
 from ul_api_utils.utils.imports import has_already_imported_db
 
 if TYPE_CHECKING:
@@ -26,11 +35,6 @@ def to_dict(obj: 'TDictable') -> Optional[Dict[str, Any]]:
     if isinstance(obj, BaseModel):
         return obj.model_dump()
     if has_already_imported_db():
-        from ul_db_utils.modules.postgres_modules.db import DbModel
-        from flask_sqlalchemy import BaseQuery, Model
-        from sqlalchemy.orm import registry
-        from ul_db_utils.model.base_model import BaseModel as DbBaseModel
-
         if isinstance(obj, DbBaseModel) or isinstance(obj, DbModel):
             return obj.to_dict()
         if isinstance(obj, Model):
@@ -38,7 +42,7 @@ def to_dict(obj: 'TDictable') -> Optional[Dict[str, Any]]:
             for field in (x for x in dir(obj) if not x.startswith('_') and x != 'metadata'):
                 val = obj.__getattribute__(field)
                 # is this field method defination, or an SQLalchemy object
-                if not hasattr(val, "__call__") and not isinstance(val, BaseQuery):  # noqa: B004
+                if not hasattr(val, "__call__") and not isinstance(val, Query):  # noqa: B004
                     if isinstance(val, datetime):
                         val = str(val.isoformat())
                     if isinstance(val, UUID):
@@ -76,10 +80,6 @@ class CustomJSONEncoder(JSONEncoder):
             return str(obj.__html__())
 
         if has_already_imported_db():
-            from ul_db_utils.model.base_model import BaseModel as DbBaseModel
-            from flask_sqlalchemy import BaseQuery, Model, DefaultMeta
-            from sqlalchemy.orm import Query, registry
-
             if isinstance(obj, DbBaseModel):
                 return obj.to_dict()
             if isinstance(obj, Query) or isinstance(obj, DefaultMeta):
@@ -89,7 +89,7 @@ class CustomJSONEncoder(JSONEncoder):
                 for field in [x for x in dir(obj) if not x.startswith('_') and x != 'metadata']:
                     val = obj.__getattribute__(field)
                     # is this field method defination, or an SQLalchemy object
-                    if not hasattr(val, "__call__") and not isinstance(val, BaseQuery):  # noqa: B004
+                    if not hasattr(val, "__call__") and not isinstance(val, Query):  # noqa: B004
                         if isinstance(val, datetime):
                             val = str(val.isoformat())
                         if isinstance(val, UUID):
@@ -113,3 +113,12 @@ class SocketIOJsonWrapper:
     @staticmethod
     def loads(*args: Any, **kwargs: Any) -> Any:
         return json.loads(*args, **kwargs)
+
+
+class CustomJSONProvider(DefaultJSONProvider):
+    def __init__(self, app):
+        super().__init__(app)
+        self.encoder = CustomJSONEncoder()
+
+    def default(self, obj) -> Union[str, Dict[str, Any], List[Any], None]:
+        return self.encoder.default(obj)

{ul-api-utils-9.0.0a2 → ul-api-utils-9.0.0a4}/ul_api_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 9.0.0a2
+Version: 9.0.0a4
 Summary: Python api utils
 Author: Unic-lab
 Author-email: