aiohttp API reference

251 public APIs from aiohttp (aio-libs/aiohttp) — 105 classes, 18 functions, 128 methods. Signatures extracted by static analysis of the actual source.

Repository: aio-libs/aiohttp

Kind	Count
Classes	105
Functions	18
Methods	128

API list

funcaiohttp._cookie_helpers.parse_cookie_header(header:str) -> list[tuple[str, Morsel[str]]]

Parse a Cookie header according to RFC 6265 Section 5.4.

classaiohttp._websocket.models.WSHandshakeError

WebSocket protocol handshake error.

methodaiohttp._websocket.models.WSMessageTextBytes.json(*loads:Callable[[bytes], Any]=json.loads) -> Any

Return parsed JSON data.

classaiohttp._websocket.models.WebSocketError

WebSocket protocol parser error.

classaiohttp._websocket.writer.WebSocketWriter

WebSocket writer.

methodaiohttp._websocket.writer.WebSocketWriter.close(code:int=1000, message:bytes | str=b'') -> None

Close the websocket, sending the specified code and message.

methodaiohttp._websocket.writer.WebSocketWriter.send_frame(message:bytes, opcode:int, compress:int | None=None) -> None

Send a frame over the websocket with message as its payload.

classaiohttp.abc.AbstractAccessLogger

Abstract writer to access log.

methodaiohttp.abc.AbstractAccessLogger.enabled() -> bool

Check if logger is enabled.

methodaiohttp.abc.AbstractAccessLogger.log(request:BaseRequest, response:StreamResponse, time:float) -> None

Emit log to logger.

classaiohttp.abc.AbstractAsyncAccessLogger

Abstract asynchronous writer to access log.

methodaiohttp.abc.AbstractAsyncAccessLogger.enabled() -> bool

Check if logger is enabled.

methodaiohttp.abc.AbstractAsyncAccessLogger.log(request:BaseRequest, response:StreamResponse, request_start:float) -> None

Emit log to logger.

classaiohttp.abc.AbstractCookieJar

Abstract Cookie Jar.

methodaiohttp.abc.AbstractCookieJar.clear(predicate:ClearCookiePredicate | None=None) -> None

Clear all cookies if no predicate is passed.

methodaiohttp.abc.AbstractCookieJar.clear_domain(domain:str) -> None

Clear all cookies for domain and all subdomains.

methodaiohttp.abc.AbstractCookieJar.cookies() -> MappingProxyType[tuple[str, str], SimpleCookie]

Return the cookies stored in this jar.

methodaiohttp.abc.AbstractCookieJar.filter_cookies(request_url:URL) -> BaseCookie[str]

Return the jar's cookies filtered by their attributes.

methodaiohttp.abc.AbstractCookieJar.host_only_cookies() -> frozenset[tuple[str, str]]

Return the host-only cookies stored in this jar.

methodaiohttp.abc.AbstractCookieJar.quote_cookie() -> bool

Return True if cookies should be quoted.

methodaiohttp.abc.AbstractCookieJar.unsafe() -> bool

Return True if cookies can be used with IP addresses.

methodaiohttp.abc.AbstractCookieJar.update_cookies(cookies:LooseCookies, response_url:URL=URL()) -> None

Update cookies.

methodaiohttp.abc.AbstractCookieJar.update_cookies_from_headers(headers:Sequence[str], response_url:URL) -> None

Update cookies from raw Set-Cookie headers.

classaiohttp.abc.AbstractResolver

Abstract DNS resolver.

methodaiohttp.abc.AbstractResolver.close() -> None

Release resolver

method

aiohttp.abc.AbstractResolver.resolve(host:str, port:int=0, family:socket.AddressFamily=socket.AF_INET) -> list[ResolveResult]

Return IP address for given hostname

classaiohttp.abc.AbstractStreamWriter

Abstract stream writer.

methodaiohttp.abc.AbstractStreamWriter.drain() -> None

Flush the write buffer.

methodaiohttp.abc.AbstractStreamWriter.enable_chunking() -> None

Enable HTTP chunked mode

