plexus-python-common 1.0.56__tar.gz → 1.0.58__tar.gz

{plexus_python_common-1.0.56 → plexus_python_common-1.0.58}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plexus-python-common
-Version: 1.0.56
+Version: 1.0.58
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13

plexus_python_common-1.0.56/src/plexus/common/resources/tags/unittest.tagset.yaml → plexus_python_common-1.0.58/src/plexus/common/resources/tags/unittest-1.0.0.tagset.yaml

@@ -1,4 +1,5 @@
 $namespace: "unittest"
+$version: "1.0.0"
 # language=markdown
 $desc: !markdown |
   **Unit Test Tagset**

plexus_python_common-1.0.56/src/plexus/common/resources/tags/universal.tagset.yaml → plexus_python_common-1.0.58/src/plexus/common/resources/tags/universal-1.0.0.tagset.yaml

@@ -1,4 +1,5 @@
 $namespace: "universal"
+$version: "1.0.0"
 # language=markdown
 $desc: !markdown |
   **Universal Tagset**

{plexus_python_common-1.0.56 → plexus_python_common-1.0.58}/src/plexus/common/utils/bagutils.py

@@ -217,9 +217,9 @@ class BagWriter(AbstractContextManager, BagIOBase):
 
         :param bag_file_path: path to the SQLite DB file to create.
         :param overwrite: whether to overwrite the SQLite DB file if it already exists. If False and the file already
-        exists, a FileExistsError is raised. If True, the existing file is deleted and a new one is created.
+          exists, a FileExistsError is raised. If True, the existing file is deleted and a new one is created.
         :param exist_ok: whether to ignore if the SQLite DB file already exists. If False and the file already exists,
-        a FileExistsError is raised. If True, the existing file is used and no new file is created.
+          a FileExistsError is raised. If True, the existing file is used and no new file is created.
         """
         super().__init__(bag_file_path)
 

{plexus_python_common-1.0.56 → plexus_python_common-1.0.58}/src/plexus/common/utils/ormutils.py

@@ -267,6 +267,7 @@ class ChangingModelMixinProtocol(SequenceModelMixinProtocol):
     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.
+
         :param index_name: Name of the index to create.
         :return: The created SQLAlchemy Index object.
         """
@@ -282,6 +283,7 @@ class SnapshotModelMixinProtocol(SequenceModelMixinProtocol):
     def make_index_created_at_expired_at(cls, index_name: str) -> sa.Index:
         """
         Helper to create an index on the ``created_at`` and ``expired_at`` fields with the given index name.
+
         :param index_name: Name of the index to create.
         :return: The created SQLAlchemy Index object.
         """
@@ -292,6 +294,7 @@ class SnapshotModelMixinProtocol(SequenceModelMixinProtocol):
         """
         Helper to create a unique index on the ``record_sqn`` field for active records (where ``expired_at`` is NULL).
         This ensures that there is only one active snapshot per record at any given time.
+
         :param index_name: Name of the index to create.
         :return: The created SQLAlchemy Index object.
         """
@@ -302,6 +305,7 @@ class SnapshotModelMixinProtocol(SequenceModelMixinProtocol):
         """
         Helper to create a non-unique index on the specified fields for active records (where ``expired_at`` is NULL).
         This allows efficient querying of active snapshots based on the specified fields.
+
         :param index_name: Name of the index to create.
         :param fields: Fields to include in the index.
         :return: The created SQLAlchemy Index object.
@@ -314,6 +318,7 @@ class SnapshotModelMixinProtocol(SequenceModelMixinProtocol):
         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.
+
         :param index_name: Name of the index to create.
         :param fields: Fields to include in the unique index.
         :return: The created SQLAlchemy Index object.
@@ -333,6 +338,7 @@ class RevisionModelMixinProtocol(SequenceModelMixinProtocol):
         """
         Helper to create an index on the ``created_at``, ``updated_at``, and ``expired_at`` fields with the given
         index name.
