convert all attrs classes to use custom init methods to enable mypy to work #4

Author: mattsb42-aws

src/dynamodb_encryption_sdk/delegated_keys/jce.py

@@ -22,6 +22,12 @@
 from cryptography.hazmat.primitives.asymmetric import rsa
 import six
 
+try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
+    from typing import Dict, Optional, Text  # noqa pylint: disable=unused-import
+except ImportError:  # pragma: no cover
+    # We only actually need these imports when running the mypy checks
+    pass
+
 from dynamodb_encryption_sdk.exceptions import JceTransformationError, UnwrappingError
 from dynamodb_encryption_sdk.identifiers import EncryptionKeyType, KeyEncodingType, LOGGER_NAME
 from dynamodb_encryption_sdk.internal.crypto.jce_bridge import authentication, encryption, primitives
@@ -67,7 +73,7 @@ def _generate_rsa_key(key_length):
 }
 
 
-@attr.s
+@attr.s(init=False)
 class JceNameLocalDelegatedKey(DelegatedKey):
     # pylint: disable=too-many-instance-attributes
     """Delegated key that uses JCE StandardName algorithm values to determine behavior.
@@ -114,6 +120,25 @@ class JceNameLocalDelegatedKey(DelegatedKey):
     _key_type = attr.ib(validator=attr.validators.instance_of(EncryptionKeyType))
     _key_encoding = attr.ib(validator=attr.validators.instance_of(KeyEncodingType))
 
+    def __init__(
+            self,
+            key,  # type: bytes
+            algorithm,  # type: Text
+            key_type,  # type: EncryptionKeyType
+            key_encoding  # type: KeyEncodingType
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        self.key = key
+        self._algorithm = algorithm
+        self._key_type = key_type
+        self._key_encoding = key_encoding
+        attr.validate(self)
+        self.__attrs_post_init__()
+
     @property
     def algorithm(self):
         # type: () -> Text

src/dynamodb_encryption_sdk/encrypted/__init__.py

@@ -30,7 +30,7 @@
 __all__ = ('CryptoConfig',)
 
 
-@attr.s
+@attr.s(init=False)
 class CryptoConfig(object):
     """Container for all configuration needed to encrypt or decrypt an item.
 
@@ -46,6 +46,23 @@ class CryptoConfig(object):
     encryption_context = attr.ib(validator=attr.validators.instance_of(EncryptionContext))
     attribute_actions = attr.ib(validator=attr.validators.instance_of(AttributeActions))
 
