Response¶

The HTTP response object returned by all request methods.

Overview¶

The Response class provides access to all aspects of an HTTP response:

import httpr

response = httpr.get("https://httpbin.org/get")

# Status
print(response.status_code)  # 200

# Body
print(response.text)         # Decoded text
print(response.content)      # Raw bytes
data = response.json()       # Parsed JSON

# Headers (case-insensitive)
print(response.headers["content-type"])
print(response.headers["Content-Type"])  # Same result

# Cookies
print(response.cookies)      # {"session": "value"}

# Metadata
print(response.url)          # Final URL after redirects
print(response.encoding)     # Detected encoding

Properties¶

status_code¶

@property
def status_code(self) -> int

HTTP status code (e.g., 200, 404, 500).

Example:

response = httpr.get("https://httpbin.org/status/201")
print(response.status_code)  # 201

text¶

@property
def text(self) -> str

Response body decoded as text.

Encoding is automatically detected from:

Content-Type header charset
HTML meta charset tag
Falls back to UTF-8

Example:

response = httpr.get("https://httpbin.org/html")
print(response.text)  # HTML content

content¶

@property
def content(self) -> bytes

Response body as raw bytes.

Example:

response = httpr.get("https://httpbin.org/bytes/100")
print(len(response.content))  # 100

# Save binary file
response = httpr.get("https://httpbin.org/image/png")
with open("image.png", "wb") as f:
    f.write(response.content)

headers¶

@property
def headers(self) -> CaseInsensitiveHeaderMap

Response headers as a case-insensitive dict-like object.

Supports:

response.headers["Content-Type"] - get by key
response.headers.get("content-type", "default") - get with default
"content-type" in response.headers - check existence
response.headers.keys() - all header names
response.headers.values() - all header values
response.headers.items() - key-value pairs

Example:

response = httpr.get("https://httpbin.org/get")

# Case-insensitive access
print(response.headers["content-type"])
print(response.headers["Content-Type"])  # Same

# Iteration
for name, value in response.headers.items():
    print(f"{name}: {value}")

cookies¶

@property
def cookies(self) -> dict[str, str]

Cookies set by the server via Set-Cookie headers.

Example:

response = httpr.get("https://httpbin.org/cookies/set?name=value")
print(response.cookies)  # {"name": "value"}

url¶

@property
def url(self) -> str

Final URL after following any redirects.

Example:

response = httpr.get("https://httpbin.org/redirect/3")
print(response.url)  # https://httpbin.org/get

encoding¶

@property
def encoding(self) -> str

Character encoding detected from response headers or content.

Example:

response = httpr.get("https://httpbin.org/encoding/utf8")
print(response.encoding)  # "utf-8"

text_markdown¶

@property
def text_markdown(self) -> str

HTML response body converted to Markdown format.

Uses Rust's html2text crate for conversion.

Example:

response = httpr.get("https://example.com")
print(response.text_markdown)
# # Example Domain
#
# This domain is for use in illustrative examples...

text_plain¶

@property
def text_plain(self) -> str

HTML response body converted to plain text (no formatting).

Example:

response = httpr.get("https://example.com")
print(response.text_plain)

text_rich¶

@property
def text_rich(self) -> str

HTML response body converted to rich text format.

Methods¶

json¶

def json(self) -> Any

Parse response body as JSON.

Returns: Parsed JSON (dict, list, str, int, float, bool, or None)

Raises: Exception if body is not valid JSON

Example:

response = httpr.get("https://httpbin.org/json")
data = response.json()
print(data["slideshow"]["title"])

Note

json() is a method, not a property. Call it with parentheses.

StreamingResponse¶

For streaming large responses without buffering the entire response in memory, use the Client.stream() method which returns a StreamingResponse.

import httpr

with httpr.Client() as client:
    with client.stream("GET", "https://httpbin.org/stream-bytes/1000") as response:
        for chunk in response.iter_bytes():
            process(chunk)

Properties¶

status_code¶

@property
def status_code(self) -> int

HTTP status code (e.g., 200, 404, 500).

Example:

with client.stream("GET", "https://httpbin.org/get") as response:
    print(response.status_code)  # 200

headers¶

@property
def headers(self) -> CaseInsensitiveHeaderMap

Response headers as a case-insensitive dict-like object.

Example:

with client.stream("GET", "https://httpbin.org/get") as response:
    content_type = response.headers["content-type"]

cookies¶

@property
def cookies(self) -> dict[str, str]

Cookies set by the server via Set-Cookie headers.

url¶

@property
def url(self) -> str

Final URL after following any redirects.

is_closed¶

@property
def is_closed(self) -> bool

Whether the stream has been closed.

Example:

with client.stream("GET", "https://httpbin.org/get") as response:
    print(response.is_closed)  # False
print(response.is_closed)  # True (after context manager exits)

is_consumed¶

@property
def is_consumed(self) -> bool

Whether the stream has been fully consumed.

Example:

with client.stream("GET", "https://httpbin.org/get") as response:
    print(response.is_consumed)  # False
    _ = list(response)  # Consume the stream
    print(response.is_consumed)  # True

Methods¶

iter_bytes¶

def iter_bytes(self) -> Iterator[bytes]

Iterate over the response body as bytes chunks.

Returns: Iterator yielding bytes chunks

Example:

with client.stream("GET", "https://httpbin.org/stream-bytes/1000") as response:
    for chunk in response.iter_bytes():
        print(f"Received {len(chunk)} bytes")

iter_text¶

def iter_text(self) -> TextIterator

Iterate over the response body as text chunks, decoded using the response encoding.

Returns: TextIterator yielding string chunks

Example:

with client.stream("GET", "https://httpbin.org/html") as response:
    for text in response.iter_text():
        print(text, end="")

iter_lines¶

def iter_lines(self) -> LineIterator

Iterate over the response body line by line.

Returns: LineIterator yielding string lines

Useful for Server-Sent Events (SSE) and line-based protocols.

Example:

with client.stream("GET", "https://httpbin.org/stream/10") as response:
    for line in response.iter_lines():
        print(line.strip())

read¶

def read(self) -> bytes

Read the entire remaining response body into memory.

Returns: Response body as bytes

Example:

with client.stream("GET", "https://httpbin.org/get") as response:
    if response.status_code == 200:
        content = response.read()

close¶

def close(self) -> None

Close the stream and release resources.

Note: When using the context manager, close() is called automatically.

Example:

with client.stream("GET", "https://httpbin.org/get") as response:
    # Process headers
    if response.status_code != 200:
        response.close()  # Close early without reading body
        return
    # Otherwise read body
    content = response.read()

Direct Iteration¶

StreamingResponse supports direct iteration, which is equivalent to calling iter_bytes():

with client.stream("GET", "https://httpbin.org/stream-bytes/1000") as response:
    for chunk in response:  # Same as response.iter_bytes()
        process(chunk)

Important Notes¶

Always use as context manager: Ensures proper cleanup of resources
Headers available immediately: Status code, headers, cookies, and URL are accessible before reading the body
Body only read on demand: The response body is only fetched when you iterate or call read()
Cannot re-read: Once consumed, the stream cannot be read again
Supported for all methods: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS

Exception Handling¶

The streaming response raises specific exceptions:

StreamClosed: Raised when attempting to read from a closed stream
StreamConsumed: Raised when attempting to re-read a consumed stream

Example:

import httpr

with client.stream("GET", "https://httpbin.org/get") as response:
    content = response.read()

    # This will raise StreamConsumed
    try:
        more = response.read()
    except httpr.StreamConsumed:
        print("Stream already consumed")