Skip to content

Commit d3fcab7

Browse files
committed
docs: add versionadded flags to docstrings for keyring values
1 parent cf6bcdf commit d3fcab7

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

src/aws_encryption_sdk/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ def encrypt(**kwargs):
3333
When using this function, the entire ciphertext message is encrypted into memory before returning
3434
any data. If streaming is desired, see :class:`aws_encryption_sdk.stream`.
3535
36+
.. versionadded:: 1.5.0
37+
The *keyring* parameter.
38+
3639
.. code:: python
3740
3841
>>> import aws_encryption_sdk
@@ -87,6 +90,9 @@ def decrypt(**kwargs):
8790
When using this function, the entire ciphertext message is decrypted into memory before returning
8891
any data. If streaming is desired, see :class:`aws_encryption_sdk.stream`.
8992
93+
.. versionadded:: 1.5.0
94+
The *keyring* parameter.
95+
9096
.. code:: python
9197
9298
>>> import aws_encryption_sdk

src/aws_encryption_sdk/materials_managers/caching.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ class CachingCryptoMaterialsManager(CryptoMaterialsManager):
4444
4545
.. versionadded:: 1.3.0
4646
47+
.. versionadded:: 1.5.0
48+
The *keyring* parameter.
49+
4750
>>> import aws_encryption_sdk
4851
>>> kms_key_provider = aws_encryption_sdk.KMSMasterKeyProvider(key_ids=[
4952
... 'arn:aws:kms:us-east-1:2222222222222:key/22222222-2222-2222-2222-222222222222',

src/aws_encryption_sdk/streaming_client.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@
6969
class _ClientConfig(object):
7070
"""Parent configuration object for StreamEncryptor and StreamDecryptor objects.
7171
72+
.. versionadded:: 1.5.0
73+
The *keyring* parameter.
74+
7275
:param source: Source data to encrypt or decrypt
7376
:type source: str, bytes, io.IOBase, or file
7477
:param CryptoMaterialsManager materials_manager:
@@ -314,6 +317,9 @@ def next(self):
314317
class EncryptorConfig(_ClientConfig):
315318
"""Configuration object for StreamEncryptor class.
316319
320+
.. versionadded:: 1.5.0
321+
The *keyring* parameter.
322+
317323
:param source: Source data to encrypt or decrypt
318324
:type source: str, bytes, io.IOBase, or file
319325
:param CryptoMaterialsManager materials_manager:
@@ -365,6 +371,9 @@ class StreamEncryptor(_EncryptionStream): # pylint: disable=too-many-instance-a
365371
.. note::
366372
If config is provided, all other parameters are ignored.
367373
374+
.. versionadded:: 1.5.0
375+
The *keyring* parameter.
376+
368377
:param config: Client configuration object (config or individual parameters required)
369378
:type config: aws_encryption_sdk.streaming_client.EncryptorConfig
370379
:param source: Source data to encrypt or decrypt
@@ -674,6 +683,9 @@ def close(self):
674683
class DecryptorConfig(_ClientConfig):
675684
"""Configuration object for StreamDecryptor class.
676685
686+
.. versionadded:: 1.5.0
687+
The *keyring* parameter.
688+
677689
:param source: Source data to encrypt or decrypt
678690
:type source: str, bytes, io.IOBase, or file
679691
:param CryptoMaterialsManager materials_manager:
@@ -710,6 +722,9 @@ class StreamDecryptor(_EncryptionStream): # pylint: disable=too-many-instance-a
710722
.. note::
711723
If config is provided, all other parameters are ignored.
712724
725+
.. versionadded:: 1.5.0
726+
The *keyring* parameter.
727+
713728
:param config: Client configuration object (config or individual parameters required)
714729
:type config: aws_encryption_sdk.streaming_client.DecryptorConfig
715730
:param source: Source data to encrypt or decrypt

0 commit comments

Comments
 (0)