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

Add generic typing for TestClient #1769

Closed
wants to merge 1 commit into from
Closed

Add generic typing for TestClient #1769

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
11 changes: 6 additions & 5 deletions starlette/testclient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
ASGIInstance = typing.Callable[[Receive, Send], typing.Awaitable[None]]
ASGI2App = typing.Callable[[Scope], ASGIInstance]
ASGI3App = typing.Callable[[Scope, Receive, Send], typing.Awaitable[None]]
T_ASGI3App = typing.TypeVar("T_ASGI3App", bound=ASGI3App)


class _HeaderDict(requests.packages.urllib3._collections.HTTPHeaderDict):
Expand Down Expand Up @@ -402,14 +403,14 @@ def receive_json(self, mode: str = "text") -> typing.Any:
return json.loads(text)


class TestClient(requests.Session):
class TestClient(requests.Session, typing.Generic[T_ASGI3App]):
__test__ = False # For pytest to not discover this up.
task: "Future[None]"
portal: typing.Optional[anyio.abc.BlockingPortal] = None

def __init__(
self,
app: typing.Union[ASGI2App, ASGI3App],
app: typing.Union[ASGI2App, T_ASGI3App],
base_url: str = "http://testserver",
raise_server_exceptions: bool = True,
root_path: str = "",
Expand All @@ -421,11 +422,11 @@ def __init__(
backend=backend, backend_options=backend_options or {}
)
if _is_asgi3(app):
app = typing.cast(ASGI3App, app)
app = typing.cast(T_ASGI3App, app)
asgi_app = app
else:
app = typing.cast(ASGI2App, app)
asgi_app = _WrapASGI2(app) #  type: ignore
asgi_app = _WrapASGI2(app) # type: ignore
adapter = _ASGIAdapter(
asgi_app,
portal_factory=self._portal_factory,
Expand All @@ -437,7 +438,7 @@ def __init__(
self.mount("ws://", adapter)
self.mount("wss://", adapter)
self.headers.update({"user-agent": "testclient"})
self.app = asgi_app
self.app = typing.cast(T_ASGI3App, asgi_app)
self.base_url = base_url

@contextlib.contextmanager
Expand Down