Fixed linking issue with algorithm in Sphinx. Black also made some small changes so formatting

may be slightly different, but it should be the same functionality wise.  I have a couple errors
that I believe are not from my own changes (they were there on master when I pulled and pertain to
there not being valid AWS credentials for tests for the most part), but they should not be important.

Author: Adriano Hernandez

src/aws_encryption_sdk/__init__.py

@@ -14,10 +14,17 @@
 # Below are imported for ease of use by implementors
 from aws_encryption_sdk.caches.local import LocalCryptoMaterialsCache  # noqa
 from aws_encryption_sdk.caches.null import NullCryptoMaterialsCache  # noqa
-from aws_encryption_sdk.identifiers import Algorithm, __version__  # noqa
-from aws_encryption_sdk.key_providers.kms import KMSMasterKeyProvider, KMSMasterKeyProviderConfig  # noqa
-from aws_encryption_sdk.materials_managers.caching import CachingCryptoMaterialsManager  # noqa
-from aws_encryption_sdk.materials_managers.default import DefaultCryptoMaterialsManager  # noqa
+from aws_encryption_sdk.identifiers import AlgorithmSuite, __version__  # noqa
+from aws_encryption_sdk.key_providers.kms import (
+    KMSMasterKeyProvider,
+    KMSMasterKeyProviderConfig,
+)  # noqa
+from aws_encryption_sdk.materials_managers.caching import (
+    CachingCryptoMaterialsManager,
+)  # noqa
+from aws_encryption_sdk.materials_managers.default import (
+    DefaultCryptoMaterialsManager,
+)  # noqa
 from aws_encryption_sdk.streaming_client import (  # noqa
     DecryptorConfig,
     EncryptorConfig,
@@ -69,8 +76,8 @@ def encrypt(**kwargs):
             this is not enforced if a `key_provider` is provided.
 
     :param dict encryption_context: Dictionary defining encryption context
-    :param algorithm: Algorithm to use for encryption
-    :type algorithm: aws_encryption_sdk.identifiers.Algorithm
+    :param algorithm: AlgorithmSuite to use for encryption
+    :type algorithm: aws_encryption_sdk.identifiers.AlgorithmSuite
     :param int frame_length: Frame length in bytes
     :returns: Tuple containing the encrypted ciphertext and the message header object
     :rtype: tuple of bytes and :class:`aws_encryption_sdk.structures.MessageHeader`
@@ -177,7 +184,12 @@ def stream(**kwargs):
     :raises ValueError: if supplied with an unsupported mode value
     """
     mode = kwargs.pop("mode")
-    _stream_map = {"e": StreamEncryptor, "encrypt": StreamEncryptor, "d": StreamDecryptor, "decrypt": StreamDecryptor}
+    _stream_map = {
+        "e": StreamEncryptor,
+        "encrypt": StreamEncryptor,
+        "d": StreamDecryptor,
+        "decrypt": StreamDecryptor,
+    }
     try:
         return _stream_map[mode.lower()](**kwargs)
     except KeyError:

src/aws_encryption_sdk/identifiers.py

@@ -50,7 +50,15 @@ class EncryptionSuite(Enum):
     AES_192_GCM_IV12_TAG16 = (algorithms.AES, modes.GCM, 24, 12, 16)
     AES_256_GCM_IV12_TAG16 = (algorithms.AES, modes.GCM, 32, 12, 16)
 
-    def __init__(self, algorithm, mode, data_key_length, iv_length, auth_length, auth_key_length=0):
+    def __init__(
+        self,
+        algorithm,
+        mode,
+        data_key_length,
+        iv_length,
+        auth_length,
+        auth_key_length=0,
+    ):
         """Prepare a new EncryptionSuite."""
         self.algorithm = algorithm
         self.mode = mode
@@ -157,9 +165,21 @@ class AlgorithmSuite(Enum):  # pylint: disable=too-many-instance-attributes
     AES_128_GCM_IV12_TAG16 = (0x0014, EncryptionSuite.AES_128_GCM_IV12_TAG16)
     AES_192_GCM_IV12_TAG16 = (0x0046, EncryptionSuite.AES_192_GCM_IV12_TAG16)
     AES_256_GCM_IV12_TAG16 = (0x0078, EncryptionSuite.AES_256_GCM_IV12_TAG16)
-    AES_128_GCM_IV12_TAG16_HKDF_SHA256 = (0x0114, EncryptionSuite.AES_128_GCM_IV12_TAG16, KDFSuite.HKDF_SHA256)
-    AES_192_GCM_IV12_TAG16_HKDF_SHA256 = (0x0146, EncryptionSuite.AES_192_GCM_IV12_TAG16, KDFSuite.HKDF_SHA256)
-    AES_256_GCM_IV12_TAG16_HKDF_SHA256 = (0x0178, EncryptionSuite.AES_256_GCM_IV12_TAG16, KDFSuite.HKDF_SHA256)
+    AES_128_GCM_IV12_TAG16_HKDF_SHA256 = (
+        0x0114,
+        EncryptionSuite.AES_128_GCM_IV12_TAG16,
+        KDFSuite.HKDF_SHA256,
+    )
+    AES_192_GCM_IV12_TAG16_HKDF_SHA256 = (
+        0x0146,
+        EncryptionSuite.AES_192_GCM_IV12_TAG16,
+        KDFSuite.HKDF_SHA256,
+    )
+    AES_256_GCM_IV12_TAG16_HKDF_SHA256 = (
+        0x0178,
+        EncryptionSuite.AES_256_GCM_IV12_TAG16,
+        KDFSuite.HKDF_SHA256,
+    )
     AES_128_GCM_IV12_TAG16_HKDF_SHA256_ECDSA_P256 = (
         0x0214,
         EncryptionSuite.AES_128_GCM_IV12_TAG16,
@@ -240,6 +260,8 @@ def safe_to_cache(self):
         return self.kdf is not KDFSuite.NONE
 
 
+# algorithm is just an alias for AlgorithmSuite ... but Sphinx does not recognize this fact
+# so we need to go through and fix the references
 Algorithm = AlgorithmSuite
 
 
@@ -271,16 +293,60 @@ class WrappingAlgorithm(Enum):
     :type padding_mgf:
     """
 
-    AES_128_GCM_IV12_TAG16_NO_PADDING = (EncryptionType.SYMMETRIC, Algorithm.AES_128_GCM_IV12_TAG16, None, None, None)
-    AES_192_GCM_IV12_TAG16_NO_PADDING = (EncryptionType.SYMMETRIC, Algorithm.AES_192_GCM_IV12_TAG16, None, None, None)
-    AES_256_GCM_IV12_TAG16_NO_PADDING = (EncryptionType.SYMMETRIC, Algorithm.AES_256_GCM_IV12_TAG16, None, None, None)
+    AES_128_GCM_IV12_TAG16_NO_PADDING = (
+        EncryptionType.SYMMETRIC,
+        AlgorithmSuite.AES_128_GCM_IV12_TAG16,
+        None,
+        None,
+        None,
+    )
+    AES_192_GCM_IV12_TAG16_NO_PADDING = (
+        EncryptionType.SYMMETRIC,
+        AlgorithmSuite.AES_192_GCM_IV12_TAG16,
+        None,
+        None,
+        None,
+    )
+    AES_256_GCM_IV12_TAG16_NO_PADDING = (
+        EncryptionType.SYMMETRIC,
+        AlgorithmSuite.AES_256_GCM_IV12_TAG16,
+        None,
+        None,
+        None,
+    )
     RSA_PKCS1 = (EncryptionType.ASYMMETRIC, rsa, padding.PKCS1v15, None, None)
-    RSA_OAEP_SHA1_MGF1 = (EncryptionType.ASYMMETRIC, rsa, padding.OAEP, hashes.SHA1, padding.MGF1)
-    RSA_OAEP_SHA256_MGF1 = (EncryptionType.ASYMMETRIC, rsa, padding.OAEP, hashes.SHA256, padding.MGF1)
-    RSA_OAEP_SHA384_MGF1 = (EncryptionType.ASYMMETRIC, rsa, padding.OAEP, hashes.SHA384, padding.MGF1)
-    RSA_OAEP_SHA512_MGF1 = (EncryptionType.ASYMMETRIC, rsa, padding.OAEP, hashes.SHA512, padding.MGF1)
+    RSA_OAEP_SHA1_MGF1 = (
+        EncryptionType.ASYMMETRIC,
+        rsa,
+        padding.OAEP,
+        hashes.SHA1,
+        padding.MGF1,
+    )
+    RSA_OAEP_SHA256_MGF1 = (
+        EncryptionType.ASYMMETRIC,
+        rsa,
+        padding.OAEP,
+        hashes.SHA256,
+        padding.MGF1,
+    )
+    RSA_OAEP_SHA384_MGF1 = (
+        EncryptionType.ASYMMETRIC,
+        rsa,
+        padding.OAEP,
+        hashes.SHA384,
+        padding.MGF1,
+    )
+    RSA_OAEP_SHA512_MGF1 = (
+        EncryptionType.ASYMMETRIC,
+        rsa,
+        padding.OAEP,
+        hashes.SHA512,
+        padding.MGF1,
+    )
 
-    def __init__(self, encryption_type, algorithm, padding_type, padding_algorithm, padding_mgf):
+    def __init__(
+        self, encryption_type, algorithm, padding_type, padding_algorithm, padding_mgf
+    ):
         """Prepares new WrappingAlgorithm."""
         self.encryption_type = encryption_type
         self.algorithm = algorithm