ul-api-utils 9.0.0a1__tar.gz → 9.0.0a3__tar.gz

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/PKG-INFO

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

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/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.0a1',
+    version='9.0.0a3',
     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.0a1",        # 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.0a1 → ul-api-utils-9.0.0a3}/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.0a1 → ul-api-utils-9.0.0a3}/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.0a1 → ul-api-utils-9.0.0a3}/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.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils/api_resource/db_types.py

@@ -2,7 +2,7 @@ from typing import Union, Dict, Any, Tuple, Optional, Iterable
 
 from pydantic import BaseModel
 from ul_db_utils.model.base_model import BaseModel as DbBaseModel
-from flask_sqlalchemy import Model
+from flask_sqlalchemy.model import Model
 
 # TODO: remove DbBaseModel/Model from it BECAUSE IT loads sqlalchemy (>20mb of code)
 TDictable = Union[Dict[str, Any], BaseModel, Tuple[Any, ...], DbBaseModel, Model]

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils/debug/stat.py

@@ -6,7 +6,7 @@ from datetime import datetime
 from enum import Enum, unique
 from typing import List, Optional, NamedTuple, Dict, Any, Generator, Tuple
 
-from flask import _app_ctx_stack
+from flask import g
 
 from ul_api_utils.conf import APPLICATION_DEBUGGER_PIN
 from ul_api_utils.const import REQUEST_HEADER__DEBUGGER
@@ -22,23 +22,23 @@ def time_now() -> float:
 
 
 def mark_request_started() -> None:
-    _app_ctx_stack.top.debug_api_utils_request_started_at = time_now()  # type: ignore
+    g.debug_api_utils_request_started_at = time_now()  # type: ignore
 
 
 def get_request_started_at() -> float:
-    return getattr(_app_ctx_stack.top, 'debug_api_utils_request_started_at', 0.)
+    return getattr(g, 'debug_api_utils_request_started_at', 0.)
 
 
 def add_request_stat(stat: 'ApiUtilCallStat') -> None:
     try:
-        stats = _app_ctx_stack.top.debug_api_utils_request_stat  # type: ignore
+        stats = g.debug_api_utils_request_stat  # type: ignore
     except AttributeError:
-        stats = _app_ctx_stack.top.debug_api_utils_request_stat = []  # type: ignore
+        stats = g.debug_api_utils_request_stat = []  # type: ignore
     stats.append(stat)
 
 
 def get_request_stat() -> List['ApiUtilCallStat']:
-    return getattr(_app_ctx_stack.top, 'debug_api_utils_request_stat', [])
+    return getattr(g, 'debug_api_utils_request_stat', [])
 
 
 @unique
@@ -151,11 +151,11 @@ class ApiUtilCallStat(NamedTuple):
 
 
 def collecting_enabled() -> bool:
-    return getattr(_app_ctx_stack.top, 'debug_api_utils_collect_stat', False)
+    return getattr(g, 'debug_api_utils_collect_stat', False)
 
 
 def collecting_enable(enabled: bool) -> None:
-    _app_ctx_stack.top.debug_api_utils_collect_stat = enabled  # type: ignore
+    g.debug_api_utils_collect_stat = enabled  # type: ignore
 
 
 def get_stats_request_headers() -> Dict[str, str]:
@@ -204,9 +204,9 @@ def get_stat(*, started_at: float, ended_at: float, code_spans: bool = True, spa
 
     stats: List[ApiUtilCallStat] = list(get_request_stat())
 
-    from flask_sqlalchemy import get_debug_queries
+    from flask_sqlalchemy.record_queries import get_recorded_queries
 
-    for q in get_debug_queries():
+    for q in get_recorded_queries():
         ok = q.end_time is not None
 
         try:

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils/internal_api/internal_api.py

@@ -4,7 +4,7 @@ from json import dumps
 from typing import Optional, Dict, Any, Tuple, Callable
 
 import requests
-from flask import _app_ctx_stack
+from flask import g
 from werkzeug.datastructures import FileStorage
 
 from ul_api_utils.const import REQUEST_HEADER__INTERNAL, RESPONSE_HEADER__AUTHORIZATION, RESPONSE_HEADER__CONTENT_TYPE, INTERNAL_API__DEFAULT_PATH_PREFIX, REQUEST_HEADER__ACCEPT, \
@@ -23,13 +23,12 @@ from ul_api_utils.utils.json_encoder import CustomJSONEncoder
 
 def get_or_create_session(testing_mode: bool) -> requests.Session:
     if testing_mode:
-        if getattr(_app_ctx_stack, 'top', None) is None:
-            return requests.Session()
+        return requests.Session()
 
     try:
-        return _app_ctx_stack.top.internal_api_requests_session  # type: ignore
+        return g.internal_api_requests_session  # type: ignore
     except AttributeError:
-        s = _app_ctx_stack.top.internal_api_requests_session = requests.Session()  # type: ignore
+        s = g.internal_api_requests_session = requests.Session()  # type: ignore
         return s
 
 

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils/internal_api/internal_api_check_context.py

@@ -2,7 +2,7 @@ import contextlib
 from typing import Generator, Any, TYPE_CHECKING
 from uuid import UUID
 
-from flask import _app_ctx_stack
+from flask import g
 
 from ul_api_utils.errors import NotCheckedResponseInternalApiError
 
@@ -12,13 +12,13 @@ if TYPE_CHECKING:
 
 @contextlib.contextmanager
 def internal_api_check_context() -> Generator[None, None, None]:
-    _app_ctx_stack.top._api_utils_internal_api_context = []  # type: ignore
+    g._api_utils_internal_api_context = []  # type: ignore
 
     try:
         yield
 
         invalid_resp = []
-        for resp in _app_ctx_stack.top._api_utils_internal_api_context:  # type: ignore
+        for resp in g._api_utils_internal_api_context:  # type: ignore
             if not resp._internal_use__checked_once:
                 invalid_resp.append(resp)
 
@@ -28,15 +28,15 @@ def internal_api_check_context() -> Generator[None, None, None]:
                 f'internal api responses must be checked once at least :: [{info}]',
             )
     finally:
