plexus-python-common 1.0.23__tar.gz → 1.0.25__tar.gz

{plexus_python_common-1.0.23 → plexus_python_common-1.0.25}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: plexus-python-common
-Version: 1.0.23
+Version: 1.0.25
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: <3.15,>=3.12
 Requires-Dist: boto3>=1.41
+Requires-Dist: boto3-stubs>=1.41
 Requires-Dist: cloudpathlib>=0.21
 Requires-Dist: lxml>=6.0
 Requires-Dist: numpy>=2.3
@@ -16,12 +17,15 @@ Requires-Dist: pyparsing>=3.2
 Requires-Dist: pyproj>=3.6
 Requires-Dist: pyquaternion>=0.9
 Requires-Dist: sqlalchemy>=2.0
-Requires-Dist: sqlmodel
 Requires-Dist: rich>=13.9
+Requires-Dist: textcase>=0.4
 Requires-Dist: ujson>=5.9
 Requires-Dist: iker-python-common[all]>=1.0
 Provides-Extra: all
-Requires-Dist: plexus-python-common; extra == "all"
+Requires-Dist: plexus-python-common[api]; extra == "all"
+Provides-Extra: api
+Requires-Dist: fastapi>=0.119.0; extra == "api"
+Requires-Dist: sqlmodel>=0.0.25; extra == "api"
 Provides-Extra: test
 Requires-Dist: ddt>=1.7; extra == "test"
 Requires-Dist: moto[all,ec2,s3]>=5.1; extra == "test"

{plexus_python_common-1.0.23 → plexus_python_common-1.0.25}/pyproject.toml