methodaiohttp.abc.AbstractStreamWriter.enable_compression(encoding:str='deflate', strategy:int | None=None) -> None

Enable HTTP body compression

methodaiohttp.abc.AbstractStreamWriter.send_headers() -> None

Force sending buffered headers if not already sent.

methodaiohttp.abc.AbstractStreamWriter.write(chunk:'bytes | bytearray | memoryview[int] | memoryview[bytes]') -> None

Write chunk into stream.

methodaiohttp.abc.AbstractStreamWriter.write_eof(chunk:bytes=b'') -> None

Write last chunk.

methodaiohttp.abc.AbstractStreamWriter.write_headers(status_line:str, headers:CIMultiDict[str]) -> None

Write HTTP headers

classaiohttp.abc.AbstractView

Abstract class based view.

methodaiohttp.abc.AbstractView.request() -> Request

Request instance.

classaiohttp.abc.ResolveResult

Resolve result.

methodaiohttp.base_protocol.BaseProtocol.connected() -> bool

Return True if the connection is open.

classaiohttp.client.ClientSession

First-class interface for making HTTP requests.

methodaiohttp.client.ClientSession.auto_decompress() -> bool

Should the body response be automatically decompressed.

methodaiohttp.client.ClientSession.close() -> None

Close underlying connector.

methodaiohttp.client.ClientSession.closed() -> bool

Is client session closed.

methodaiohttp.client.ClientSession.connector() -> BaseConnector | None

Connector instance used for the session.

methodaiohttp.client.ClientSession.connector_owner() -> bool

Should connector be closed on session closing

methodaiohttp.client.ClientSession.cookie_jar() -> AbstractCookieJar

The session cookies.

methodaiohttp.client.ClientSession.detach() -> None

Detach connector from session without closing the former.

methodaiohttp.client.ClientSession.headers() -> 'CIMultiDict[str]'

The default headers of the client session.

methodaiohttp.client.ClientSession.json_serialize() -> JSONEncoder

Json serializer callable

methodaiohttp.client.ClientSession.requote_redirect_url() -> bool

Do URL requoting on redirection handling.

methodaiohttp.client.ClientSession.skip_auto_headers() -> frozenset[istr]

Headers for which autogeneration should be skipped

methodaiohttp.client.ClientSession.timeout() -> ClientTimeout

Timeout for the session.

methodaiohttp.client.ClientSession.version() -> tuple[int, int]

The session HTTP protocol version.

classaiohttp.client_exceptions.ClientConnectionError

Base class for client socket errors.

classaiohttp.client_exceptions.ClientConnectionResetError

ConnectionResetError

classaiohttp.client_exceptions.ClientConnectorCertificateError

Response certificate error.

classaiohttp.client_exceptions.ClientConnectorDNSError

DNS resolution failed during client connection.

classaiohttp.client_exceptions.ClientConnectorError

Client connector error.

classaiohttp.client_exceptions.ClientConnectorSSLError

Response ssl error.

classaiohttp.client_exceptions.ClientError

Base class for client connection errors.

classaiohttp.client_exceptions.ClientHttpProxyError

HTTP proxy error.

classaiohttp.client_exceptions.ClientOSError

OSError error.

classaiohttp.client_exceptions.ClientPayloadError

Response payload error.

classaiohttp.client_exceptions.ClientProxyConnectionError

Proxy connection error.

classaiohttp.client_exceptions.ClientResponseError

Base class for exceptions that occur after getting a response.

classaiohttp.client_exceptions.ClientSSLError

Base error for ssl.*Errors.

classaiohttp.client_exceptions.ConnectionTimeoutError

Connection timeout error.

classaiohttp.client_exceptions.ContentTypeError

ContentType found is not valid.

classaiohttp.client_exceptions.InvalidURL

Invalid URL.

classaiohttp.client_exceptions.InvalidUrlClientError

Invalid URL client error.

classaiohttp.client_exceptions.InvalidUrlRedirectClientError

Invalid URL redirect client error.

classaiohttp.client_exceptions.NonHttpUrlClientError

Non http URL client error.

classaiohttp.client_exceptions.NonHttpUrlRedirectClientError

Non http URL redirect client error.

