fully support 6.X, fixed unit test

Author: MacHu-GWU

.coveragerc

@@ -6,7 +6,7 @@ omit =
     pynamodb_mate/docs/*
     pynamodb_mate/tests/*
     pynamodb_mate/vendor/*
-    pynamodb_mate/paths
+    pynamodb_mate/paths.py
 
 [report]
 # Regexes for lines to exclude from consideration

pynamodb_mate/_version.py

@@ -1,4 +1,4 @@
-__version__ = "5.5.1.1"
+__version__ = "6.0.0.1"
 
 if __name__ == "__main__":  # pragma: no cover
     print(__version__)

pynamodb_mate/attributes/encrypted.py

@@ -30,6 +30,7 @@ def __init__(
         default: T.Optional[T.Callable] = None,
         default_for_new: T.Optional[T.Callable] = None,
         attr_name: T.Optional[str] = None,
+        legacy_encoding: bool = False,
     ):
         super().__init__(
             hash_key=hash_key,
@@ -38,6 +39,7 @@ def __init__(
             default=default,
             default_for_new=default_for_new,
             attr_name=attr_name,
+            legacy_encoding=legacy_encoding,
         )
         self.encryption_key = encryption_key
         self.determinative = determinative

pynamodb_mate/models.py

@@ -11,7 +11,6 @@
 
 from pynamodb.models import Model as PynamodbModel
 from pynamodb.indexes import GlobalSecondaryIndex, LocalSecondaryIndex
-from pynamodb.settings import OperationSettings
 from pynamodb.exceptions import DeleteError
 from pynamodb.expressions.condition import Condition
 
@@ -132,7 +131,6 @@ def get_one_or_none(
         range_key: T.Optional[T.Any] = None,
         consistent_read: bool = False,
         attributes_to_get: T.Optional[T.Sequence[str]] = None,
-        settings: OperationSettings = OperationSettings.default,
     ) -> T.Optional["Model"]:
         """
         Get one Dynamodb item object or None if not exists.
@@ -145,7 +143,6 @@ def get_one_or_none(
                 range_key=range_key,
                 consistent_read=consistent_read,
                 attributes_to_get=attributes_to_get,
-                settings=settings,
             )
         except cls.DoesNotExist:
             return None
@@ -240,7 +237,6 @@ def iter_scan(
         index_name: T.Optional[str] = None,
         rate_limit: T.Optional[float] = None,
         attributes_to_get: T.Optional[T.Sequence[str]] = None,
-        settings: OperationSettings = OperationSettings.default,
     ) -> IterProxy[_T]:
         """
         Similar to the ``Model.scan()`` method, but it returns
@@ -260,7 +256,6 @@ def iter_scan(
                 index_name=index_name,
                 rate_limit=rate_limit,
                 attributes_to_get=attributes_to_get,
-                settings=settings,
             )
         )
 
@@ -278,7 +273,6 @@ def iter_query(
         attributes_to_get: T.Optional[T.Iterable[str]] = None,
         page_size: T.Optional[int] = None,
         rate_limit: T.Optional[float] = None,
-        settings: OperationSettings = OperationSettings.default,
     ) -> IterProxy[_T]:
         """
         Similar to the ``Model.query()`` method, but it returns
@@ -299,7 +293,6 @@ def iter_query(
                 attributes_to_get=attributes_to_get,
                 page_size=page_size,
                 rate_limit=rate_limit,
-                settings=settings,
             )
         )
 

pynamodb_mate/patterns/cache/backend/dynamodb.py

@@ -73,7 +73,7 @@ class DynamoDBTable(Model):
             Meta = Meta_
 
             key: str = UnicodeAttribute(hash_key=True)
-            value: bytes = BinaryAttribute()
+            value: bytes = BinaryAttribute(legacy_encoding=False)
             expire: int = NumberAttribute()
             update_ts: int = NumberAttribute()
 

pynamodb_mate/patterns/status_tracker/impl.py

@@ -25,7 +25,6 @@
     GlobalSecondaryIndex,
     IncludeProjection,
 )
-from pynamodb.settings import OperationSettings
 
 from ...models import Model
 from ...compat import cached_property
@@ -327,7 +326,6 @@ def get_one_or_none(
         task_id: str,
         consistent_read: bool = False,
         attributes_to_get: T.Optional[T.Sequence[str]] = None,
-        settings: OperationSettings = OperationSettings.default,
         job_id: T.Optional[str] = None,
     ) -> T.Optional["BaseStatusTracker"]:
         """
@@ -338,7 +336,6 @@ def get_one_or_none(
             hash_key=cls.make_key(task_id, JOB_ID),
             consistent_read=consistent_read,
             attributes_to_get=attributes_to_get,
-            settings=settings,
         )
 
     def is_item_exists(self) -> bool:

release-history.rst

@@ -8,11 +8,21 @@ Backlog
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **Features and Improvements**
 
-- add automatically rollback if one of the DynamoDB write or S3 write failed.
-- add an option to delete the S3 object as well when the DynamoDB item is deleted.
-- add lazy load option for S3BackedAttribute.
 - add ``clear_expired()`` method to DynamoDB cache backend.
-- add ``large_attribute`` pattern.
+
+**Minor Improvements**
+
+**Bugfixes**
+
+**Miscellaneous**
+
+
+6.0.0.1 (Planned)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+**Features and Improvements**
+
+- fully support pynamodb 6.X, drop compatible to pynamodb 5.X.
+- add the ``status_tracker_v2`` pattern to ensure strong consistency in high concurrent workload.
 
 **Minor Improvements**
 

requirements.txt

@@ -1,4 +1,4 @@
-pynamodb>=5.5.1,<6.0.0
+pynamodb>=6.0.0,<7.0.0
 cached-property>=1.5.2; python_version < '3.8'
 dataclasses>=0.8; python_version == '3.6'
 iterproxy>=0.3.1,<1.0.0

tests/patterns/test_large_attribute.py

@@ -607,9 +607,9 @@ class TestLargeAttributeUseMock(Base):
     use_mock = True
 
 
-# @pytest.mark.skipif(IS_CI, reason="Skip test that requires AWS resources in CI.")
-# class TestLargeAttributeUseAws(Base):
-#     use_mock = False
+@pytest.mark.skipif(IS_CI, reason="Skip test that requires AWS resources in CI.")
+class TestLargeAttributeUseAws(Base):
+    use_mock = False
 
 
 if __name__ == "__main__":

tests/test_attr_compressed.py

@@ -17,11 +17,11 @@ class Meta:
     # fmt: off
     order_id: pm.REQUIRED_STR = pm.UnicodeAttribute(hash_key=True)
     # original value is unicode str
-    description: pm.OPTIONAL_BINARY = pm.attributes.CompressedUnicodeAttribute(null=True)
+    description: pm.OPTIONAL_BINARY = pm.attributes.CompressedUnicodeAttribute(null=True, legacy_encoding=False)
     # original value is binary bytes
-    image: pm.OPTIONAL_BINARY = pm.attributes.CompressedBinaryAttribute(null=True)
+    image: pm.OPTIONAL_BINARY = pm.attributes.CompressedBinaryAttribute(null=True, legacy_encoding=False)
     # original value is any json serializable object
-    items: pm.OPTIONAL_BINARY = pm.attributes.CompressedJSONDictAttribute(null=True)
+    items: pm.OPTIONAL_BINARY = pm.attributes.CompressedJSONDictAttribute(null=True, legacy_encoding=False)
     # fmt: on
 
 

tests/test_attr_encrypted.py

@@ -2,9 +2,8 @@
 
 import pytest
 
-from boto_session_manager import BotoSesManager
 import pynamodb_mate.api as pm
-from pynamodb_mate.tests.constants import PY_VER, PYNAMODB_VER, AWS_PROFILE, IS_CI
+from pynamodb_mate.tests.constants import PY_VER, PYNAMODB_VER, IS_CI
 from pynamodb_mate.tests.base_test import BaseTest
 
 ENCRYPTION_KEY = "my-password"
@@ -20,22 +19,27 @@ class Meta:
     secret_message: pm.REQUIRED_BINARY = pm.attributes.EncryptedUnicodeAttribute(
         encryption_key=ENCRYPTION_KEY,
         determinative=True,
+        legacy_encoding=False,
     )
     secret_binary: pm.REQUIRED_BINARY = pm.attributes.EncryptedBinaryAttribute(
         encryption_key=ENCRYPTION_KEY,
         determinative=False,
+        legacy_encoding=False,
     )
     secret_integer: pm.REQUIRED_BINARY = pm.attributes.EncryptedNumberAttribute(
         encryption_key=ENCRYPTION_KEY,
         determinative=True,
+        legacy_encoding=False,
     )
     secret_float: pm.REQUIRED_BINARY = pm.attributes.EncryptedNumberAttribute(
         encryption_key=ENCRYPTION_KEY,
         determinative=False,
+        legacy_encoding=False,
     )
     secret_data: pm.REQUIRED_BINARY = pm.attributes.EncryptedJsonDictAttribute(
         encryption_key=ENCRYPTION_KEY,
         determinative=False,
+        legacy_encoding=False,
     )
 
 

tests/test_attr_s3backed.py

@@ -137,9 +137,9 @@ class TestS3BackedAttributeUseMock(Base):
     use_mock = True
 
 
-# @pytest.mark.skipif(IS_CI, reason="Skip test that requires AWS resources in CI.")
-# class TestS3BackedAttributeUseAws(Base):
-#     use_mock = False
+@pytest.mark.skipif(IS_CI, reason="Skip test that requires AWS resources in CI.")
+class TestS3BackedAttributeUseAws(Base):
+    use_mock = False
 
 
 if __name__ == "__main__":