plexus-python-common 1.0.8__tar.gz → 1.0.10__tar.gz

{plexus_python_common-1.0.8 → plexus_python_common-1.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plexus-python-common
-Version: 1.0.8
+Version: 1.0.10
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{plexus_python_common-1.0.8 → plexus_python_common-1.0.10}/src/plexus/common/utils/ormutils.py

@@ -1,5 +1,5 @@
 import datetime
-from typing import Self, TypeVar
+from typing import Protocol, Self, TypeVar
 
 import pydantic as pdt
 import sqlalchemy as sa
@@ -127,7 +127,11 @@ def make_base_model() -> type[SQLModel]:
     return BaseModel
 
 
-def make_serial_model_mixin() -> type[SQLModel]:
+class SerialModelMixinProto(Protocol):
+    sid: int | None
+
+
+def make_serial_model_mixin() -> type[SerialModelMixinProto]:
     """
     Creates a mixin class for SQLModel models that adds a unique identifier field `sid`.
     Use this mixin to add an auto-incremented primary key to your models.
@@ -143,7 +147,16 @@ def make_serial_model_mixin() -> type[SQLModel]:
     return ModelMixin
 
 
-def make_record_model_mixin() -> type[SQLModel]:
+class RecordModelMixinProto(Protocol):
+    sid: int | None
+    created_at: datetime.datetime | None
+    updated_at: datetime.datetime | None
+
+    @classmethod
+    def make_index_created_at(cls, index_name: str) -> sa.Index: ...
+
+
+def make_record_model_mixin() -> type[RecordModelMixinProto]:
     """
     Creates a mixin class for SQLModel models that adds common fields and validation logic for updatable records.
     This mixin includes `sid`, `created_at`, and `updated_at` fields, along with validation for timestamps.
@@ -188,7 +201,7 @@ def make_record_model_mixin() -> type[SQLModel]:
             return m
 
         @classmethod
-        def make_created_at_index(cls, index_name: str) -> sa.Index:
+        def make_index_created_at(cls, index_name: str) -> sa.Index:
             """
             Helper to create an index on the `created_at` field with the given index name.
             """
@@ -197,7 +210,23 @@ def make_record_model_mixin() -> type[SQLModel]:
     return ModelMixin
 
 
-def make_snapshot_model_mixin() -> type[SQLModel]:
+class SnapshotModelMixinProto(Protocol):
+    sid: int | None
+    created_at: datetime.datetime | None
+    expired_at: datetime.datetime | None
+    record_sid: int | None
+
+    @classmethod
+    def make_index_created_at_expired_at(cls, index_name: str) -> sa.Index: ...
+
+    @classmethod
+    def make_active_unique_index_record_sid(cls, index_name: str) -> sa.Index: ...
+
+    @classmethod
+    def make_active_unique_index_for(cls, index_name: str, *fields: str) -> sa.Index: ...
+
+
+def make_snapshot_model_mixin() -> type[SnapshotModelMixinProto]:
     """
     Provides a mixin class for SQLModel models that adds common fields and validation logic for record snapshots.
     A snapshot model tracks the full change history of an entity: when any field changes, the current record (with a
@@ -255,9 +284,36 @@ def make_snapshot_model_mixin() -> type[SQLModel]:
             return m
 
         @classmethod
-        def make_created_at_expired_at_index(cls, index_name: str) -> sa.Index:
+        def make_index_created_at_expired_at(cls, index_name: str) -> sa.Index:
             return sa.Index(index_name, "created_at", "expired_at")
 
+        @classmethod
+        def make_active_unique_index_record_sid(cls, index_name: str) -> sa.Index:
+            """
+            Helper to create a unique index on the `record_sid` field for active records (where `expired_at` is NULL).
+            This ensures that there is only one active snapshot per record at any given time.
+            """
+            return sa.Index(
+                index_name,
+                "record_sid",
+                unique=True,
+                postgresql_where=sa.text('"expired_at" IS NULL'),
+            )
+
+        @classmethod
+        def make_active_unique_index_for(cls, index_name: str, *fields: str) -> sa.Index:
+            """
+            Helper to create a unique index on the specified fields for active records (where `expired_at` is NULL).
+            This ensures that there is only one active snapshot per combination of the specified fields at any given
+            time.
+            """
+            return sa.Index(
+                index_name,
+                *fields,
+                unique=True,
+                postgresql_where=sa.text('"expired_at" IS NULL'),
+            )
+
     return ModelMixin
 
 

{plexus_python_common-1.0.8 → plexus_python_common-1.0.10}/src/plexus/common/utils/strutils.py

@@ -16,12 +16,14 @@ __all__ = [
     "kebab_case_parser",
     "dot_case_pattern",
     "dot_case_parser",
+    "uuid_pattern",
+    "uuid_parser",
     "strict_relpath_pattern",
     "strict_relpath_parser",
     "strict_abspath_pattern",
     "strict_abspath_parser",
-    "uuid_pattern",
-    "uuid_parser",
+    "semver_pattern",
+    "semver_parser",
     "tag_pattern",
     "tag_parser",
     "topic_pattern",
@@ -138,6 +140,12 @@ strict_relpath_element: pp.ParserElement = pp.Combine(
 strict_abspath_element: pp.ParserElement = pp.Combine(
     slash_token + (strict_path_chars_element + slash_token)[...] + strict_path_chars_element[0, 1])
 
+semver_regexp: re.Pattern[str] = re.compile(
+    rf"({number_regexp.pattern})\.({number_regexp.pattern})\.({number_regexp.pattern})"
+    rf"(?:-{alpha_digits_regexp.pattern}(?:\.{alpha_digits_regexp.pattern})*)?"
+    rf"(?:\+{alpha_digits_regexp.pattern}(?:\.{alpha_digits_regexp.pattern})*)?")
+semver_element: pp.ParserElement = pp.Regex(semver_regexp.pattern)
+
 tag_regexp: re.Pattern[str] = re.compile(rf"{snake_case_regexp.pattern}(?:::{snake_case_regexp.pattern})*")
 tag_element: pp.ParserElement = pp.Combine(snake_case_element + (colon_token + colon_token + snake_case_element)[...])
 
@@ -167,6 +175,9 @@ strict_relpath_parser = make_string_parser(strict_relpath_element)
 strict_abspath_pattern = make_string_pattern(strict_abspath_regexp)
 strict_abspath_parser = make_string_parser(strict_abspath_element)
 
+semver_pattern = make_string_pattern(semver_regexp)
+semver_parser = make_string_parser(semver_element)
+
 tag_pattern = make_string_pattern(tag_regexp)
 tag_parser = make_string_parser(tag_element)
 topic_pattern = make_string_pattern(topic_regexp)

{plexus_python_common-1.0.8 → plexus_python_common-1.0.10}/src/plexus_python_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plexus-python-common
-Version: 1.0.8
+Version: 1.0.10
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{plexus_python_common-1.0.8 → plexus_python_common-1.0.10}/test/plexus_tests/common/utils/ormutils_test.py

@@ -8,6 +8,7 @@ from iker.common.utils.randutils import randomizer
 from sqlmodel import Field
 
 from plexus.common.utils.ormutils import make_base_model, make_snapshot_model_mixin, make_snapshot_model_trigger
+from plexus.common.utils.ormutils import snapshot_model_mixin
 
 fixture_postgresql_test_proc = pytest_postgresql.factories.postgresql_proc(host="localhost", user="postgres")
 fixture_postgresql_test = pytest_postgresql.factories.postgresql("fixture_postgresql_test_proc", dbname="test")
@@ -23,6 +24,11 @@ class DummyModel(make_base_model(), make_snapshot_model_mixin(), table=True):
     dummy_array: list[str] = Field(sa_column=sa.Column(sa_pg.ARRAY(sa_pg.VARCHAR(64))))
     dummy_json: JsonType = Field(sa_column=sa.Column(sa_pg.JSONB))
 
+    __table_args__ = (
+        snapshot_model_mixin.make_index_created_at_expired_at("ix_dummy_model_created_at_expired_at"),
+        snapshot_model_mixin.make_active_unique_index_record_sid("aux_dummy_model_record_sid"),
+    )
+
 
 def test_make_snapshot_model_trigger(fixture_postgresql_test_proc, fixture_postgresql_test):
     scheme = make_scheme(Dialects.postgresql, Drivers.psycopg)

{plexus_python_common-1.0.8 → plexus_python_common-1.0.10}/test/plexus_tests/common/utils/strutils_test.py

@@ -9,6 +9,7 @@ from plexus.common.utils.strutils import dot_case_parser, dot_case_pattern
 from plexus.common.utils.strutils import hex_string_parser, hex_string_pattern
 from plexus.common.utils.strutils import kebab_case_parser, kebab_case_pattern
 from plexus.common.utils.strutils import parse_bag_name, parse_user_name, parse_vehicle_name
+from plexus.common.utils.strutils import semver_parser, semver_pattern
 from plexus.common.utils.strutils import snake_case_parser, snake_case_pattern
 from plexus.common.utils.strutils import strict_abspath_parser, strict_abspath_pattern
 from plexus.common.utils.strutils import strict_relpath_parser, strict_relpath_pattern
@@ -376,6 +377,44 @@ class StrUtilsTest(unittest.TestCase):
         with self.assertRaises(pp.ParseException):
             strict_abspath_parser.parse_string(data, parse_all=True)
 
+    data_semver_pattern = [
+        ("0.0.0",),
+        ("1.2.3",),
+        ("10.20.30",),
+        ("0.1.0-alpha",),
+        ("1.0.0+build.1",),
+        ("1.0.0-alpha+build.1",),
+        ("1.0.0-0.3.7",),
+        ("1.0.0-x.7.z.92",),
+    ]
+
+    @ddt.idata(data_semver_pattern)
+    @ddt.unpack
+    def test_semver_pattern(self, data):
+        self.assertIsNotNone(semver_pattern.match(data))
+        self.assertIsNotNone(semver_parser.parse_string(data, parse_all=True))
+
+    data_semver_pattern__bad_cases = [
+        ("",),
+        ("dummy",),
+        ("1",),
+        ("1.0",),
+        ("01.0.0",),
+        ("0.01.0",),
+        ("0.0.01",),
+        ("1.0.0-",),
+        ("1.0.0+",),
+        ("1.0.0-alpha+",),
+        ("1.0.0-alpha+beta-",),
+    ]
+
+    @ddt.idata(data_semver_pattern__bad_cases)
+    @ddt.unpack
+    def test_semver_pattern__bad_cases(self, data):
+        self.assertIsNone(semver_pattern.match(data))
+        with self.assertRaises(pp.ParseException):
+            semver_parser.parse_string(data, parse_all=True)
+
     data_tag_pattern = [
         ("dummy",),
         ("dummy::dummy",),