-        _app_ctx_stack.top._api_utils_internal_api_context.clear()  # type: ignore
+        g._api_utils_internal_api_context.clear()  # type: ignore
 
 
 def internal_api_check_context_add_response(resp: 'InternalApiResponse[Any]') -> None:
-    if hasattr(_app_ctx_stack, 'top') and hasattr(_app_ctx_stack.top, '_api_utils_internal_api_context'):
-        _app_ctx_stack.top._api_utils_internal_api_context.append(resp)  # type: ignore
+    if hasattr(g, '_api_utils_internal_api_context'):
+        g._api_utils_internal_api_context.append(resp)  # type: ignore
 
 
 def internal_api_check_context_rm_response(id: UUID) -> None:
-    if hasattr(_app_ctx_stack, 'top') and hasattr(_app_ctx_stack.top, '_api_utils_internal_api_context'):
-        prev = _app_ctx_stack.top._api_utils_internal_api_context  # type: ignore
-        _app_ctx_stack.top._api_utils_internal_api_context = [r for r in prev if r.id != id]  # type: ignore
+    if hasattr(g, '_api_utils_internal_api_context'):
+        prev = g._api_utils_internal_api_context  # type: ignore
+        g._api_utils_internal_api_context = [r for r in prev if r.id != id]  # type: ignore

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils/modules/api_sdk.py

@@ -8,7 +8,7 @@ from base64 import b64decode
 from datetime import datetime
 from functools import wraps
 from typing import List, Union, Callable, Tuple, Any, Optional, TypeVar, cast, Set, TYPE_CHECKING
-from flask import Response, request, Flask, url_for as flask_url_for, _app_ctx_stack
+from flask import Response, request, Flask, url_for as flask_url_for, g
 from pydantic import BaseModel
 from redis.connection import parse_url
 from ul_py_tool.utils.arg_files_glob import arg_files_print
@@ -63,15 +63,15 @@ logger = logging.getLogger(__name__)
 
 
 def add_files_to_clean(files: Set[str]) -> None:
-    if hasattr(_app_ctx_stack.top, '_api_utils_files_to_clean'):
+    if hasattr(g, '_api_utils_files_to_clean'):
         for f in files:
-            _app_ctx_stack.top._api_utils_files_to_clean.add(f)  # type: ignore
+            g._api_utils_files_to_clean.add(f)  # type: ignore
     else:
-        _app_ctx_stack.top._api_utils_files_to_clean = files  # type: ignore
+        g._api_utils_files_to_clean = files  # type: ignore
 
 
 def clean_files() -> None:
-    files: Set[str] = getattr(_app_ctx_stack.top, '_api_utils_files_to_clean', set())
+    files: Set[str] = getattr(g, '_api_utils_files_to_clean', set())
     for f in files:
         try:
             os.unlink(f)

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils/utils/cached_per_request.py

@@ -1,7 +1,7 @@
 import functools
 from typing import Callable, TypeVar, Any
 
-from flask import _app_ctx_stack
+from flask import g
 
 TFn = TypeVar("TFn", bound=Callable[..., Any])
 
@@ -13,11 +13,11 @@ def cached_per_request(key: str) -> Callable[[TFn], TFn]:
     def wrapper(fn: Callable[[...], Any]) -> Any:  # type: ignore
         @functools.wraps(fn)
         def wr(*args: Any, **kwargs: Any) -> Any:
-            cached_res = getattr(_app_ctx_stack.top, key, DEFAULT_OBJ)
+            cached_res = getattr(g, key, DEFAULT_OBJ)
             if cached_res is not DEFAULT_OBJ:
                 return cached_res
             res = fn(*args, **kwargs)
-            setattr(_app_ctx_stack.top, key, res)
+            setattr(g, key, res)
             return res
         return wr
     return wrapper

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils/utils/json_encoder.py

@@ -10,6 +10,13 @@ from uuid import UUID
 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 +33,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 +40,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,9 +78,7 @@ 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()
@@ -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):

{ul-api-utils-9.0.0a1 → ul-api-utils-9.0.0a3}/ul_api_utils.egg-info/PKG-INFO

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