@@ -9,6 +9,7 @@ build-backend = "setuptools.build_meta"
 [dependency-groups]
 dev = [
     "boto3>=1.41",
+    "boto3-stubs>=1.41",
     "cloudpathlib>=0.21",
     "lxml>=6.0",
     "numpy>=2.3",
@@ -18,11 +19,15 @@ dev = [
     "pyproj>=3.6",
     "pyquaternion>=0.9",
     "sqlalchemy>=2.0",
-    "sqlmodel",
     "rich>=13.9",
+    "textcase>=0.4",
     "ujson>=5.9",
     "iker-python-common[all]>=1.0",
 ]
+api = [
+    "fastapi>=0.119.0",
+    "sqlmodel>=0.0.25",
+]
 test = [
     "ddt>=1.7",
     "moto[ec2,s3,all]>=5.1",
@@ -44,6 +49,7 @@ classifiers = [
 ]
 dependencies = [
     "boto3>=1.41",
+    "boto3-stubs>=1.41",
     "cloudpathlib>=0.21",
     "lxml>=6.0",
     "numpy>=2.3",
@@ -53,15 +59,19 @@ dependencies = [
     "pyproj>=3.6",
     "pyquaternion>=0.9",
     "sqlalchemy>=2.0",
-    "sqlmodel",
     "rich>=13.9",
+    "textcase>=0.4",
     "ujson>=5.9",
     "iker-python-common[all]>=1.0",
 ]
 
 [project.optional-dependencies]
 all = [
-    "plexus-python-common",
+    "plexus-python-common[api]",
+]
+api = [
+    "fastapi>=0.119.0",
+    "sqlmodel>=0.0.25",
 ]
 test = [
     "ddt>=1.7",

plexus_python_common-1.0.25/src/plexus/common/utils/apiutils.py

@@ -0,0 +1,31 @@
+from contextlib import AbstractContextManager
+
+import sqlalchemy.orm as sa_orm
+from fastapi import HTTPException
+
+__all__ = [
+    "managed_db_session",
+]
+
+
+class DBSessionExceptionManager(AbstractContextManager):
+    def __init__(self, db: sa_orm.Session, commit_on_exit: bool):
+        self.db = db
+        self.commit_on_exit = commit_on_exit
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        if isinstance(exc_type, HTTPException):
+            return False  # Propagate HTTPException
+        if exc_type is not None:
+            self.db.rollback()  # Raise a new HTTPException (or any other exception type)
+            raise HTTPException(status_code=500, detail=str(exc_value)) from exc_value
+        if self.commit_on_exit:
+            self.db.commit()
+        return True
+
+
+def managed_db_session(db: sa_orm.Session, commit_on_exit: bool = True) -> DBSessionExceptionManager:
+    return DBSessionExceptionManager(db, commit_on_exit)

{plexus_python_common-1.0.23 → plexus_python_common-1.0.25}/src/plexus/common/utils/s3utils.py

@@ -7,6 +7,7 @@ import mimetypes
 import os
 import os.path
 import tempfile
+import typing
 from collections.abc import Callable, Generator
 from pathlib import Path
 from typing import Literal
@@ -34,20 +35,29 @@ __all__ = [
 ]
 
 
-@dataclasses.dataclass
+@dataclasses.dataclass(frozen=True, eq=True)
 class S3ObjectMeta(object):
     key: str
     last_modified: datetime.datetime
     size: int
 
 
+if typing.TYPE_CHECKING:
+    def s3_make_client(
+        access_key_id: str = None,
+        secret_access_key: str = None,
+        region_name: str = None,
+        endpoint_url: str = None,
+    ) -> contextlib.AbstractContextManager[S3Client]: ...
+
+
 @contextlib.contextmanager
 def s3_make_client(
     access_key_id: str = None,
     secret_access_key: str = None,
     region_name: str = None,
     endpoint_url: str = None,
-) -> Generator[S3Client]:
+) -> Generator[S3Client, None, None]:
     """
     Creates an S3 client as a context manager for safe resource handling.
 
@@ -60,7 +70,12 @@ def s3_make_client(
     session = boto3.Session(aws_access_key_id=trim_to_none(access_key_id),
                             aws_secret_access_key=trim_to_none(secret_access_key),
                             region_name=trim_to_none(region_name))
-    yield S3Client(boto3_session=session, endpoint_url=trim_to_none(endpoint_url))
+    client = S3Client(boto3_session=session, endpoint_url=trim_to_none(endpoint_url))
+    try:
+        yield client
+    finally:
+        if hasattr(client, "close"):
+            client.close()
 
 
 def s3_list_objects(client: S3Client, bucket: str, prefix: str, limit: int = None) -> Generator[S3ObjectMeta]:
@@ -386,6 +401,15 @@ def s3_make_progress_callback(
     return progress_callback
 
 
+if typing.TYPE_CHECKING:
+    def s3_make_progressed_client(
+        access_key_id: str = None,
+        secret_access_key: str = None,
+        region_name: str = None,
+        endpoint_url: str = None,
+    ) -> contextlib.AbstractContextManager[S3Client]: ...
+
+
 @contextlib.contextmanager
 def s3_make_progressed_client(
     access_key_id: str = None,

plexus_python_common-1.0.25/src/plexus/common/utils/sqlutils.py

@@ -0,0 +1,9 @@
+__all__ = [
+    "escape_sql_like",
+]
+
+
+def escape_sql_like(s: str | None) -> str:
+    if s is None:
+        raise ValueError("input string cannot be None")
+    return s.replace("\\", "\\\\").replace("%", "\\%").replace("_", "\\_")

plexus_python_common-1.0.25/src/plexus/common/utils/testutils.py

@@ -0,0 +1,49 @@
+import uuid as py_uuid
+
+import textcase
+from iker.common.utils.jsonutils import JsonType
+from iker.common.utils.jsonutils import json_difference, json_reformat
+
+from plexus.common.utils.datautils import compute_vin_code_check_digit
+
+__all__ = [
+    "generate_dummy_uuid_str",
+    "generate_dummy_uuid",
+    "generate_dummy_vin_code",
+    "case_insensitive_json_compare",
+]
+
+
+def generate_dummy_uuid_str(*nums: int) -> str:
+    if len(nums) > 8:
+        raise ValueError("a maximum of 8 integers can be provided")
+    if not all(0 <= num <= 0xFFFF for num in nums):
+        raise ValueError("all integers must be in the range 0 to 65535 (0xFFFF)")
+    i0, i1, i2, i3, i4, i5, i6, i7 = list(nums) + [0] * (8 - len(nums))
+    return f"{i0:04x}{i1:04x}-{i2:04x}-{i3:04x}-{i4:04x}-{i5:04x}{i6:04x}{i7:04x}"
+
+
+def generate_dummy_uuid(*nums: int) -> py_uuid.UUID:
+    return py_uuid.UUID(generate_dummy_uuid_str(*nums))
+
+
+def generate_dummy_vin_code(*nums: int) -> str:
+    if len(nums) > 4:
+        raise ValueError("a maximum of 4 integers can be provided")
+    if not all(0 <= num <= 9999 for num in nums):
+        raise ValueError("all integers must be in the range 0 to 9999")
+    i0, i1, i2, i3 = list(nums) + [0] * (4 - len(nums))
+    unchecked_vin_code = f"{i0:04d}{i1:04d}0{i2:04d}{i3:04d}"
+    check_digit = compute_vin_code_check_digit(unchecked_vin_code)
+    return unchecked_vin_code[:8] + check_digit + unchecked_vin_code[-8:]
+
+
+def case_insensitive_json_compare(a: JsonType, b: JsonType, *, print_diff_messages: bool = True) -> bool:
+    identical = True
+    for node_path, diff_message in json_difference(json_reformat(a, key_formatter=textcase.camel),
+                                                   json_reformat(b, key_formatter=textcase.camel),
+                                                   []):
+        if print_diff_messages:
+            print(node_path, diff_message)
+        identical = False
+    return identical

{plexus_python_common-1.0.23 → plexus_python_common-1.0.25}/src/plexus_python_common.egg-info/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: plexus-python-common
-Version: 1.0.23
+Version: 1.0.25
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: <3.15,>=3.12
 Requires-Dist: boto3>=1.41
+Requires-Dist: boto3-stubs>=1.41
 Requires-Dist: cloudpathlib>=0.21
 Requires-Dist: lxml>=6.0
 Requires-Dist: numpy>=2.3
@@ -16,12 +17,15 @@ Requires-Dist: pyparsing>=3.2
 Requires-Dist: pyproj>=3.6
 Requires-Dist: pyquaternion>=0.9
 Requires-Dist: sqlalchemy>=2.0
-Requires-Dist: sqlmodel
 Requires-Dist: rich>=13.9
+Requires-Dist: textcase>=0.4
 Requires-Dist: ujson>=5.9
 Requires-Dist: iker-python-common[all]>=1.0
 Provides-Extra: all
-Requires-Dist: plexus-python-common; extra == "all"
+Requires-Dist: plexus-python-common[api]; extra == "all"
+Provides-Extra: api
+Requires-Dist: fastapi>=0.119.0; extra == "api"
+Requires-Dist: sqlmodel>=0.0.25; extra == "api"
 Provides-Extra: test
 Requires-Dist: ddt>=1.7; extra == "test"
 Requires-Dist: moto[all,ec2,s3]>=5.1; extra == "test"

{plexus_python_common-1.0.23 → plexus_python_common-1.0.25}/src/plexus_python_common.egg-info/SOURCES.txt

@@ -46,13 +46,16 @@ src/plexus/common/carto/OSMTags.py
 src/plexus/common/carto/OSMWay.py
 src/plexus/common/carto/__init__.py
 src/plexus/common/utils/__init__.py
+src/plexus/common/utils/apiutils.py
 src/plexus/common/utils/bagutils.py
 src/plexus/common/utils/datautils.py
 src/plexus/common/utils/jsonutils.py
 src/plexus/common/utils/ormutils.py
 src/plexus/common/utils/s3utils.py
 src/plexus/common/utils/shutils.py
+src/plexus/common/utils/sqlutils.py
 src/plexus/common/utils/strutils.py
+src/plexus/common/utils/testutils.py
 src/plexus_python_common.egg-info/PKG-INFO
 src/plexus_python_common.egg-info/SOURCES.txt
 src/plexus_python_common.egg-info/dependency_links.txt
@@ -71,4 +74,5 @@ test/plexus_tests/common/utils/jsonutils_test.py
 test/plexus_tests/common/utils/ormutils_test.py
 test/plexus_tests/common/utils/s3utils_test.py
 test/plexus_tests/common/utils/shutils_test.py
-test/plexus_tests/common/utils/strutils_test.py
+test/plexus_tests/common/utils/strutils_test.py
+test/plexus_tests/common/utils/testutils_test.py

{plexus_python_common-1.0.23 → plexus_python_common-1.0.25}/src/plexus_python_common.egg-info/requires.txt

@@ -1,4 +1,5 @@
 boto3>=1.41
+boto3-stubs>=1.41
 cloudpathlib>=0.21
 lxml>=6.0
 numpy>=2.3
@@ -8,13 +9,17 @@ pyparsing>=3.2
 pyproj>=3.6
 pyquaternion>=0.9
 sqlalchemy>=2.0
-sqlmodel
 rich>=13.9
+textcase>=0.4
 ujson>=5.9
 iker-python-common[all]>=1.0
 
 [all]
-plexus-python-common
+plexus-python-common[api]
+
+[api]
+fastapi>=0.119.0
+sqlmodel>=0.0.25
 
 [test]
 ddt>=1.7

{plexus_python_common-1.0.23 → plexus_python_common-1.0.25}/test/plexus_tests/common/utils/ormutils_test.py

@@ -12,6 +12,7 @@ from iker.common.utils.jsonutils import JsonType
 from iker.common.utils.randutils import randomizer
 from sqlmodel import Field, SQLModel
 
+from plexus.common.utils.apiutils import managed_db_session
 from plexus.common.utils.ormutils import (
     db_activate_revision_model,
     db_activate_snapshot_model,
@@ -954,7 +955,7 @@ def test_make_snapshot_model_trigger(fixture_postgresql_test_proc, fixture_postg
                 dummy_json=rng.random_json_object(5),
             )
 
-    with maker.make_session() as session:
+    with maker.make_session() as session, managed_db_session(session):
         session.execute(sa.sql.text("SET TIMEZONE TO 'UTC'"))
         session.commit()
 
@@ -1040,7 +1041,7 @@ def test_make_revision_model_trigger(fixture_postgresql_test_proc, fixture_postg
                 dummy_json=rng.random_json_object(5),
             )
 
-    with maker.make_session() as session:
+    with maker.make_session() as session, managed_db_session(session):
         session.execute(sa.sql.text("SET TIMEZONE TO 'UTC'"))
         session.commit()
 

plexus_python_common-1.0.25/test/plexus_tests/common/utils/testutils_test.py

@@ -0,0 +1,50 @@
+import unittest
+
+import ddt
+
+from plexus.common.utils.testutils import generate_dummy_uuid_str, generate_dummy_vin_code
+
+
+@ddt.ddt
+class TestUtilsTest(unittest.TestCase):
+    data_generate_dummy_uuid_str = [
+        ((), "00000000-0000-0000-0000-000000000000"),
+        ((0,), "00000000-0000-0000-0000-000000000000"),
+        ((0, 0,), "00000000-0000-0000-0000-000000000000"),
+        ((0, 0, 0, 0, 0, 0, 0, 0,), "00000000-0000-0000-0000-000000000000"),
+        ((1,), "00010000-0000-0000-0000-000000000000"),
+        ((1, 2, 3, 4, 5, 6, 7, 8,), "00010002-0003-0004-0005-000600070008"),
+        ((0x1, 0x10, 0x100, 0x1000, 0xF, 0xFF, 0xFFF, 0xFFFF,), "00010010-0100-1000-000f-00ff0fffffff"),
+    ]
+
+    @ddt.idata(data_generate_dummy_uuid_str)
+    @ddt.unpack
+    def test_generate_dummy_uuid_str(self, nums, expect):
+        self.assertEqual(generate_dummy_uuid_str(*nums), expect)
+
+    data_generate_dummy_uuid_str__bad_case = [
+        ((0, 0, 0, 0, 0, 0, 0, 0, 0,),),
+        ((-1,),),
+        ((0x10000,),),
+    ]
+
+    @ddt.idata(data_generate_dummy_uuid_str__bad_case)
+    @ddt.unpack
+    def test_generate_dummy_uuid_str__bad_case(self, nums):
+        with self.assertRaises(ValueError):
+            generate_dummy_uuid_str(*nums)
+
+    data_generate_dummy_vin_code = [
+        ((), "00000000000000000"),
+        ((0,), "00000000000000000"),
+        ((0, 0,), "00000000000000000"),
+        ((0, 0, 0, 0,), "00000000000000000"),
+        ((1,), "00010000500000000"),
+        ((1, 2, 3, 4,), "00010002700030004"),
+        ((1, 23, 456, 7890,), "00010023504567890"),
+    ]
+
+    @ddt.idata(data_generate_dummy_vin_code)
+    @ddt.unpack
+    def test_generate_dummy_vin_code(self, nums, expect):
+        self.assertEqual(generate_dummy_vin_code(*nums), expect)