classaiohttp.client_exceptions.RedirectClientError

Client redirect error.

classaiohttp.client_exceptions.ServerConnectionError

Server connection errors.

classaiohttp.client_exceptions.ServerDisconnectedError

Server disconnected.

classaiohttp.client_exceptions.ServerFingerprintMismatch

SSL certificate does not match expected fingerprint.

classaiohttp.client_exceptions.ServerTimeoutError

Server timeout error.

classaiohttp.client_exceptions.SocketTimeoutError

Socket timeout error.

classaiohttp.client_exceptions.TooManyRedirects

Client was redirected too many times.

classaiohttp.client_exceptions.UnixClientConnectorError

Unix connector error.

classaiohttp.client_exceptions.WSMessageTypeError

WebSocket message type is not valid.

classaiohttp.client_exceptions.WSServerHandshakeError

websocket server handshake error.

funcaiohttp.client_middleware_digest_auth.DigestAuthMiddleware.H(x:bytes) -> bytes

RFC 7616 Section 3: Hash function H(data) = hex(hash(data)).

funcaiohttp.client_middleware_digest_auth.escape_quotes(value:str) -> str

Escape backslashes and double quotes for HTTP quoted-strings.

funcaiohttp.client_middleware_digest_auth.unescape_quotes(value:str) -> str

Unescape backslashes and double quotes in HTTP quoted-strings.

func

aiohttp.client_middlewares.build_client_middlewares(handler:ClientHandlerType, middlewares:tuple[ClientMiddlewareType, ...]) -> ClientHandlerType

Apply middlewares to request handler.

classaiohttp.client_proto.ResponseHandler

Helper class to adapt between Protocol and StreamReader.

methodaiohttp.client_proto.ResponseHandler.closed() -> None | asyncio.Future[None]

Future that is set when the connection is closed.

classaiohttp.client_reqrep.ClientRequestBase

An internal class for proxy requests.

classaiohttp.connector.BaseConnector

Base connector class.

methodaiohttp.connector.BaseConnector.close(*abort_ssl:bool=False) -> None

Close all opened transports.

methodaiohttp.connector.BaseConnector.closed() -> bool

Is connector closed.

methodaiohttp.connector.BaseConnector.connect(req:ClientRequest, traces:list['Trace'], timeout:'ClientTimeout') -> Connection

Get from pool or create new connection.

methodaiohttp.connector.BaseConnector.force_close() -> bool

Ultimately close connection on releasing if True.

methodaiohttp.connector.BaseConnector.limit() -> int

The total number for simultaneous connections.

classaiohttp.connector.Connection

Represents a single connection.

classaiohttp.connector.NamedPipeConnector

Named pipe connector.

methodaiohttp.connector.NamedPipeConnector.path() -> str

Path to the named pipe.

classaiohttp.connector.TCPConnector

TCP connector.

methodaiohttp.connector.TCPConnector.clear_dns_cache(host:str | None=None, port:int | None=None) -> None

Remove specified host/port or clear all dns local cache.

methodaiohttp.connector.TCPConnector.close(*abort_ssl:bool=False) -> None

Close all opened transports.

methodaiohttp.connector.TCPConnector.family() -> int

Socket family like AF_INET.

methodaiohttp.connector.TCPConnector.use_dns_cache() -> bool

True if local DNS caching is enabled.

classaiohttp.connector.UnixConnector

Unix socket connector.

methodaiohttp.connector.UnixConnector.path() -> str

Path to unix socket.

classaiohttp.cookiejar.CookieJar

Implements cookie storage adhering to RFC 6265.

methodaiohttp.cookiejar.CookieJar.cookies() -> MappingProxyType[tuple[str, str], SimpleCookie]

Return the cookies stored in this jar.

methodaiohttp.cookiejar.CookieJar.filter_cookies(request_url:URL) -> 'BaseCookie[str]'

Returns this jar's cookies filtered by their attributes.

methodaiohttp.cookiejar.CookieJar.host_only_cookies() -> frozenset[tuple[str, str]]

Return the host-only cookies stored in this jar.

methodaiohttp.cookiejar.CookieJar.load(file_path:PathLike) -> None

Load cookies from a JSON file.

methodaiohttp.cookiejar.CookieJar.save(file_path:PathLike) -> None

Save cookies to a file using JSON format.

methodaiohttp.cookiejar.CookieJar.update_cookies(cookies:LooseCookies, response_url:URL=URL()) -> None

Update cookies.

classaiohttp.cookiejar.DummyCookieJar

Implements a dummy cookie storage.

methodaiohttp.cookiejar.DummyCookieJar.cookies() -> MappingProxyType[tuple[str, str], SimpleCookie]

Return an empty mapping.

methodaiohttp.cookiejar.DummyCookieJar.host_only_cookies() -> frozenset[tuple[str, str]]

Return an empty frozenset.

classaiohttp.formdata.FormData

Helper class for form body generation.

classaiohttp.helpers.AppKey

Keys for static typing support in Application.

classaiohttp.helpers.BaseKey

Base for concrete context storage key classes.

classaiohttp.helpers.CookieMixin

Mixin for handling cookies.

method

aiohttp.helpers.CookieMixin.del_cookie(name:str, *domain:str | None=None, *path:str='/', *secure:bool | None=None, *httponly:bool | None=None, *samesite:str | None=None) -> None

Delete cookie.

classaiohttp.helpers.HeadersMixin

Mixin for handling headers.

methodaiohttp.helpers.HeadersMixin.charset() -> str | None

The value of charset part for Content-Type HTTP header.

methodaiohttp.helpers.HeadersMixin.content_length() -> int | None

The value of Content-Length HTTP header.

methodaiohttp.helpers.HeadersMixin.content_type() -> str

The value of content part for Content-Type HTTP header.

classaiohttp.helpers.RequestKey

Keys for static typing support in Request.

classaiohttp.helpers.ResponseKey

Keys for static typing support in Response.

classaiohttp.helpers.TimeoutHandle

Timeout handle

classaiohttp.helpers.TimerContext

Low resolution timeout context manager

methodaiohttp.helpers.TimerContext.assert_timeout() -> None

Raise TimeoutError if timer has already been cancelled.

funcaiohttp.helpers.calculate_timeout_when(loop_time:float, timeout:float, timeout_ceiling_threshold:float) -> float

Calculate when to execute a timeout.

func

aiohttp.helpers.content_disposition_header(disptype:str, quote_fields:bool=True, _charset:str='utf-8', params:dict[str, str] | None=None) -> str

Sets ``Content-Disposition`` header for MIME.

funcaiohttp.helpers.get_env_proxy_for_url(url:URL) -> tuple[URL, str | None]

Get a permitted proxy for the given URL from the env.

funcaiohttp.helpers.is_canonical_ipv4_address(host:str) -> bool

Check if host is a canonical dotted-quad IPv4 address.

funcaiohttp.helpers.is_ip_address(host:str | None) -> bool

Check if host looks like an IP Address.

funcaiohttp.helpers.must_be_empty_body(method:str, code:int) -> bool

Check if a request must return an empty body.

funcaiohttp.helpers.netrc_from_env() -> netrc.netrc | None

Load netrc from file.

funcaiohttp.helpers.parse_content_type(raw:str) -> tuple[str, MappingProxyType[str, str]]

Parse Content-Type header.

funcaiohttp.helpers.parse_http_date(date_str:str | None) -> datetime.datetime | None

Process a date string, return a datetime object

funcaiohttp.helpers.parse_mimetype(mimetype:str) -> MimeType

Parses a MIME type into its components.

funcaiohttp.helpers.quoted_string(content:str) -> str

Return 7-bit content as quoted-string.

func

aiohttp.helpers.set_exception(fut:Union['asyncio.Future[_T]', ErrorableProtocol], exc:type[BaseException] | BaseException, exc_cause:BaseException=_EXC_SENTINEL) -> None

Set future exception.

funcaiohttp.helpers.should_remove_content_length(method:str, code:int) -> bool

Check if a Content-Length header should be removed.

classaiohttp.http_exceptions.BadHttpMethod

Invalid HTTP method in status line.

