Fixed: change typing on register_pattern #57
Merged
Conversation
This file contains 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
Previously the `register_pattern` method had a type declaration of `Pattern` for the `pattern` argument, but the instance checker would raise an error if the pattern was not a string. This commit changes the type declaration to accept `str` rather than Pattern. Changing the type annotation was chosen as it was the least disruptive to the current behaviour of the library. A small test was added to check that this function does not accept compiled regex statements. Fixes sanic-org#59
ahopkins
approved these changes
Jan 26, 2022
The automatic checks indicated that this import was no longer used. Also, the docstring needed to be updated.
|
@ahopkins just checking to see if this PR needs anything further? |
|
I think ideally we should accept either a pattern or a string. Do you think you could make that change here? |
Now allows both Pattern and str as arguments for the pattern. Adjusts the error messages and documentation for the type. Adjusts the tests to verify that Patterns are accepted as valid arguments. Fixes sanic-org#56
|
OK, I have made that change. Let me know if it needs anything else! |
|
Thanks @ahankinson. I made a small change to run |
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.
Previously the
register_patternmethod had a type declaration ofPatternfor thepatternargument, but the instance checker would raise an error if the pattern was not a string.This commit changes the type declaration to accept
strrather than Pattern. Changing the type annotation was chosen as it was the least disruptive to the current behaviour of the library.A small test was added to check that this function does not accept compiled regex statements.
Fixes #56