-
-
Notifications
You must be signed in to change notification settings - Fork 6.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix URL pattern parsing in schema generation #5689
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ | |
|
||
See schemas.__init__.py for package overview. | ||
""" | ||
import re | ||
import warnings | ||
from collections import Counter, OrderedDict | ||
from importlib import import_module | ||
|
@@ -135,6 +136,11 @@ def endpoint_ordering(endpoint): | |
return (path, method_priority) | ||
|
||
|
||
_PATH_PARAMETER_COMPONENT_RE = re.compile( | ||
r'<(?:(?P<converter>[^>:]+):)?(?P<parameter>\w+)>' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the full regex copied from Django 2. I didn't dare to import it, since it had an underscore in front of it. |
||
) | ||
|
||
|
||
class EndpointEnumerator(object): | ||
""" | ||
A class to determine the available API endpoints that a project exposes. | ||
|
@@ -189,7 +195,9 @@ def get_path_from_regex(self, path_regex): | |
Given a URL conf regex, return a URI template string. | ||
""" | ||
path = simplify_regex(path_regex) | ||
path = path.replace('<', '{').replace('>', '}') | ||
|
||
# Strip Django 2.0 convertors as they are incompatible with uritemplate format | ||
path = re.sub(_PATH_PARAMETER_COMPONENT_RE, r'{\g<parameter>}', path) | ||
return path | ||
|
||
def should_include_endpoint(self, path, callback): | ||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this has broken #5672 even further - instead of getting the expected regex it now gets a path/regex hybrid like
'convtest/<int:pk>\\.(?P<format>[a-z0-9]+)/?$'
when trying to add suffix patterns.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed,
str(urlpattern.pattern)
is not always a regex pattern anymore. Maybe we need to undo this change and have an if-else inEndpointEnumerator
, depending if urlpattern is a RoutePattern or a RegexPattern?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That would still leave #5672 broken, just in a different way.
Perhaps renaming the method to something like
get_original_route
would help avoid confusion, but a separate fix would still be needed for the other issue.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem adding a similar, not quite duplicate, function to compat. (We can always abstract again later.)