Skip to content
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.

Sign up for GitHub

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

Try to make Request generic over State #2218

Closed
wants to merge 1 commit into from
Closed

Try to make Request generic over State #2218

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions starlette/requests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from http import cookies as http_cookies

import anyio
import typing_extensions

from starlette._utils import AwaitableOrContextManager, AwaitableOrContextManagerWrapper
from starlette.datastructures import URL, Address, FormData, Headers, QueryParams, State
Expand Down Expand Up @@ -60,15 +61,27 @@ class ClientDisconnect(Exception):
pass


class HTTPConnection(typing.Mapping[str, typing.Any]):
_StateType = typing_extensions.TypeVar("_StateType", default=State)


class HTTPConnection(typing.Mapping[str, typing.Any], typing.Generic[_StateType]):
"""
A base class for incoming HTTP connections, that is used to provide
any functionality that is common to both `Request` and `WebSocket`.
"""

def __init__(self, scope: Scope, receive: typing.Optional[Receive] = None) -> None:
def __init__(
self,
scope: Scope,
receive: typing.Optional[Receive] = None,
*,
state_factory: typing.Callable[
[typing.Dict[str, typing.Any]], _StateType
] = State,
) -> None:
assert scope["type"] in ("http", "websocket")
self.scope = scope
self._state_factory = state_factory

def __getitem__(self, key: str) -> typing.Any:
return self.scope[key]
Expand Down Expand Up @@ -164,13 +177,13 @@ def user(self) -> typing.Any:
return self.scope["user"]

@property
def state(self) -> State:
def state(self) -> _StateType:
if not hasattr(self, "_state"):
# Ensure 'state' has an empty dict if it's not already populated.
self.scope.setdefault("state", {})
# Create a state instance with a reference to the dict in which it should
# store info
self._state = State(self.scope["state"])
self._state = self._state_factory(self.scope["state"])
return self._state

def url_for(self, name: str, /, **path_params: typing.Any) -> URL:
Expand Down
Loading