classaiohttp.http_exceptions.ContentEncodingError

Content encoding error.

classaiohttp.http_exceptions.ContentLengthError

Not enough data to satisfy content length header.

classaiohttp.http_exceptions.HttpProcessingError

HTTP error.

classaiohttp.http_exceptions.PayloadEncodingError

Base class for payload errors

classaiohttp.http_exceptions.TransferEncodingError

transfer encoding error.

classaiohttp.http_parser.HttpRequestParser

Read request status line.

classaiohttp.http_parser.HttpResponseParser

Read response status line and headers.

methodaiohttp.http_writer.StreamWriter.drain() -> None

Flush the write buffer.

methodaiohttp.http_writer.StreamWriter.send_headers() -> None

Force sending buffered headers if not already sent.

methodaiohttp.http_writer.StreamWriter.set_eof() -> None

Indicate that the message is complete.

method

aiohttp.http_writer.StreamWriter.write(chunk:Union[bytes, bytearray, 'memoryview[int]', 'memoryview[bytes]'], *drain:bool=True, *LIMIT:int=65536) -> None

Writes chunk of data to a stream.

methodaiohttp.http_writer.StreamWriter.write_headers(status_line:str, headers:'CIMultiDict[str]') -> None

Write headers to the stream.

classaiohttp.multipart.BodyPartReader

Multipart reader for single body part.

methodaiohttp.multipart.BodyPartReader.decode(data:bytes) -> bytes

Decodes data synchronously.

methodaiohttp.multipart.BodyPartReader.decode_iter(data:bytes) -> AsyncIterator[bytes]

Async generator that yields decoded data chunks.

methodaiohttp.multipart.BodyPartReader.get_charset(default:str) -> str

Returns charset parameter from Content-Type header or default.

methodaiohttp.multipart.BodyPartReader.json(*encoding:str | None=None) -> dict[str, Any] | None

Like read(), but assumes that body parts contains JSON data.

methodaiohttp.multipart.BodyPartReader.name() -> str | None

Returns name specified in Content-Disposition header.

methodaiohttp.multipart.BodyPartReader.read(*decode:bool=False) -> bytes

Reads body part data.

methodaiohttp.multipart.BodyPartReader.read_chunk(size:int=chunk_size) -> bytes

Reads body part content chunk of the specified size.

methodaiohttp.multipart.BodyPartReader.readline() -> bytes

Reads body part by line by line.

methodaiohttp.multipart.BodyPartReader.release() -> None

Like read(), but reads all the data to the void.

methodaiohttp.multipart.BodyPartReader.text(*encoding:str | None=None) -> str

Like read(), but assumes that body part contains text data.

classaiohttp.multipart.MultipartReader

Multipart body reader.

methodaiohttp.multipart.MultipartReader.fetch_next_part() -> Union['MultipartReader', BodyPartReader]

Returns the next body part reader.

methodaiohttp.multipart.MultipartReader.from_response(response:'ClientResponse') -> MultipartResponseWrapper

Constructs reader instance from HTTP response.

methodaiohttp.multipart.MultipartReader.next() -> Union['MultipartReader', BodyPartReader] | None

Emits the next multipart body part.

classaiohttp.multipart.MultipartResponseWrapper

Wrapper around the MultipartReader.

methodaiohttp.multipart.MultipartResponseWrapper.at_eof() -> bool

Returns True when all response data had been read.

methodaiohttp.multipart.MultipartResponseWrapper.next() -> Union['MultipartReader', 'BodyPartReader'] | None

Emits next multipart reader object.

methodaiohttp.multipart.MultipartResponseWrapper.release() -> None

Release the connection gracefully.

classaiohttp.multipart.MultipartWriter

Multipart body writer.

method

aiohttp.multipart.MultipartWriter.append_form(obj:Sequence[tuple[str, str]] | Mapping[str, str], headers:Mapping[str, str] | None=None) -> Payload

Helper to append form urlencoded part.

methodaiohttp.multipart.MultipartWriter.append_json(obj:Any, headers:Mapping[str, str] | None=None) -> Payload

Helper to append JSON part.

