PYTHON-2267: Allow UUID key_id to be passed to ClientEncryption.encrypt #1494
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ShaneHarvey
requested changes
Jan 31, 2024
pymongo/encryption.py
Outdated
| key_alt_name: Optional[str] = None, | ||
| query_type: Optional[str] = None, | ||
| contention_factor: Optional[int] = None, | ||
| range_opts: Optional[RangeOpts] = None, | ||
| is_expression: bool = False, | ||
| ) -> Any: | ||
| self._check_closed() | ||
| if isinstance(key_id, uuid.UUID): | ||
| key_id = Binary(key_id.bytes, UUID_SUBTYPE) |
There was a problem hiding this comment.
Let's use Binary.from_uuid(key_id) here.
| @@ -795,7 +799,7 @@ def encrypt( | |||
| self, | |||
| value: Any, | |||
| algorithm: str, | |||
| key_id: Optional[Binary] = None, | |||
| key_id: Optional[Union[Binary, uuid.UUID]] = None, | |||
There was a problem hiding this comment.
In the docstring below can you add this?
.. versionchanged:: 4.7
``key_id`` can now be passed in as a :class:`uuid.UUID`.
.. versionchanged:: 4.2
...
And same for encrypt_expression.
ShaneHarvey
approved these changes
Feb 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Modify the ClientEncryption.encrypt API to accept native UUIDs directly. jira task
I validated my changes with the TestExplicitSimple cases. pytest -v -s test/test_encryption.py::TestExplicitSimple
I tried to run all the test_encryption.py tests, but some of the tests require environment credentials, and as far as I understand, I need MongoDB Enterprise for mongocryptd support.