+    def __init__(
+            self,
+            materials_provider,  # type: CryptographicMaterialsProvider
+            encryption_context,  # type: EncryptionContext
+            attribute_actions  # type: AttributeActions
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        self.materials_provider = materials_provider
+        self.encryption_context = encryption_context
+        self.attribute_actions = attribute_actions
+        attr.validate(self)
+        self.__attrs_post_init__()
+
     def __attrs_post_init__(self):
         # type: () -> None
         """Make sure that primary index attributes are not being encrypted."""

src/dynamodb_encryption_sdk/encrypted/client.py

@@ -16,6 +16,12 @@
 import attr
 import botocore
 
+try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
+    from typing import Any, Callable, Dict, Optional  # noqa pylint: disable=unused-import
+except ImportError:  # pragma: no cover
+    # We only actually need these imports when running the mypy checks
+    pass
+
 from dynamodb_encryption_sdk.internal.utils import (
     crypto_config_from_cache, crypto_config_from_kwargs,
     decrypt_batch_get_item, decrypt_get_item, decrypt_multi_get,
@@ -30,7 +36,7 @@
 __all__ = ('EncryptedClient',)
 
 
-@attr.s
+@attr.s(init=False)
 class EncryptedPaginator(object):
     """Paginator that decrypts returned items before returning them.
 
@@ -44,6 +50,22 @@ class EncryptedPaginator(object):
     _decrypt_method = attr.ib()
     _crypto_config_method = attr.ib(validator=callable_validator)
 
+    def __init__(
+            self,
+            paginator,  # type: botocore.paginate.Paginator
+            decrypt_method,  # type: Callable
+            crypto_config_method  # type: Callable
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        self._paginator = paginator
+        self._decrypt_method = decrypt_method
+        self._crypto_config_method = crypto_config_method
+        attr.validate(self)
+
     @_decrypt_method.validator
     def validate_decrypt_method(self, attribute, value):
         # pylint: disable=unused-argument
@@ -84,7 +106,7 @@ def paginate(self, **kwargs):
             yield page
 
 
-@attr.s
+@attr.s(init=False)
 class EncryptedClient(object):
     # pylint: disable=too-few-public-methods,too-many-instance-attributes
     """High-level helper class to provide a familiar interface to encrypted tables.
@@ -143,6 +165,30 @@ class EncryptedClient(object):
         default=False
     )
 
+    def __init__(
+            self,
+            client,  # type: botocore.client.BaseClient
+            materials_provider,  # type: CryptographicMaterialsProvider
+            attribute_actions=None,  # type: Optional[AttributeActions]
+            auto_refresh_table_indexes=True,  # type: Optional[bool]
+            expect_standard_dictionaries=False  # type: Optional[bool]
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        if attribute_actions is None:
+            attribute_actions = AttributeActions()
+
+        self._client = client
+        self._materials_provider = materials_provider
+        self._attribute_actions = attribute_actions
+        self._auto_refresh_table_indexes = auto_refresh_table_indexes
+        self._expect_standard_dictionaries = expect_standard_dictionaries
+        attr.validate(self)
+        self.__attrs_post_init__()
+
     def __attrs_post_init__(self):
         """Set up the table info cache and translation methods."""
         if self._expect_standard_dictionaries:

src/dynamodb_encryption_sdk/encrypted/resource.py

@@ -28,7 +28,7 @@
 __all__ = ('EncryptedResource',)
 
 
-@attr.s
+@attr.s(init=False)
 class EncryptedTablesCollectionManager(object):
     # pylint: disable=too-few-public-methods
     """Tables collection manager that provides EncryptedTable objects.
@@ -50,6 +50,25 @@ class EncryptedTablesCollectionManager(object):
     _attribute_actions = attr.ib(validator=attr.validators.instance_of(AttributeActions))
     _table_info_cache = attr.ib(validator=attr.validators.instance_of(TableInfoCache))
 
+    def __init__(
+            self,
+            collection,  # type: CollectionManager
+            materials_provider,  # type: CryptographicMaterialsProvider
+            attribute_actions,  # type: AttributeActions
+            table_info_cache  # type: TableInfoCache
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        self._collection = collection
+        self._materials_provider = materials_provider
+        self._attribute_actions = attribute_actions
+        self._table_info_cache = table_info_cache
+        attr.validate(self)
+        self.__attrs_post_init__()
+
     def __attrs_post_init__(self):
         """Set up the translation methods."""
         self.all = partial(  # attrs confuses pylint: disable=attribute-defined-outside-init
@@ -95,7 +114,7 @@ def _transform_table(self, method, **kwargs):
             )
 
 
-@attr.s
+@attr.s(init=False)
 class EncryptedResource(object):
     # pylint: disable=too-few-public-methods
     """High-level helper class to provide a familiar interface to encrypted tables.
@@ -142,6 +161,28 @@ class EncryptedResource(object):
         default=True
     )
 
+    def __init__(
+            self,
+            resource,  # type: ServiceResource
+            materials_provider,  # type: CryptographicMaterialsProvider
+            attribute_actions=None,  # type: Optional[AttributeActions]
+            auto_refresh_table_indexes=True  # type: Optional[bool]
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        if attribute_actions is None:
+            attribute_actions = AttributeActions()
+
+        self._resource = resource
+        self._materials_provider = materials_provider
+        self._attribute_actions = attribute_actions
+        self._auto_refresh_table_indexes = auto_refresh_table_indexes
+        attr.validate(self)
+        self.__attrs_post_init__()
+
     def __attrs_post_init__(self):
         """Set up the table info cache, encrypted tables collection manager, and translation methods."""
         self._table_info_cache = TableInfoCache(  # attrs confuses pylint: disable=attribute-defined-outside-init

src/dynamodb_encryption_sdk/encrypted/table.py

@@ -29,7 +29,7 @@
 __all__ = ('EncryptedTable',)
 
 
-@attr.s
+@attr.s(init=False)
 class EncryptedTable(object):
     # pylint: disable=too-few-public-methods
     """High-level helper class to provide a familiar interface to encrypted tables.
@@ -86,6 +86,30 @@ class EncryptedTable(object):
         default=True
     )
 
+    def __init__(
+            self,
+            table,  # type: ServiceResource
+            materials_provider,  # type: CryptographicMaterialsProvider
+            table_info=None,  # type: Optional[TableInfo]
+            attribute_actions=None,  # type: Optional[AttributeActions]
+            auto_refresh_table_indexes=True  # type: Optional[bool]
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        if attribute_actions is None:
+            attribute_actions = AttributeActions()
+
+        self._table = table
+        self._materials_provider = materials_provider
+        self._table_info = table_info
+        self._attribute_actions = attribute_actions
+        self._auto_refresh_table_indexes = auto_refresh_table_indexes
+        attr.validate(self)
+        self.__attrs_post_init__()
+
     def __attrs_post_init__(self):
         """Prepare table info is it was not set and set up translation methods."""
         if self._table_info is None:

src/dynamodb_encryption_sdk/internal/crypto/authentication.py

@@ -14,6 +14,13 @@
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives import hashes
 
+try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
+    from typing import Text  # noqa pylint: disable=unused-import
+    from dynamodb_encryption_sdk.internal import dynamodb_types  # noqa pylint: disable=unused-import
+except ImportError:  # pragma: no cover
+    # We only actually need these imports when running the mypy checks
+    pass
+
 from dynamodb_encryption_sdk.delegated_keys import DelegatedKey  # noqa pylint: disable=unused-import
 from dynamodb_encryption_sdk.encrypted import CryptoConfig  # noqa pylint: disable=unused-import
 from dynamodb_encryption_sdk.identifiers import CryptoAction
@@ -71,7 +78,7 @@ def verify_item_signature(signature_attribute, encrypted_item, verification_key,
 
 
 def _string_to_sign(item, table_name, attribute_actions):
-    # type: (dynamodb_type.ITEM, Text, AttributeActions) -> bytes
+    # type: (dynamodb_types.ITEM, Text, AttributeActions) -> bytes
     """Generate the string to sign from an encrypted item and configuration.
 
     :param dict item: Encrypted DynamoDB item

src/dynamodb_encryption_sdk/internal/crypto/jce_bridge/authentication.py

@@ -21,7 +21,7 @@
 import six
 
 try:  # Python 3.5.0 and 3.5.1 have incompatible typing modules
-    from typing import Text  # noqa pylint: disable=unused-import
+    from typing import Any, Callable, Text  # noqa pylint: disable=unused-import
 except ImportError:  # pragma: no cover
     # We only actually need these imports when running the mypy checks
     pass
@@ -87,7 +87,7 @@ def verify(self, key, signature, data):
         """
 
 
-@attr.s
+@attr.s(init=False)
 class JavaMac(JavaAuthenticator):
     """Symmetric MAC authenticators.
 
@@ -99,6 +99,22 @@ class JavaMac(JavaAuthenticator):
     algorithm_type = attr.ib(validator=callable_validator)
     hash_type = attr.ib(validator=callable_validator)
 
+    def __init__(
+            self,
+            java_name,  # type: Text
+            algorithm_type,  # type: Callable
+            hash_type  # type: Callable
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        self.java_name = java_name
+        self.algorithm_type = algorithm_type
+        self.hash_type = hash_type
+        attr.validate(self)
+
     def _build_hmac_signer(self, key):
         # type: (bytes) -> Any
         """Build HMAC signer using instance algorithm and hash type and ``key``.
@@ -182,7 +198,7 @@ def verify(self, key, signature, data):
             raise SignatureVerificationError(message)
 
 
-@attr.s
+@attr.s(init=False)
 class JavaSignature(JavaAuthenticator):
     """Asymmetric signature authenticators.
 
@@ -195,6 +211,24 @@ class JavaSignature(JavaAuthenticator):
     hash_type = attr.ib(validator=callable_validator)
     padding_type = attr.ib(validator=callable_validator)
 
+    def __init__(
+            self,
+            java_name,  # type: Text
+            algorithm_type,
+            hash_type,  # type: Callable
+            padding_type  # type: Callable
+    ):
+        # type: (...) -> None
+        """Workaround pending resolution of attrs/mypy interaction.
+        https://github.com/python/mypy/issues/2088
+        https://github.com/python-attrs/attrs/issues/215
+        """
+        self.java_name = java_name
+        self.algorithm_type = algorithm_type
+        self.hash_type = hash_type
+        self.padding_type = padding_type
+        attr.validate(self)
+
     def validate_algorithm(self, algorithm):
         # type: (Text) -> None
         """Determine whether the requested algorithm name is compatible with this authenticator.