methodaiohttp.multipart.MultipartWriter.append_payload(payload:Payload) -> Payload

Adds a new body part to multipart writer.

methodaiohttp.multipart.MultipartWriter.as_bytes(encoding:str='utf-8', errors:str='strict') -> bytes

Return bytes representation of the multipart data.

methodaiohttp.multipart.MultipartWriter.close() -> None

Close all part payloads that need explicit closing.

methodaiohttp.multipart.MultipartWriter.decode(encoding:str='utf-8', errors:str='strict') -> str

Return string representation of the multipart data.

methodaiohttp.multipart.MultipartWriter.size() -> int | None

Size of the payload.

methodaiohttp.multipart.MultipartWriter.write(writer:AbstractStreamWriter, close_boundary:bool=True) -> None

Write body.

classaiohttp.payload.JsonBytesPayload

JSON payload for encoders that return bytes directly.

classaiohttp.payload.LookupError

Raised when no payload factory is found for the given data type.

methodaiohttp.payload.Payload.as_bytes(encoding:str='utf-8', errors:str='strict') -> bytes

Return bytes representation of the value.

methodaiohttp.payload.Payload.autoclose() -> bool

Whether the payload can close itself automatically.

methodaiohttp.payload.Payload.close() -> None

Close the payload if it holds any resources.

methodaiohttp.payload.Payload.consumed() -> bool

Whether the payload has been consumed and cannot be reused.

methodaiohttp.payload.Payload.content_type() -> str

Content type

methodaiohttp.payload.Payload.decode(encoding:str='utf-8', errors:str='strict') -> str

Return string representation of the value.

methodaiohttp.payload.Payload.encoding() -> str | None

Payload encoding

methodaiohttp.payload.Payload.filename() -> str | None

Filename of the payload.

methodaiohttp.payload.Payload.headers() -> CIMultiDict[str]

Custom item headers

method

aiohttp.payload.Payload.set_content_disposition(disptype:str, quote_fields:bool=True, _charset:str='utf-8', **params:str) -> None

Sets ``Content-Disposition`` header.

methodaiohttp.payload.Payload.size() -> int | None

Size of the payload in bytes.

methodaiohttp.payload.Payload.write(writer:AbstractStreamWriter) -> None

Write payload to the writer stream.

methodaiohttp.payload.Payload.write_with_length(writer:AbstractStreamWriter, content_length:int | None) -> None

Write payload with a specific content length constraint.

classaiohttp.payload.PayloadRegistry

Payload registry.

classaiohttp.resolver.AsyncResolver

Use the `aiodns` package to make asynchronous DNS lookups

classaiohttp.resolver.ThreadedResolver

Threaded resolver.

classaiohttp.streams.DataQueue

DataQueue is a general-purpose blocking queue with one reader.

classaiohttp.streams.EofStream

eof stream indication.

classaiohttp.streams.StreamReader

An enhancement of asyncio.StreamReader.

methodaiohttp.streams.StreamReader.is_eof() -> bool

Return True if 'feed_eof' was called.

methodaiohttp.streams.StreamReader.iter_any() -> AsyncStreamIterator[bytes]

Yield all available data as soon as it is received.

methodaiohttp.streams.StreamReader.iter_chunked(n:int) -> AsyncStreamIterator[bytes]

Returns an asynchronous iterator that yields chunks of size n.

methodaiohttp.streams.StreamReader.readchunk() -> tuple[bytes, bool]

Returns a tuple of (data, end_of_http_chunk).

methodaiohttp.streams.StreamReader.set_read_chunk_size(n:int) -> None

Raise buffer limits to match the consumer's chunk size.

methodaiohttp.streams.StreamReader.unread_data(data:bytes) -> None

rollback reading some data from stream, inserting it to buffer head.

classaiohttp.tracing.Trace

Internal dependency holder class.

classaiohttp.tracing.TraceConnectionCreateEndParams

Parameters sent by the `on_connection_create_end` signal

classaiohttp.tracing.TraceConnectionQueuedEndParams

Parameters sent by the `on_connection_queued_end` signal

classaiohttp.tracing.TraceConnectionReuseconnParams

