fix: add custom filter to enable adding python names to path #987
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
harabat
force-pushed
the
convert_endpoint_path
branch
2 times, most recently
from
833f434 to
46fe762
Compare
harabat
changed the title
harabat
force-pushed
the
convert_endpoint_path
branch
from
46fe762 to
7efb231
Compare
github-merge-queue bot
pushed a commit
that referenced
this pull request
Mar 6, 2024
Fixes #976 and #578, and replaces #978. @dbanty please choose your preferred approach between this and PR #987. The original issue is that `openapi-python-client` throws `incorrect path templating` warnings when the path has a parameter with a hyphen and consequently fails to generate the endpoints. --- The first commit ensures that hyphens are recognised as allowed delimiters in parameter path names. This allows the endpoints to be generated. However, this generates lines like these: ```python def _get_kwargs( user_id: int, ) -> Dict[str, Any]: _kwargs: Dict[str, Any] = { "method": "post", "url": "/activitypub/user-id/{user-id}/inbox".format(user-id=user_id,), } return _kwargs ``` Since Python variable names cannot contain hyphens, the `user-id` parameter name here will trigger errors (starting with `ruff`). --- The second commit replaces parameter names with their `python_name` in `__init__.py` and passes the modified path to `templates/endpoint_module.py.jinja`. This fixes the issue and allows endpoints to be generated correctly. --- #987 is a different option for the second commit which instead creates a custom Jinja filter in `utils.py` and so that the parameter names in `endpoint.path` can be converted to their python names directly in `templates/endpoint_module.py.jinja`. Both approaches are equivalent and have been tested with different parameter names (snake case, camel case, kebab case, mixed). --------- Co-authored-by: harabat <[email protected]> Co-authored-by: Dylan Anthony <[email protected]> Co-authored-by: Dylan Anthony <[email protected]>
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.
Fixes #976 and #578, and replaces #978.
@dbanty please choose your preferred approach between this and PR #986.
The original issue is that
openapi-python-clientthrowsincorrect path templatingwarnings when the path has a parameter with a hyphen and consequently fails to generate the endpoints.The first commit ensures that hyphens are recognised as allowed delimiters in parameter path names. This allows the endpoints to be generated.
However, this generates lines like these:
Since Python variable names cannot contain hyphens, the
user-idparameter name here will trigger errors (starting withruff).The second commit creates a custom Jinja filter in
utils.pyand so that the parameter names inendpoint.pathcan be converted to their python names directly intemplates/endpoint_module.py.jinja.This fixes the issue and allows endpoints to be generated correctly.
#986 is a different option for the second commit which instead replaces parameter names with their
python_namein__init__.pyand passes the modified path totemplates/endpoint_module.py.jinja.Both approaches are equivalent and have been tested with different parameter names (snake case, camel case, kebab case, mixed).