sanic
sanic copied to clipboard
Add option for non snake_case query parameters in url_for
Is there an existing issue for this?
- [X] I have searched the existing issues
Is your feature request related to a problem? Please describe.
Passing query parameters with keys that aren't snake_case in url_for
is currently not possible, as python only allows underscores in function parameter names. However it is quite common for query parameters to be hyphenated. So for example, generating a url like http://server/posts/5?user-id=123
is currently not possible with url_for
. Someone may even want to use camelCase for their parameter names.
Describe the solution you'd like
It would be nice if there were an additional parameter like hyphenate: bool = False
or something that would do something like {k.replace('_', '-'): v for k, v in kwargs.items()} before encoding query parameters, as it is extremely common to separate query parameters with hyphens instead of underscores.
Or better yet, have an additional parameter query_params: Dict[str, Any]
that accepts a dictionary of str: any
pairs, and adds that as query parameters, which would also allow passing camelCase parameters (personally don't need this, but someone might), and just update the current kwargs with it
Additional context
The codebase I'm currently working on uses hyphens for query parameters, so either the entire codebase would need to be reworked, or I'd need to manually manipulate the string from url_for
and add hyphenated query parameters to make things work as expected. Creating a built in option for handling this would be very helpful. The current functionality of implementing anything that is not a request parameter as a part of the query string should not be removed for backwards compatibility, but adding a query_params
parameter would also serve the purpose of self documenting code more clearly