Parameters sent by the `on_connection_reuseconn` signal

classaiohttp.tracing.TraceDnsCacheHitParams

Parameters sent by the `on_dns_cache_hit` signal

classaiohttp.tracing.TraceDnsCacheMissParams

Parameters sent by the `on_dns_cache_miss` signal

classaiohttp.tracing.TraceDnsResolveHostEndParams

Parameters sent by the `on_dns_resolvehost_end` signal

classaiohttp.tracing.TraceDnsResolveHostStartParams

Parameters sent by the `on_dns_resolvehost_start` signal

classaiohttp.tracing.TraceRequestChunkSentParams

Parameters sent by the `on_request_chunk_sent` signal

classaiohttp.tracing.TraceRequestEndParams

Parameters sent by the `on_request_end` signal

classaiohttp.tracing.TraceRequestExceptionParams

Parameters sent by the `on_request_exception` signal

classaiohttp.tracing.TraceRequestHeadersSentParams

Parameters sent by the `on_request_headers_sent` signal

classaiohttp.tracing.TraceRequestRedirectParams

Parameters sent by the `on_request_redirect` signal

classaiohttp.tracing.TraceRequestStartParams

Parameters sent by the `on_request_start` signal

methodaiohttp.web_app.Application.cleanup() -> None

Causes on_cleanup signal Should be called after shutdown()

methodaiohttp.web_app.Application.shutdown() -> None

Causes on_shutdown signal Should be called before cleanup()

classaiohttp.web_exceptions.HTTPRedirection

Base class for exceptions with status codes in the 300s.

classaiohttp.web_exceptions.HTTPSuccessful

Base class for exceptions with status codes in the 200s.

classaiohttp.web_exceptions.NotAppKeyWarning

Warning when not using AppKey in Application.

classaiohttp.web_fileresponse.FileResponse

A response object can be used to send files.

classaiohttp.web_log.AccessLogger

Helper object to log access.

methodaiohttp.web_log.AccessLogger.enabled() -> bool

Check if logger is enabled.

classaiohttp.web_protocol.PayloadAccessError

Payload was accessed after response was sent.

classaiohttp.web_protocol.RequestHandler

HTTP protocol implementation.

methodaiohttp.web_protocol.RequestHandler.close() -> None

Close connection.

methodaiohttp.web_protocol.RequestHandler.force_close() -> None

Forcefully close connection.

method

aiohttp.web_protocol.RequestHandler.handle_error(request:BaseRequest, status:int=500, exc:BaseException | None=None, message:str | None=None) -> StreamResponse

Handle errors.

methodaiohttp.web_protocol.RequestHandler.keep_alive(val:bool) -> None

Set keep-alive connection mode.

methodaiohttp.web_protocol.RequestHandler.peername() -> str | tuple[str, int, int, int] | tuple[str, int] | None

Return peername if available.

methodaiohttp.web_protocol.RequestHandler.shutdown(timeout:float | None=15.0) -> None

Do worker process exit preparations.

methodaiohttp.web_protocol.RequestHandler.sockname() -> str | tuple[str, int, int, int] | tuple[str, int] | None

Return sockname if available.

methodaiohttp.web_protocol.RequestHandler.ssl_context() -> Optional['ssl.SSLContext']

Return SSLContext if available.

methodaiohttp.web_protocol.RequestHandler.start() -> None

Process incoming request.

classaiohttp.web_protocol.RequestPayloadError

Payload parsing error.

methodaiohttp.web_request.Request.app() -> 'Application'

Application instance.

methodaiohttp.web_request.Request.match_info() -> 'UrlMappingMatchInfo'

Result of route resolving.

classaiohttp.web_routedef.RouteTableDef

Route definition table

classaiohttp.web_runner.AppRunner

Web Application runner

classaiohttp.web_runner.ServerRunner

Low-level web server runner

classaiohttp.web_urldispatcher.ResourceRoute

A route with resource

methodaiohttp.web_urldispatcher.ResourceRoute.url_for(*args:str, **kwargs:str) -> URL

Construct url for route with additional params.

About this data

These signatures were extracted from the public source of aio-libs/aiohttp using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries