PYTHON-2883 Regex decoding error tests in top.json have unexpected, invalid syntax #721
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
Sep 7, 2021
bson/json_util.py
Outdated
| @@ -634,6 +634,8 @@ def _parse_canonical_code(doc): | |||
| def _parse_canonical_regex(doc): | |||
| """Decode a JSON regex to bson.regex.Regex.""" | |||
| regex = doc['$regularExpression'] | |||
| if not isinstance(regex['options'], str): | |||
| raise TypeError('Bad $regularExpression options, options must be string') | |||
There was a problem hiding this comment.
Please move this check to below the len(doc) and len(regex) checks to ensure we give good error messages in all cases. For the same reason can you also add the type() of regex['options'] to the error message?
ShaneHarvey
requested changes
Sep 8, 2021
bson/json_util.py
Outdated
| @@ -639,6 +639,8 @@ def _parse_canonical_regex(doc): | |||
| if len(regex) != 2: | |||
| raise TypeError('Bad $regularExpression must include only "pattern"' | |||
| 'and "options" components: %s' % (doc,)) | |||
| if not isinstance(regex['options'], str): | |||
| raise TypeError('Bad $regularExpression options, options must be string, was type %s' % (type(regex['options']))) | |||
There was a problem hiding this comment.
We limit our lines to 79 chars according to pep 8: https://www.python.org/dev/peps/pep-0008/#maximum-line-length
ShaneHarvey
reviewed
Sep 9, 2021
bson/json_util.py
Outdated
| @@ -639,6 +639,9 @@ def _parse_canonical_regex(doc): | |||
| if len(regex) != 2: | |||
| raise TypeError('Bad $regularExpression must include only "pattern"' | |||
| 'and "options" components: %s' % (doc,)) | |||
| if not isinstance(regex['options'], str): | |||
| raise TypeError('Bad $regularExpression options, options must be ' | |||
| 'string, was type %s' % (type(regex['options']))) | |||
| return Regex(regex['pattern'], regex['options']) | |||
There was a problem hiding this comment.
I suggest refactoring to regex['options'] to a local variable to avoid looking it up repeatedly and improve readability.
2 tasks
juliusgeo
added a commit
to juliusgeo/mongo-python-driver
that referenced
this pull request
Oct 1, 2021
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.
https://jira.mongodb.org/browse/PYTHON-2883