Type of request.client

[amacfie]

The docs say that Request.client is a 2-tuple and either component may be None, but in the code the type of Request.client is Optional[Address] where Address is

class Address(typing.NamedTuple):
    host: str
    port: int

So if the code reflects the actual behavior, should the docs be reworded to say Request.client itself may be None but its components aren't None?

[Kludex]

I think the documentation is wrong. I remember that type hint being fixed to match what is on the ASGI spec: https://asgi.readthedocs.io/en/latest/specs/www.html#http-connection-scope.

PR welcome to fix the documentation - please also confirm what I said (a blame on the Address would likely point you to a PR).

[amacfie]

Do you know in what circumstances Request.client is None?

[iamdbychkov]

The case of request.client being None (that I know of) is when ASGI server didn't put this information in a scope.

For e.g. uvicorn listening on a UNIX socket won't give you client information until you put "forwarded_allow_ips": "*" in a settings, thus request.client would return None