mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PYTHON-4698 Rename the async ClientEncryption to AsyncClientEncryption (#1816)

Browse Source
This commit is contained in:
Noah Stapp 2024-08-27 10:50:44 -04:00 committed by GitHub
parent f4392041b2
commit b8213f2817
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
pymongo/asynchronous/encryption.py
View File

@ -304,7 +304,7 @@ class _EncryptionIO(AsyncMongoCryptCallback): # type: ignore[misc]
class RewrapManyDataKeyResult:
"""Result object returned by a :meth:`~ClientEncryption.rewrap_many_data_key` operation.
"""Result object returned by a :meth:`~AsyncClientEncryption.rewrap_many_data_key` operation.
.. versionadded:: 4.2
"""
@ -316,7 +316,7 @@ class RewrapManyDataKeyResult:
def bulk_write_result(self) -> Optional[BulkWriteResult]:
"""The result of the bulk write operation used to update the key vault
collection with one or more rewrapped data keys. If
:meth:`~ClientEncryption.rewrap_many_data_key` does not find any matching keys to rewrap,
:meth:`~AsyncClientEncryption.rewrap_many_data_key` does not find any matching keys to rewrap,
no bulk write operation will be executed and this field will be
``None``.
"""
@ -506,7 +506,7 @@ def _create_mongocrypt_options(**kwargs: Any) -> MongoCryptOptions:
return opts
class ClientEncryption(Generic[_DocumentType]):
class AsyncClientEncryption(Generic[_DocumentType]):
"""Explicit client-side field level encryption."""
def __init__(
@ -519,7 +519,7 @@ class ClientEncryption(Generic[_DocumentType]):
) -> None:
"""Explicit client-side field level encryption.
The ClientEncryption class encapsulates explicit operations on a key
The AsyncClientEncryption class encapsulates explicit operations on a key
vault collection that cannot be done directly on an AsyncMongoClient. Similar
to configuring auto encryption on an AsyncMongoClient, it is constructed with
an AsyncMongoClient (to a MongoDB cluster containing the key vault
@ -1126,7 +1126,7 @@ class ClientEncryption(Generic[_DocumentType]):
result = await self._key_vault_coll.bulk_write(replacements)
return RewrapManyDataKeyResult(result)
async def __aenter__(self) -> ClientEncryption[_DocumentType]:
async def __aenter__(self) -> AsyncClientEncryption[_DocumentType]:
return self
async def __aexit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
@ -1134,7 +1134,7 @@ class ClientEncryption(Generic[_DocumentType]):
def _check_closed(self) -> None:
if self._encryption is None:
raise InvalidOperation("Cannot use closed ClientEncryption")
raise InvalidOperation("Cannot use closed AsyncClientEncryption")
async def close(self) -> None:
"""Release resources.
@ -1142,7 +1142,7 @@ class ClientEncryption(Generic[_DocumentType]):
Note that using this class in a with-statement will automatically call
:meth:`close`::
with ClientEncryption(...) as client_encryption:
with AsyncClientEncryption(...) as client_encryption:
encrypted = client_encryption.encrypt(value, ...)
decrypted = client_encryption.decrypt(encrypted)

2
pymongo/encryption_options.py
View File

@ -70,7 +70,7 @@ class AutoEncryptionOpts:
users. To configure automatic *decryption* without automatic
*encryption* set ``bypass_auto_encryption=True``. Explicit
encryption and explicit decryption is also supported for all users
with the :class:`~pymongo.encryption.ClientEncryption` class.
with the :class:`~pymongo.asynchronous.encryption.AsyncClientEncryption` and :class:`~pymongo.encryption.ClientEncryption` classes.
See :ref:`automatic-client-side-encryption` for an example.

1
tools/synchro.py
View File

@ -58,6 +58,7 @@ replacements = {
"_AsyncGridOutChunkIterator": "GridOutChunkIterator",
"_a_grid_in_property": "_grid_in_property",
"_a_grid_out_property": "_grid_out_property",
"AsyncClientEncryption": "ClientEncryption",
"AsyncMongoCryptCallback": "MongoCryptCallback",
"AsyncExplicitEncrypter": "ExplicitEncrypter",
"AsyncAutoEncrypter": "AutoEncrypter",