The Wayback Machine - https://web.archive.org/web/20201115183149/https://github.com/encode/starlette/pull/875
Skip to content

/ starlette

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

Jump to bottom

Customizable request class #875

Open
wants to merge 5 commits into
base: master
from
Open

Customizable request class #875

wants to merge 5 commits into from

Conversation

@alex-oleshkevich
Copy link
Contributor

@alex-oleshkevich alex-oleshkevich commented Mar 24, 2020 •
edited

This allows users to change the default Request class.

There are following customization options:

  1. Set request_class on Route constructor:
Route('/', endpoint, request_class=MyRequest)

This has higher precedence than request_class defined in HTTPEndpoint class.

  1. Set request_class in HTTPEndpoint:
class MyEndpoint(HTTPEndpoint):
    request_class = MyRequest

    def get(self, request: MyRequest): ...
@alex-oleshkevich
Allow user to define request class per route/endpoint.
Verified
This commit was signed with a verified signature.
alex-oleshkevich Alex Oleshkevich
GPG key ID: 02D34C20AE88FDA8 Learn about signing commits
656cc08
@alex-oleshkevich
Fix mypy errors.
Verified
This commit was signed with a verified signature.
alex-oleshkevich Alex Oleshkevich
GPG key ID: 02D34C20AE88FDA8 Learn about signing commits
81fdfbe
@alex-oleshkevich
Remove unused imports.
Verified
This commit was signed with a verified signature.
alex-oleshkevich Alex Oleshkevich
GPG key ID: 02D34C20AE88FDA8 Learn about signing commits
261ca32
@alex-oleshkevich
Restore original formatting.
Verified
This commit was signed with a verified signature.
alex-oleshkevich Alex Oleshkevich
GPG key ID: 02D34C20AE88FDA8 Learn about signing commits
eb7b094
@alex-oleshkevich
Add docs.
Verified
This commit was signed with a verified signature.
alex-oleshkevich Alex Oleshkevich
GPG key ID: 02D34C20AE88FDA8 Learn about signing commits
0bda561
@alex-oleshkevich alex-oleshkevich marked this pull request as ready for review Mar 24, 2020
@florimondmanca
Copy link
Member

@florimondmanca florimondmanca commented Mar 25, 2020 •
edited

Dropping by out of curiosity — could you explicit some practical use cases that would motivate the ability to swap the request class? Maybe this is linked to an existing issue?
@em92
Copy link
Contributor

@em92 em92 commented Mar 25, 2020

could you explicit some practical use cases that would motivate the ability to swap the request class?

I would store this to MyRequest constructor. https://github.com/em92/quakelive-local-ratings/blob/879c354c4f8d25965c93f6a1c84e68c48f1aabb4/qllr/endpoints.py#L53-L68
@alex-oleshkevich
Copy link
Contributor Author

@alex-oleshkevich alex-oleshkevich commented Mar 25, 2020

I am building an application that has a custom Request class. This class has extra methods related to it (input validation, helpers to get values from GET/POST, user IP, and many other helpers).

In order to make use of it, I have to completely extend Route/HTTPEndpoint/request_response names. It is a huge overhead here.

Also, it is useful for frameworks built on top of Starlette. They often have own request classes (look at HttpRequest in Django and Request in DRF).
@florimondmanca florimondmanca mentioned this pull request Mar 27, 2020
Merged
@abersheeran abersheeran mentioned this pull request May 14, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants
@alex-oleshkevich @florimondmanca @em92
You can’t perform that action at this time.