+
         :param index_name: Name of the index to create.
         :return: The created SQLAlchemy Index object.
         """
@@ -343,6 +349,7 @@ class RevisionModelMixinProtocol(SequenceModelMixinProtocol):
         """
         Helper to create a unique index on the ``record_sqn`` and ``revision`` fields.
         This ensures that each revision number is unique per record.
+
         :param index_name: Name of the index to create.
         :return: The created SQLAlchemy Index object.
         """
@@ -353,6 +360,7 @@ class RevisionModelMixinProtocol(SequenceModelMixinProtocol):
         """
         Helper to create a unique index on the ``record_sqn`` field for active records (where ``expired_at`` is NULL).
         This ensures that there is only one active revision per record at any given time.
+
         :param index_name: Name of the index to create.
         :return: The created SQLAlchemy Index object.
         """
@@ -363,6 +371,7 @@ class RevisionModelMixinProtocol(SequenceModelMixinProtocol):
         """
         Helper to create a non-unique index on the specified fields for active records (where ``expired_at`` is NULL).
         This allows efficient querying of active revisions based on the specified fields.
+
         :param index_name: Name of the index to create.
         :param fields: Fields to include in the index.
         :return: The created SQLAlchemy Index object.
@@ -375,6 +384,7 @@ class RevisionModelMixinProtocol(SequenceModelMixinProtocol):
         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 revision per combination of the specified fields at any given
         time.
+
         :param index_name: Name of the index to create.
         :param fields: Fields to include in the unique index.
         :return: The created SQLAlchemy Index object.
@@ -465,7 +475,7 @@ def make_changing_model_mixin(dialect: str | None = None) -> type[ChangingModelM
 
     :param dialect: The database dialect to determine the column types for the fields.
     :return: A mixin class that can be used with SQLModel models to add the common fields and validation logic for
-    updatable records.
+             updatable records.
     """
 
     class ModelMixin(SQLModel):
@@ -527,7 +537,7 @@ def make_snapshot_model_mixin(dialect: str | None = None) -> type[SnapshotModelM
 
     :param dialect: The database dialect to determine the column types for the fields.
     :return: A mixin class that can be used with SQLModel models to add the common fields and validation logic for
-    record snapshots.
+             record snapshots.
     """
 
     class ModelMixin(SQLModel):
@@ -622,7 +632,7 @@ def make_revision_model_mixin(dialect: str | None = None) -> type[RevisionModelM
 
     :param dialect: The database dialect to determine the column types for the fields.
     :return: A mixin class that can be used with SQLModel models to add the common fields and validation logic for
-    record revisions.
+             record revisions.
     """
 
     class ModelMixin(SQLModel):

{plexus_python_common-1.0.56 → plexus_python_common-1.0.58}/src/plexus/common/utils/s3utils.py

@@ -549,15 +549,16 @@ def s3_archive_member_tree(
     Directory members are recognized by names ending with a trailing slash ("/").
 
     Example:
-    {
-      "dir1/": (ZipInfo, {
-          "file1.txt": (ZipInfo, None),
-          "subdir/": (ZipInfo, {
-              "file2.txt": (ZipInfo, None)
-          })
-      }),
-      "file3.txt": (ZipInfo, None)
-    }
+
+    >>> {
+    ...   "dir1/": (ZipInfo, {
+    ...       "file1.txt": (ZipInfo, None),
+    ...       "subdir/": (ZipInfo, {
+    ...           "file2.txt": (ZipInfo, None)
+    ...       })
+    ...   }),
+    ...   "file3.txt": (ZipInfo, None)
+    ... }
 
     :param client: An instance of ``S3Client``.
     :param bucket: Bucket name.
@@ -602,7 +603,9 @@ def s3_archive_list_files(
     under that directory will be included in the results.
 
     Example usage:
-    >>> archive_size, member_zip_infos, missed_members = s3_archive_list_files(client, bucket, key, members=["file1.txt", "dir1/"])
+
+    >>> archive_size, member_zip_infos, missed_members = s3_archive_list_files(
+    ...         client, bucket, key, members=["file1.txt", "dir1/"])
     >>> for info in member_zip_infos:
     ...     print(info.filename, info.file_size)
     >>> if missed_members: