Skip to content

Version 1.0, working notes. #1092

Closed
Closed
@tomchristie

Description

@tomchristie

Here are my current working notes on our remaining 1.0 items...

HTTPX 1.0

Minor:

Not strictly required, but worth looking at:


API Reference

Here's a high-level API reference...

Helper functions

request, stream, get, options, head, post, put, patch, delete

Clients

Client, AsyncClient

Models

Response, Request, URL, QueryParams, Headers, Cookies

Configuration

Limits, Proxy, Timeout

Authentication

Auth, BasicAuth, DigestAuth

Transports

ASGITransport, WSGITransport

Status Codes

codes

Exceptions

  • RequestError All exceptions that can occur during a .request()
    • TransportError These all have counterparts in httpcore
      • TimeoutException
        • ConnectTimeout
        • ReadTimeout
        • WriteTimeout
        • PoolTimeout
      • NetworkError
        • ConnectError
        • ReadError
        • WriteError
        • CloseError
      • ProxyError
      • ProtocolError
    • DecodingError
      • ContentDecodingError
      • TextDecodingError
    • TooManyRedirects
    • RequestBodyUnavailable
    • InvalidURL
  • HTTPStatusError - Occurs during .raise_for_status
  • NotRedirectResponse - Occurs if calling .next() without properly checking .is_redirect_response
  • CookieConflict - Can occur with response.cookies.get(...)
  • StreamError
    • StreamConsumed - Occurs if attempting to iterate over the stream twice
    • ResponseNotRead - Occurs if accessing .content without having .read() the stream
    • RequestNotRead - Occurs if accessing .content without having .read() the stream
    • ResponseClosed - Occurs if attempting to read the stream after response is already closed

Dependencies

Here's how our lovely & minimal core non-optional dependancies would look...
Depending on our assessment of #328 (comment)

  • httpcore
    • h11
    • sniffio
  • rfc3986
    • idna
  • certifi

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions