Allow Responses to be used as Context Managers

Requests API allows Responses to be used and closed as a context manager.

We should allow the following use-cases:

async def run_async():
    client = httpx.AsyncClient()
    async with client.get("https://example.com") as resp:
        resp.raise_for_status()

def run_sync():
    client = httpx.Client()
    with client.get("https://example.com") as resp:
        resp.raise_for_status()

See: PendragonLore/anido#1

[sethmlarson]

Maybe we can put a warning on the Responses garbage collector that it wasn’t closed properly, similar to files?

[tomchristie]

Okay, so…

This is relevant only for the streaming case. In other cases the response has been closed by the point it’s returned from the function.

There’s a question here to be had in that client.get(..., stream=True) is actually fundamentally different to client.get(...) because you really want to be using a context manager for the first case.

Requests has exactly the same issue, and actually makes it really easy to not close streaming responses. One option that we could do here that’s a bit radical would be to diverge from the requests API here, even through stream=True is a fairly widely used case.

Eg. client.stream() could return a context managed response. (It might have a default method='get' that could be overidden.)

One other bugbear to be wary of here is that “stream” in this context specifically means “stream the response”, not “stream the request” (which yes, we support, but that’s different), but the naming isn’t very clear about the expectation.