aiohttp API Reference
Full documentation for aiohttp (3.14.1)
aiohttp.AddrInfoType
Python Library Documentation: GenericAlias in module builtins class tuple(object) | tuple(iterable=(), /) | | Built-in immutable sequence. | | If no argument is given, the constructor returns an empty tuple. | If iterable is specified the tuple is initialized from iterable's items. | | If the argument is a tuple, the return value is the same object. | | Built-in subclasses: | asyncgen_hooks | ClientTimeoutAttributes | ClientWSTimeoutAttributes | ContentDispositionAttributes | ... and 21 other subclasses | | Methods defined here: | | __add__(self, value, /) | Return self+value. | | __contains__(self, key, /) | Return bool(key in self). | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getitem__(self, key, /) | Return self[key]. | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __iter__(self, /) | Implement iter(self). | | __le__(self, value, /) | Return self<=value. | | __len__(self, /) | Return len(self). | | __lt__(self, value, /) | Return self<value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | __rmul__(self, value, /) | Return value*self. | | count(self, value, /) | Return number of occurrences of value. | | index(self, value, start=0, stop=9223372036854775807, /) | Return first index of value. | | Raises ValueError if the value is not present. | | ---------------------------------------------------------------------- | Class methods defined here: | | __class_getitem__(...) | See PEP 585 | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
aiohttp.AsyncIterablePayload
Python Library Documentation: class AsyncIterablePayload in module aiohttp.payload
class AsyncIterablePayload(Payload)
| AsyncIterablePayload(value: collections.abc.AsyncIterable, *args: Any, **kwargs: Any) -> None
|
| Method resolution order:
| AsyncIterablePayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: collections.abc.AsyncIterable, *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method reads the entire async iterable content and returns it as bytes.
| It generates and caches the chunks for future reuse.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Decode the payload content as a string if cached chunks are available.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire async iterable payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method iterates through the async iterable and writes each chunk
| to the writer without any length constraint.
|
| Note:
| For new implementations that need length control, use write_with_length() directly.
| This method is maintained for backwards compatibility with existing code.
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write async iterable payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This implementation handles streaming of async iterable content with length constraints:
|
| 1. If cached chunks are available, writes from them
| 2. Otherwise iterates through the async iterable one chunk at a time
| 3. Respects content_length constraints when specified
| 4. Does NOT generate cache - that's done by as_bytes()
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {'_cached_chunks': list[bytes] | None, '_iter': coll...
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| In the future, this will be the only close method supported.
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| size
| Size of the payload in bytes.
|
| Returns the number of bytes that will be transmitted when the payload
| is written. For string payloads, this is the size after encoding to bytes,
| not the length of the string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.AsyncResolver
Python Library Documentation: class AsyncResolver in module aiohttp.resolver
class AsyncResolver(aiohttp.abc.AbstractResolver)
| AsyncResolver(loop: asyncio.events.AbstractEventLoop | None = None, *args: Any, **kwargs: Any) -> None
|
| Use the `aiodns` package to make asynchronous DNS lookups
|
| Method resolution order:
| AsyncResolver
| aiohttp.abc.AbstractResolver
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, loop: asyncio.events.AbstractEventLoop | None = None, *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async close(self) -> None
| Release resolver
|
| async resolve(self, host: str, port: int = 0, family: socket.AddressFamily = <AddressFamily.AF_INET: 2>) -> list[aiohttp.abc.ResolveResult]
| Return IP address for given hostname
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from aiohttp.abc.AbstractResolver:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.BadContentDispositionHeader
Python Library Documentation: class BadContentDispositionHeader in module aiohttp.multipart class BadContentDispositionHeader(builtins.RuntimeWarning) | Method resolution order: | BadContentDispositionHeader | builtins.RuntimeWarning | builtins.Warning | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.RuntimeWarning: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.RuntimeWarning: | | __new__(*args, **kwargs) class method of builtins.RuntimeWarning | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
aiohttp.BadContentDispositionParam
Python Library Documentation: class BadContentDispositionParam in module aiohttp.multipart class BadContentDispositionParam(builtins.RuntimeWarning) | Method resolution order: | BadContentDispositionParam | builtins.RuntimeWarning | builtins.Warning | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.RuntimeWarning: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.RuntimeWarning: | | __new__(*args, **kwargs) class method of builtins.RuntimeWarning | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
aiohttp.BaseConnector
Python Library Documentation: class BaseConnector in module aiohttp.connector
class BaseConnector(builtins.object)
| BaseConnector(*, keepalive_timeout: object | None | float = <_SENTINEL.sentinel: 1>, force_close: bool = False, limit: int = 100, limit_per_host: int = 0, enable_cleanup_closed: bool = False, loop: asyncio.events.AbstractEventLoop | None = None, timeout_ceil_threshold: float = 5) -> None
|
| Base connector class.
|
| keepalive_timeout - (optional) Keep-alive timeout.
| force_close - Set to True to force close and do reconnect
| after each request (and between redirects).
| limit - The total number of simultaneous connections.
| limit_per_host - Number of simultaneous connections to one host.
| enable_cleanup_closed - Enables clean-up closed ssl transports.
| Disabled by default.
| timeout_ceil_threshold - Trigger ceiling of timeout values when
| it's above timeout_ceil_threshold.
| loop - Optional event loop.
|
| Methods defined here:
|
| async __aenter__(self) -> 'BaseConnector'
|
| async __aexit__(self, exc_type: type[BaseException] | None = None, exc_value: BaseException | None = None, exc_traceback: traceback | None = None) -> None
|
| __del__(self, _warnings: Any = <module 'warnings' from 'C:\\Users\\Youse\\AppData\\Local\\Programs\\Python\\Python312\\Lib\\warnings.py'>) -> None
|
| __enter__(self) -> 'BaseConnector'
|
| __exit__(self, *exc: Any) -> None
|
| __init__(self, *, keepalive_timeout: object | None | float = <_SENTINEL.sentinel: 1>, force_close: bool = False, limit: int = 100, limit_per_host: int = 0, enable_cleanup_closed: bool = False, loop: asyncio.events.AbstractEventLoop | None = None, timeout_ceil_threshold: float = 5) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| close(self, *, abort_ssl: bool = False) -> collections.abc.Awaitable[None]
| Close all opened transports.
|
| :param abort_ssl: If True, SSL connections will be aborted immediately
| without performing the shutdown handshake. This provides
| faster cleanup at the cost of less graceful disconnection.
|
| async connect(self, req: aiohttp.client_reqrep.ClientRequest, traces: list['Trace'], timeout: 'ClientTimeout') -> aiohttp.connector.Connection
| Get from pool or create new connection.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| closed
| Is connector closed.
|
| A readonly property.
|
| force_close
| Ultimately close connection on releasing if True.
|
| limit
| The total number for simultaneous connections.
|
| If limit is 0 the connector has no limit.
| The default limit size is 100.
|
| limit_per_host
| The limit for simultaneous connections to the same endpoint.
|
| Endpoints are the same if they are have equal
| (host, port, is_ssl) triple.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| allowed_protocol_schema_set = frozenset({'', 'http', 'https', 'ws', 'w...
aiohttp.BasicAuth
Python Library Documentation: class BasicAuth in module aiohttp.helpers
class BasicAuth(BasicAuth)
| BasicAuth(login: str, password: str = '', encoding: str = 'latin1') -> 'BasicAuth'
|
| Http basic authentication helper.
|
| Method resolution order:
| BasicAuth
| BasicAuth
| builtins.tuple
| builtins.object
|
| Methods defined here:
|
| encode(self) -> str
| Encode credentials.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| decode(auth_header: str, encoding: str = 'latin1') -> 'BasicAuth'
| Create a BasicAuth object from an Authorization HTTP header.
|
| from_url(url: yarl.URL, *, encoding: str = 'latin1') -> Optional[ForwardRef('BasicAuth')]
| Create BasicAuth from url.
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(cls, login: str, password: str = '', encoding: str = 'latin1') -> 'BasicAuth'
| Create new instance of BasicAuth(login, password, encoding)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| ----------------------------------------------------------------------
| Methods inherited from BasicAuth:
|
| __getnewargs__(self) from collections.BasicAuth
| Return self as a plain tuple. Used by copy and pickle.
|
| __repr__(self) from collections.BasicAuth
| Return a nicely formatted representation string
|
| _asdict(self) from collections.BasicAuth
| Return a new dict which maps field names to their values.
|
| _replace(self, /, **kwds) from collections.BasicAuth
| Return a new BasicAuth object replacing specified fields with new values
|
| ----------------------------------------------------------------------
| Class methods inherited from BasicAuth:
|
| _make(iterable) from collections.BasicAuth
| Make a new BasicAuth object from a sequence or iterable
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BasicAuth:
|
| login
| Alias for field number 0
|
| password
| Alias for field number 1
|
| encoding
| Alias for field number 2
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from BasicAuth:
|
| __match_args__ = ('login', 'password', 'encoding')
|
| _field_defaults = {}
|
| _fields = ('login', 'password', 'encoding')
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.tuple:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.tuple:
|
| __class_getitem__(...)
| See PEP 585
aiohttp.BodyPartReader
Python Library Documentation: class BodyPartReader in module aiohttp.multipart class BodyPartReader(builtins.object) | BodyPartReader(boundary: bytes, headers: 'CIMultiDictProxy[str]', content: aiohttp.streams.StreamReader, *, subtype: str = 'mixed', default_charset: str | None = None, max_decompress_size: int = 262144, client_max_size: int = 9223372036854775807, max_size_error_cls: type[Exception] = <class 'ValueError'>) -> None | | Multipart reader for single body part. | | Methods defined here: | | __aiter__(self: Self) -> Self | | async __anext__(self) -> bytes | | __init__(self, boundary: bytes, headers: 'CIMultiDictProxy[str]', content: aiohttp.streams.StreamReader, *, subtype: str = 'mixed', default_charset: str | None = None, max_decompress_size: int = 262144, client_max_size: int = 9223372036854775807, max_size_error_cls: type[Exception] = <class 'ValueError'>) -> None | Initialize self. See help(type(self)) for accurate signature. | | at_eof(self) -> bool | Returns True if the boundary was reached or False otherwise. | | decode(self, data: ~_Buffer) -> Union[~_Buffer, bytes] | Decodes data synchronously. | | Decodes data according the specified Content-Encoding | or Content-Transfer-Encoding headers value. | | Note: For large payloads, consider using decode_iter() instead | to avoid blocking the event loop during decompression. | | async decode_iter(self, data: ~_Buffer) -> collections.abc.AsyncIterator[typing.Union[~_Buffer, bytes]] | Async generator that yields decoded data chunks. | | Decodes data according the specified Content-Encoding | or Content-Transfer-Encoding headers value. | | This method offloads decompression to an executor for large payloads | to avoid blocking the event loop. | | async form(self, *, encoding: str | None = None) -> list[tuple[str, str]] | Like read(), but assumes that body parts contain form urlencoded data. | | get_charset(self, default: str) -> str | Returns charset parameter from Content-Type header or default. | | async json(self, *, encoding: str | None = None) -> dict[str, typing.Any] | None | Like read(), but assumes that body parts contains JSON data. | | async next(self) -> bytes | None | | async read(self, *, decode: bool = False) -> bytes | Reads body part data. | | decode: Decodes data following by encoding | method from Content-Encoding header. If it missed | data remains untouched | | async read_chunk(self, size: int = 8192) -> bytes | Reads body part content chunk of the specified size. | | size: chunk size | | async readline(self) -> bytes | Reads body part by line by line. | | async release(self) -> None | Like read(), but reads all the data to the void. | | async text(self, *, encoding: str | None = None) -> str | Like read(), but assumes that body part contains text data. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | filename | Returns filename specified in Content-Disposition header. | | Returns None if the header is missing or malformed. | | name | Returns name specified in Content-Disposition header. | | If the header is missing or malformed, returns None. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | chunk_size = 8192
aiohttp.BufferedReaderPayload
Python Library Documentation: class BufferedReaderPayload in module aiohttp.payload
class BufferedReaderPayload(IOBasePayload)
| BufferedReaderPayload(value: IO[Any], disposition: str = 'attachment', *args: Any, **kwargs: Any) -> None
|
| Method resolution order:
| BufferedReaderPayload
| IOBasePayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| WARNING: This method does blocking I/O and should not be called in the event loop.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {'_value': <class 'io.BufferedIOBase'>}
|
| ----------------------------------------------------------------------
| Methods inherited from IOBasePayload:
|
| __init__(self, value: IO[Any], disposition: str = 'attachment', *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method reads the entire file content and returns it as bytes.
| It is equivalent to reading the file-like object directly.
| The file reading is performed in an executor to avoid blocking the event loop.
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire file-like payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire file content without any length constraint.
| It delegates to write_with_length() with no length limit for implementation
| consistency.
|
| Note:
| For new implementations that need length control, use write_with_length() directly.
| This method is maintained for backwards compatibility with existing code.
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write file-like payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method implements optimized streaming of file content with length constraints:
|
| 1. File reading is performed in a thread pool to avoid blocking the event loop
| 2. Content is read and written in chunks to maintain memory efficiency
| 3. Writing stops when either:
| - All available file content has been written (when size is known)
| - The specified content_length has been reached
| 4. File resources are properly closed even if the operation is cancelled
|
| The implementation carefully handles both known-size and unknown-size payloads,
| as well as constrained and unconstrained content lengths.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from IOBasePayload:
|
| size
| Size of the payload in bytes.
|
| Returns the total size of the payload content from the initial position.
| This ensures consistent Content-Length for requests, including 307/308 redirects
| where the same payload instance is reused.
|
| Returns None if the size cannot be determined (e.g., for unseekable streams).
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.BytesIOPayload
Python Library Documentation: class BytesIOPayload in module aiohttp.payload
class BytesIOPayload(IOBasePayload)
| BytesIOPayload(value: _io.BytesIO, *args: Any, **kwargs: Any) -> None
|
| Method resolution order:
| BytesIOPayload
| IOBasePayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: _io.BytesIO, *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method reads the entire BytesIO content and returns it as bytes.
| It is equivalent to accessing the _value attribute directly.
|
| async close(self) -> None
| Close the BytesIO payload.
|
| This does nothing since BytesIO is in-memory and does not require explicit closing.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| WARNING: This method does blocking I/O and should not be called in the event loop.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire file-like payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire file content without any length constraint.
| It delegates to write_with_length() with no length limit for implementation
| consistency.
|
| Note:
| For new implementations that need length control, use write_with_length() directly.
| This method is maintained for backwards compatibility with existing code.
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write BytesIO payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This implementation is specifically optimized for BytesIO objects:
|
| 1. Reads content in chunks to maintain memory efficiency
| 2. Yields control back to the event loop periodically to prevent blocking
| when dealing with large BytesIO objects
| 3. Respects content_length constraints when specified
| 4. Properly cleans up by closing the BytesIO object when done or on error
|
| The periodic yielding to the event loop is important for maintaining
| responsiveness when processing large in-memory buffers.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| size
| Size of the payload in bytes.
|
| Returns the number of bytes in the BytesIO buffer that will be transmitted.
| This is calculated once during initialization for efficiency.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {'_size': <class 'int'>, '_value': <class '_io.Bytes...
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.BytesPayload
Python Library Documentation: class BytesPayload in module aiohttp.payload
class BytesPayload(Payload)
| BytesPayload(value: bytes | bytearray | memoryview, *args: Any, **kwargs: Any) -> None
|
| Method resolution order:
| BytesPayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: bytes | bytearray | memoryview, *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method returns the raw bytes content of the payload.
| It is equivalent to accessing the _value attribute directly.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| This is named decode() to allow compatibility with bytes objects.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire bytes payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire bytes content without any length constraint.
|
| Note:
| For new implementations that need length control, use write_with_length().
| This method is maintained for backwards compatibility and is equivalent
| to write_with_length(writer, None).
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write bytes payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method writes either the entire byte sequence or a slice of it
| up to the specified content_length. For BytesPayload, this operation
| is performed efficiently using array slicing.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {'_value': <class 'bytes'>}
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| In the future, this will be the only close method supported.
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| size
| Size of the payload in bytes.
|
| Returns the number of bytes that will be transmitted when the payload
| is written. For string payloads, this is the size after encoding to bytes,
| not the length of the string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.ChainMapProxy
Python Library Documentation: class ChainMapProxy in module aiohttp.helpers class ChainMapProxy(collections.abc.Mapping) | ChainMapProxy(maps: collections.abc.Iterable[collections.abc.Mapping[typing.Union[str, aiohttp.helpers.AppKey[typing.Any]], typing.Any]]) -> None | | Method resolution order: | ChainMapProxy | collections.abc.Mapping | collections.abc.Collection | collections.abc.Sized | collections.abc.Iterable | collections.abc.Container | builtins.object | | Methods defined here: | | __bool__(self) -> bool | | __contains__(self, key: object) -> bool | | __getitem__(self, key: Union[str, aiohttp.helpers.AppKey[~_T]]) -> Any | | __init__(self, maps: collections.abc.Iterable[collections.abc.Mapping[typing.Union[str, aiohttp.helpers.AppKey[typing.Any]], typing.Any]]) -> None | Initialize self. See help(type(self)) for accurate signature. | | __iter__(self) -> collections.abc.Iterator[typing.Union[str, aiohttp.helpers.AppKey[typing.Any]]] | | __len__(self) -> int | | __repr__(self) -> str | Return repr(self). | | get(self, key: Union[str, aiohttp.helpers.AppKey[~_T]], default: Any = None) -> Any | D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None. | | ---------------------------------------------------------------------- | Class methods defined here: | | __init_subclass__() -> None | This method is called when a class is subclassed. | | The default implementation does nothing. It may be | overridden to extend subclasses. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __abstractmethods__ = frozenset() | | __orig_bases__ = (collections.abc.Mapping[typing.Union[str, aiohttp.he... | | ---------------------------------------------------------------------- | Methods inherited from collections.abc.Mapping: | | __eq__(self, other) | Return self==value. | | items(self) | D.items() -> a set-like object providing a view on D's items | | keys(self) | D.keys() -> a set-like object providing a view on D's keys | | values(self) | D.values() -> an object providing a view on D's values | | ---------------------------------------------------------------------- | Data and other attributes inherited from collections.abc.Mapping: | | __hash__ = None | | __reversed__ = None | | ---------------------------------------------------------------------- | Class methods inherited from collections.abc.Collection: | | __subclasshook__(C) | Abstract classes can override this to customize issubclass(). | | This is invoked early on by abc.ABCMeta.__subclasscheck__(). | It should return True, False or NotImplemented. If it returns | NotImplemented, the normal algorithm is used. Otherwise, it | overrides the normal algorithm (and the outcome is cached). | | ---------------------------------------------------------------------- | Class methods inherited from collections.abc.Iterable: | | __class_getitem__ = GenericAlias(...) | Represent a PEP 585 generic type | | E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
aiohttp.ClientConnectionError
Python Library Documentation: class ClientConnectionError in module aiohttp.client_exceptions class ClientConnectionError(ClientError) | Base class for client socket errors. | | Method resolution order: | ClientConnectionError | ClientError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from ClientError: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
aiohttp.ClientConnectionResetError
Python Library Documentation: class ClientConnectionResetError in module aiohttp.client_exceptions class ClientConnectionResetError(ClientConnectionError, builtins.ConnectionResetError) | ConnectionResetError | | Method resolution order: | ClientConnectionResetError | ClientConnectionError | ClientError | builtins.ConnectionResetError | builtins.ConnectionError | builtins.OSError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.ConnectionResetError: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.OSError: | | __reduce__(...) | Helper for pickle. | | __str__(self, /) | Return str(self). | | ---------------------------------------------------------------------- | Static methods inherited from builtins.OSError: | | __new__(*args, **kwargs) class method of builtins.OSError | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.OSError: | | characters_written | | errno | POSIX exception code | | filename | exception filename | | filename2 | second exception filename | | strerror | exception strerror | | winerror | Win32 exception code | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
aiohttp.ClientConnectorCertificateError
Python Library Documentation: class ClientConnectorCertificateError in module aiohttp.client_exceptions
class ClientConnectorCertificateError(ClientSSLError, ssl.SSLCertVerificationError)
| ClientConnectorCertificateError(connection_key: None, certificate_error: Exception) -> None
|
| Response certificate error.
|
| Method resolution order:
| ClientConnectorCertificateError
| ClientSSLError
| ClientConnectorError
| ClientOSError
| ClientConnectionError
| ClientError
| ssl.SSLCertVerificationError
| ssl.SSLError
| builtins.OSError
| builtins.ValueError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, connection_key: None, certificate_error: Exception) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| certificate_error
|
| host
|
| port
|
| ssl
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'_conn_key': None}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientConnectorError:
|
| __reduce__(...) from builtins.BaseException
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from ClientConnectorError:
|
| os_error
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientOSError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientConnectorDNSError
Python Library Documentation: class ClientConnectorDNSError in module aiohttp.client_exceptions
class ClientConnectorDNSError(ClientConnectorError)
| ClientConnectorDNSError(connection_key: None, os_error: OSError) -> None
|
| DNS resolution failed during client connection.
|
| Raised in :class:`aiohttp.connector.TCPConnector` if
| DNS resolution fails.
|
| Method resolution order:
| ClientConnectorDNSError
| ClientConnectorError
| ClientOSError
| ClientConnectionError
| ClientError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientConnectorError:
|
| __init__(self, connection_key: None, os_error: OSError) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...) from builtins.BaseException
| Helper for pickle.
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from ClientConnectorError:
|
| host
|
| os_error
|
| port
|
| ssl
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientOSError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientConnectorError
Python Library Documentation: class ClientConnectorError in module aiohttp.client_exceptions
class ClientConnectorError(ClientOSError)
| ClientConnectorError(connection_key: None, os_error: OSError) -> None
|
| Client connector error.
|
| Raised in :class:`aiohttp.connector.TCPConnector` if
| a connection can not be established.
|
| Method resolution order:
| ClientConnectorError
| ClientOSError
| ClientConnectionError
| ClientError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, connection_key: None, os_error: OSError) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...) from builtins.BaseException
| Helper for pickle.
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| host
|
| os_error
|
| port
|
| ssl
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientOSError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientConnectorSSLError
Python Library Documentation: class ClientConnectorSSLError in module aiohttp.client_exceptions
class ClientConnectorSSLError(ClientSSLError, ssl.SSLError)
| ClientConnectorSSLError(connection_key: None, os_error: OSError) -> None
|
| Response ssl error.
|
| Method resolution order:
| ClientConnectorSSLError
| ClientSSLError
| ClientConnectorError
| ClientOSError
| ClientConnectionError
| ClientError
| ssl.SSLError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientConnectorError:
|
| __init__(self, connection_key: None, os_error: OSError) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...) from builtins.BaseException
| Helper for pickle.
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from ClientConnectorError:
|
| host
|
| os_error
|
| port
|
| ssl
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientOSError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientError
Python Library Documentation: class ClientError in module aiohttp.client_exceptions
class ClientError(builtins.Exception)
| Base class for client connection errors.
|
| Method resolution order:
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientHandlerType
Python Library Documentation: _CallableGenericAlias in module collections.abc
class Callable(builtins.object)
| Methods defined here:
|
| __call__(self, *args, **kwds)
| Call self as a function.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__ = _CallableGenericAlias(args)
| Represent `Callable[argtypes, resulttype]`.
|
| This sets ``__args__`` to a tuple containing the flattened ``argtypes``
| followed by ``resulttype``.
|
| Example: ``Callable[[int, str], float]`` sets ``__args__`` to
| ``(int, str, float)``.
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset({'__call__'})
aiohttp.ClientHttpProxyError
Python Library Documentation: class ClientHttpProxyError in module aiohttp.client_exceptions
class ClientHttpProxyError(ClientResponseError)
| ClientHttpProxyError(request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
|
| HTTP proxy error.
|
| Raised in :class:`aiohttp.connector.TCPConnector` if
| proxy responds with status other than ``200 OK``
| on ``CONNECT`` request.
|
| Method resolution order:
| ClientHttpProxyError
| ClientResponseError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientResponseError:
|
| __init__(self, request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientResponseError:
|
| code
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientMiddlewareType
Python Library Documentation: _CallableGenericAlias in module collections.abc
class Callable(builtins.object)
| Methods defined here:
|
| __call__(self, *args, **kwds)
| Call self as a function.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__ = _CallableGenericAlias(args)
| Represent `Callable[argtypes, resulttype]`.
|
| This sets ``__args__`` to a tuple containing the flattened ``argtypes``
| followed by ``resulttype``.
|
| Example: ``Callable[[int, str], float]`` sets ``__args__`` to
| ``(int, str, float)``.
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset({'__call__'})
aiohttp.ClientOSError
Python Library Documentation: class ClientOSError in module aiohttp.client_exceptions
class ClientOSError(ClientConnectionError, builtins.OSError)
| OSError error.
|
| Method resolution order:
| ClientOSError
| ClientConnectionError
| ClientError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.OSError:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientPayloadError
Python Library Documentation: class ClientPayloadError in module aiohttp.client_exceptions
class ClientPayloadError(ClientError)
| Response payload error.
|
| Method resolution order:
| ClientPayloadError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientProxyConnectionError
Python Library Documentation: class ClientProxyConnectionError in module aiohttp.client_exceptions
class ClientProxyConnectionError(ClientConnectorError)
| ClientProxyConnectionError(connection_key: None, os_error: OSError) -> None
|
| Proxy connection error.
|
| Raised in :class:`aiohttp.connector.TCPConnector` if
| connection to proxy can not be established.
|
| Method resolution order:
| ClientProxyConnectionError
| ClientConnectorError
| ClientOSError
| ClientConnectionError
| ClientError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientConnectorError:
|
| __init__(self, connection_key: None, os_error: OSError) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...) from builtins.BaseException
| Helper for pickle.
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from ClientConnectorError:
|
| host
|
| os_error
|
| port
|
| ssl
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientOSError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientRequest
Python Library Documentation: class ClientRequest in module aiohttp.client_reqrep
class ClientRequest(builtins.object)
| ClientRequest(method: str, url: yarl.URL, *, params: Union[NoneType, str, collections.abc.Mapping[str, Union[str, SupportsInt, float, collections.abc.Sequence[Union[str, SupportsInt, float]]]], collections.abc.Sequence[tuple[str, Union[str, SupportsInt, float, collections.abc.Sequence[Union[str, SupportsInt, float]]]]]] = None, headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, skip_auto_headers: collections.abc.Iterable[str] | None = None, data: Any = None, cookies: Union[collections.abc.Mapping[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]], collections.abc.Iterable[tuple[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]]], ForwardRef('BaseCookie[str]'), NoneType] = None, auth: aiohttp.helpers.BasicAuth | None = None, version: aiohttp.http_writer.HttpVersion = HttpVersion(major=1, minor=1), compress: str | bool | None = None, chunked: bool | None = None, expect100: bool = False, loop: asyncio.events.AbstractEventLoop | None = None, response_class: type['ClientResponse'] | None = None, proxy: yarl.URL | None = None, proxy_auth: aiohttp.helpers.BasicAuth | None = None, timer: aiohttp.helpers.BaseTimerContext | None = None, session: Optional[ForwardRef('ClientSession')] = None, ssl: ssl.SSLContext | bool | aiohttp.client_reqrep.Fingerprint = True, proxy_headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, traces: list['Trace'] | None = None, trust_env: bool = False, server_hostname: str | None = None)
|
| Methods defined here:
|
| __init__(self, method: str, url: yarl.URL, *, params: Union[NoneType, str, collections.abc.Mapping[str, Union[str, SupportsInt, float, collections.abc.Sequence[Union[str, SupportsInt, float]]]], collections.abc.Sequence[tuple[str, Union[str, SupportsInt, float, collections.abc.Sequence[Union[str, SupportsInt, float]]]]]] = None, headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, skip_auto_headers: collections.abc.Iterable[str] | None = None, data: Any = None, cookies: Union[collections.abc.Mapping[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]], collections.abc.Iterable[tuple[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]]], ForwardRef('BaseCookie[str]'), NoneType] = None, auth: aiohttp.helpers.BasicAuth | None = None, version: aiohttp.http_writer.HttpVersion = HttpVersion(major=1, minor=1), compress: str | bool | None = None, chunked: bool | None = None, expect100: bool = False, loop: asyncio.events.AbstractEventLoop | None = None, response_class: type['ClientResponse'] | None = None, proxy: yarl.URL | None = None, proxy_auth: aiohttp.helpers.BasicAuth | None = None, timer: aiohttp.helpers.BaseTimerContext | None = None, session: Optional[ForwardRef('ClientSession')] = None, ssl: ssl.SSLContext | bool | aiohttp.client_reqrep.Fingerprint = True, proxy_headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, traces: list['Trace'] | None = None, trust_env: bool = False, server_hostname: str | None = None)
| Initialize self. See help(type(self)) for accurate signature.
|
| async close(self) -> None
|
| is_ssl(self) -> bool
|
| async send(self, conn: 'Connection') -> 'ClientResponse'
|
| terminate(self) -> None
|
| update_auth(self, auth: aiohttp.helpers.BasicAuth | None, trust_env: bool = False) -> None
| Set basic auth.
|
| update_auto_headers(self, skip_auto_headers: collections.abc.Iterable[str] | None) -> None
|
| async update_body(self, body: Any) -> None
| Update request body and close previous payload if needed.
|
| This method safely updates the request body by first closing any existing
| payload to prevent resource leaks, then setting the new body.
|
| IMPORTANT: Always use this method instead of setting request.body directly.
| Direct assignment to request.body will leak resources if the previous body
| contains file handles, streams, or other resources that need cleanup.
|
| Args:
| body: The new body content. Can be:
| - bytes/bytearray: Raw binary data
| - str: Text data (will be encoded using charset from Content-Type)
| - FormData: Form data that will be encoded as multipart/form-data
| - Payload: A pre-configured payload object
| - AsyncIterable: An async iterable of bytes chunks
| - File-like object: Will be read and sent as binary data
| - None: Clears the body
|
| Usage:
| # CORRECT: Use update_body
| await request.update_body(b"new request data")
|
| # WRONG: Don't set body directly
| # request.body = b"new request data" # This will leak resources!
|
| # Update with form data
| form_data = FormData()
| form_data.add_field('field', 'value')
| await request.update_body(form_data)
|
| # Clear body
| await request.update_body(None)
|
| Note:
| This method is async because it may need to close file handles or
| other resources associated with the previous payload. Always await
| this method to ensure proper cleanup.
|
| Warning:
| Setting request.body directly is highly discouraged and can lead to:
| - Resource leaks (unclosed file handles, streams)
| - Memory leaks (unreleased buffers)
| - Unexpected behavior with streaming payloads
|
| It is not recommended to change the payload type in middleware. If the
| body was already set (e.g., as bytes), it's best to keep the same type
| rather than converting it (e.g., to str) as this may result in unexpected
| behavior.
|
| See Also:
| - update_body_from_data: Synchronous body update without cleanup
| - body property: Direct body access (STRONGLY DISCOURAGED)
|
| update_body_from_data(self, body: Any, _stacklevel: int = 3) -> None
| Update request body from data.
|
| update_content_encoding(self, data: Any) -> None
| Set request content encoding.
|
| update_cookies(self, cookies: Union[collections.abc.Mapping[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]], collections.abc.Iterable[tuple[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]]], ForwardRef('BaseCookie[str]'), NoneType]) -> None
| Update request cookies header.
|
| update_expect_continue(self, expect: bool = False) -> None
|
| update_headers(self, headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType]) -> None
| Update request headers.
|
| update_host(self, url: yarl.URL) -> None
| Update destination host, port and connection type (ssl).
|
| update_proxy(self, proxy: yarl.URL | None, proxy_auth: aiohttp.helpers.BasicAuth | None, proxy_headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType]) -> None
|
| update_transfer_encoding(self) -> None
| Analyze transfer-encoding header.
|
| update_version(self, version: aiohttp.http_writer.HttpVersion | str) -> None
| Convert request version to two elements tuple.
|
| parser HTTP version '1.1' => (1, 1)
|
| async write_bytes(self, writer: aiohttp.abc.AbstractStreamWriter, conn: 'Connection', content_length: int | None = None) -> None
| Write the request body to the connection stream.
|
| This method handles writing different types of request bodies:
| 1. Payload objects (using their specialized write_with_length method)
| 2. Bytes/bytearray objects
| 3. Iterable body content
|
| Args:
| writer: The stream writer to write the body to
| conn: The connection being used for this request
| content_length: Optional maximum number of bytes to write from the body
| (None means write the entire body)
|
| The method properly handles:
| - Waiting for 100-Continue responses if required
| - Content length constraints for chunked encoding
| - Error handling for network issues, cancellation, and other exceptions
| - Signaling EOF and timeout management
|
| Raises:
| ClientOSError: When there's an OS-level error writing the body
| ClientConnectionError: When there's a general connection error
| asyncio.CancelledError: When the operation is cancelled
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| connection_key
|
| host
|
| port
|
| request_info
|
| session
| Return the ClientSession instance.
|
| This property provides access to the ClientSession that initiated
| this request, allowing middleware to make additional requests
| using the same session.
|
| skip_auto_headers
|
| ssl
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| body
| Request body.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| ALL_METHODS = {'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', .....
|
| DEFAULT_HEADERS = {'Accept': '*/*', 'Accept-Encoding': 'gzip, deflate'...
|
| GET_METHODS = {'GET', 'HEAD', 'OPTIONS', 'TRACE'}
|
| POST_METHODS = {'PATCH', 'POST', 'PUT'}
|
| __annotations__ = {'_ClientRequest__writer': typing.Optional[ForwardRe...
|
| auth = None
|
| method = 'GET'
|
| response = None
|
| url = URL('')
aiohttp.ClientResponse
Python Library Documentation: class ClientResponse in module aiohttp.client_reqrep
class ClientResponse(aiohttp.helpers.HeadersMixin)
| ClientResponse(method: str, url: yarl.URL, *, writer: 'asyncio.Task[None] | None', continue100: Optional[ForwardRef('asyncio.Future[bool]')], timer: aiohttp.helpers.BaseTimerContext, request_info: aiohttp.client_reqrep.RequestInfo, traces: list['Trace'], loop: asyncio.events.AbstractEventLoop, session: 'ClientSession', stream_writer: aiohttp.abc.AbstractStreamWriter) -> None
|
| Method resolution order:
| ClientResponse
| aiohttp.helpers.HeadersMixin
| builtins.object
|
| Methods defined here:
|
| async __aenter__(self) -> 'ClientResponse'
|
| async __aexit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: traceback | None) -> None
|
| __del__(self, _warnings: Any = <module 'warnings' from 'C:\\Users\\Youse\\AppData\\Local\\Programs\\Python\\Python312\\Lib\\warnings.py'>) -> None
|
| __init__(self, method: str, url: yarl.URL, *, writer: 'asyncio.Task[None] | None', continue100: Optional[ForwardRef('asyncio.Future[bool]')], timer: aiohttp.helpers.BaseTimerContext, request_info: aiohttp.client_reqrep.RequestInfo, traces: list['Trace'], loop: asyncio.events.AbstractEventLoop, session: 'ClientSession', stream_writer: aiohttp.abc.AbstractStreamWriter) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| close(self) -> None
|
| get_encoding(self) -> str
|
| async json(self, *, encoding: str | None = None, loads: collections.abc.Callable[[str], typing.Any] = <function loads at 0x0000022698C144A0>, content_type: str | None = 'application/json') -> Any
| Read and decodes JSON response.
|
| raise_for_status(self) -> None
|
| async read(self) -> bytes
| Read response payload.
|
| release(self) -> Any
|
| async start(self, connection: 'Connection') -> 'ClientResponse'
| Start response processing.
|
| async text(self, encoding: str | None = None, errors: str = 'strict') -> str
| Read response payload and decode.
|
| async wait_for_close(self) -> None
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| closed
|
| connection
|
| ok
| Returns ``True`` if ``status`` is less than ``400``, ``False`` if not.
|
| This is **not** a check for ``200 OK`` but a check that the response
| status is under 400.
|
| output_size
| Number of bytes sent for this request.
|
| upload_complete
| Future set when the request body has been fully sent.
|
| Already done when the request had no body or was written eagerly.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| content_disposition
|
| cookies
|
| headers
|
| history
| A sequence of of responses, if redirects occurred.
|
| host
|
| links
|
| raw_headers
|
| real_url
|
| request_info
|
| url
|
| url_obj
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'_ClientResponse__writer': typing.Optional[ForwardR...
|
| content = None
|
| reason = None
|
| status = None
|
| version = None
|
| ----------------------------------------------------------------------
| Readonly properties inherited from aiohttp.helpers.HeadersMixin:
|
| charset
| The value of charset part for Content-Type HTTP header.
|
| content_length
| The value of Content-Length HTTP header.
|
| content_type
| The value of content part for Content-Type HTTP header.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from aiohttp.helpers.HeadersMixin:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from aiohttp.helpers.HeadersMixin:
|
| ATTRS = frozenset({'_content_dict', '_content_type', '_stored_content_...
aiohttp.ClientResponseError
Python Library Documentation: class ClientResponseError in module aiohttp.client_exceptions
class ClientResponseError(ClientError)
| ClientResponseError(request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
|
| Base class for exceptions that occur after getting a response.
|
| request_info: An instance of RequestInfo.
| history: A sequence of responses, if redirects occurred.
| status: HTTP status code.
| message: Error message.
| headers: Response headers.
|
| Method resolution order:
| ClientResponseError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| code
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientSSLError
Python Library Documentation: class ClientSSLError in module aiohttp.client_exceptions
class ClientSSLError(ClientConnectorError)
| ClientSSLError(connection_key: None, os_error: OSError) -> None
|
| Base error for ssl.*Errors.
|
| Method resolution order:
| ClientSSLError
| ClientConnectorError
| ClientOSError
| ClientConnectionError
| ClientError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientConnectorError:
|
| __init__(self, connection_key: None, os_error: OSError) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce__(...) from builtins.BaseException
| Helper for pickle.
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from ClientConnectorError:
|
| host
|
| os_error
|
| port
|
| ssl
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientOSError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ClientSession
Python Library Documentation: class ClientSession in module aiohttp.client
class ClientSession(builtins.object)
| ClientSession(base_url: Union[str, yarl.URL, NoneType] = None, *, connector: aiohttp.connector.BaseConnector | None = None, loop: asyncio.events.AbstractEventLoop | None = None, cookies: Union[collections.abc.Mapping[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]], collections.abc.Iterable[tuple[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]]], ForwardRef('BaseCookie[str]'), NoneType] = None, headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, proxy: Union[str, yarl.URL, NoneType] = None, proxy_auth: aiohttp.helpers.BasicAuth | None = None, skip_auto_headers: collections.abc.Iterable[str] | None = None, auth: aiohttp.helpers.BasicAuth | None = None, json_serialize: collections.abc.Callable[[typing.Any], str] = <function dumps at 0x0000022698C03740>, json_serialize_bytes: collections.abc.Callable[[typing.Any], bytes] | None = None, request_class: type[aiohttp.client_reqrep.ClientRequest] = <class 'aiohttp.client_reqrep.ClientRequest'>, response_class: type[aiohttp.client_reqrep.ClientResponse] = <class 'aiohttp.client_reqrep.ClientResponse'>, ws_response_class: type[aiohttp.client_ws.ClientWebSocketResponse] = <class 'aiohttp.client_ws.ClientWebSocketResponse'>, version: aiohttp.http_writer.HttpVersion = HttpVersion(major=1, minor=1), cookie_jar: aiohttp.abc.AbstractCookieJar | None = None, connector_owner: bool = True, raise_for_status: bool | collections.abc.Callable[[aiohttp.client_reqrep.ClientResponse], collections.abc.Awaitable[None]] = False, read_timeout: float | aiohttp.helpers._SENTINEL = <_SENTINEL.sentinel: 1>, conn_timeout: float | None = None, timeout: object | aiohttp.client.ClientTimeout = <_SENTINEL.sentinel: 1>, auto_decompress: bool = True, trust_env: bool = False, requote_redirect_url: bool = True, trace_configs: list[aiohttp.tracing.TraceConfig] | None = None, read_bufsize: int = 262144, max_line_size: int = 8190, max_field_size: int = 8190, max_headers: int = 128, fallback_charset_resolver: collections.abc.Callable[[aiohttp.client_reqrep.ClientResponse, bytes], str] = <function ClientSession.<lambda> at 0x000002269992ACA0>, middlewares: collections.abc.Sequence[collections.abc.Callable[[aiohttp.client_reqrep.ClientRequest, collections.abc.Callable[[aiohttp.client_reqrep.ClientRequest], collections.abc.Awaitable[aiohttp.client_reqrep.ClientResponse]]], collections.abc.Awaitable[aiohttp.client_reqrep.ClientResponse]]] = (), ssl_shutdown_timeout: aiohttp.helpers._SENTINEL | None | float = <_SENTINEL.sentinel: 1>) -> None
|
| First-class interface for making HTTP requests.
|
| Methods defined here:
|
| async __aenter__(self) -> 'ClientSession'
|
| async __aexit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: traceback | None) -> None
|
| __del__(self, _warnings: Any = <module 'warnings' from 'C:\\Users\\Youse\\AppData\\Local\\Programs\\Python\\Python312\\Lib\\warnings.py'>) -> None
|
| __enter__(self) -> None
|
| __exit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: traceback | None) -> None
|
| __init__(self, base_url: Union[str, yarl.URL, NoneType] = None, *, connector: aiohttp.connector.BaseConnector | None = None, loop: asyncio.events.AbstractEventLoop | None = None, cookies: Union[collections.abc.Mapping[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]], collections.abc.Iterable[tuple[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]]], ForwardRef('BaseCookie[str]'), NoneType] = None, headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, proxy: Union[str, yarl.URL, NoneType] = None, proxy_auth: aiohttp.helpers.BasicAuth | None = None, skip_auto_headers: collections.abc.Iterable[str] | None = None, auth: aiohttp.helpers.BasicAuth | None = None, json_serialize: collections.abc.Callable[[typing.Any], str] = <function dumps at 0x0000022698C03740>, json_serialize_bytes: collections.abc.Callable[[typing.Any], bytes] | None = None, request_class: type[aiohttp.client_reqrep.ClientRequest] = <class 'aiohttp.client_reqrep.ClientRequest'>, response_class: type[aiohttp.client_reqrep.ClientResponse] = <class 'aiohttp.client_reqrep.ClientResponse'>, ws_response_class: type[aiohttp.client_ws.ClientWebSocketResponse] = <class 'aiohttp.client_ws.ClientWebSocketResponse'>, version: aiohttp.http_writer.HttpVersion = HttpVersion(major=1, minor=1), cookie_jar: aiohttp.abc.AbstractCookieJar | None = None, connector_owner: bool = True, raise_for_status: bool | collections.abc.Callable[[aiohttp.client_reqrep.ClientResponse], collections.abc.Awaitable[None]] = False, read_timeout: float | aiohttp.helpers._SENTINEL = <_SENTINEL.sentinel: 1>, conn_timeout: float | None = None, timeout: object | aiohttp.client.ClientTimeout = <_SENTINEL.sentinel: 1>, auto_decompress: bool = True, trust_env: bool = False, requote_redirect_url: bool = True, trace_configs: list[aiohttp.tracing.TraceConfig] | None = None, read_bufsize: int = 262144, max_line_size: int = 8190, max_field_size: int = 8190, max_headers: int = 128, fallback_charset_resolver: collections.abc.Callable[[aiohttp.client_reqrep.ClientResponse, bytes], str] = <function ClientSession.<lambda> at 0x000002269992ACA0>, middlewares: collections.abc.Sequence[collections.abc.Callable[[aiohttp.client_reqrep.ClientRequest, collections.abc.Callable[[aiohttp.client_reqrep.ClientRequest], collections.abc.Awaitable[aiohttp.client_reqrep.ClientResponse]]], collections.abc.Awaitable[aiohttp.client_reqrep.ClientResponse]]] = (), ssl_shutdown_timeout: aiohttp.helpers._SENTINEL | None | float = <_SENTINEL.sentinel: 1>) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async close(self) -> None
| Close underlying connector.
|
| Release all acquired resources.
|
| delete(self, url: Union[str, yarl.URL], **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP DELETE request.
|
| detach(self) -> None
| Detach connector from session without closing the former.
|
| Session is switched to closed state anyway.
|
| get(self, url: Union[str, yarl.URL], *, allow_redirects: bool = True, **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP GET request.
|
| head(self, url: Union[str, yarl.URL], *, allow_redirects: bool = False, **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP HEAD request.
|
| options(self, url: Union[str, yarl.URL], *, allow_redirects: bool = True, **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP OPTIONS request.
|
| patch(self, url: Union[str, yarl.URL], *, data: Any = None, **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP PATCH request.
|
| post(self, url: Union[str, yarl.URL], *, data: Any = None, **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP POST request.
|
| put(self, url: Union[str, yarl.URL], *, data: Any = None, **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP PUT request.
|
| request(self, method: str, url: Union[str, yarl.URL], **kwargs: Any) -> '_RequestContextManager'
| Perform HTTP request.
|
| ws_connect(self, url: Union[str, yarl.URL], *, method: str = 'GET', protocols: collections.abc.Iterable[str] = (), timeout: aiohttp.client_ws.ClientWSTimeout | aiohttp.helpers._SENTINEL = <_SENTINEL.sentinel: 1>, receive_timeout: float | None = None, autoclose: bool = True, autoping: bool = True, heartbeat: float | None = None, auth: aiohttp.helpers.BasicAuth | None = None, origin: str | None = None, params: Union[NoneType, str, collections.abc.Mapping[str, Union[str, SupportsInt, float, collections.abc.Sequence[Union[str, SupportsInt, float]]]], collections.abc.Sequence[tuple[str, Union[str, SupportsInt, float, collections.abc.Sequence[Union[str, SupportsInt, float]]]]]] = None, headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, proxy: Union[str, yarl.URL, NoneType] = None, proxy_auth: aiohttp.helpers.BasicAuth | None = None, ssl: typing.Any | bool | aiohttp.client_reqrep.Fingerprint = True, verify_ssl: bool | None = None, fingerprint: bytes | None = None, ssl_context: typing.Any | None = None, server_hostname: str | None = None, proxy_headers: Union[collections.abc.Mapping[str, str], collections.abc.Mapping[multidict._multidict.istr, str], multidict._multidict.CIMultiDict, multidict._multidict.CIMultiDictProxy, collections.abc.Iterable[tuple[str | multidict._multidict.istr, str]], NoneType] = None, compress: int = 0, max_msg_size: int = 4194304, decode_text: bool = True) -> '_BaseRequestContextManager[ClientWebSocketResponse[bool]]'
| Initiate websocket connection.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __init_subclass__() -> None
| This method is called when a class is subclassed.
|
| The default implementation does nothing. It may be
| overridden to extend subclasses.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| auth
| An object that represents HTTP Basic Authorization
|
| auto_decompress
| Should the body response be automatically decompressed.
|
| closed
| Is client session closed.
|
| A readonly property.
|
| connector
| Connector instance used for the session.
|
| connector_owner
| Should connector be closed on session closing
|
| cookie_jar
| The session cookies.
|
| headers
| The default headers of the client session.
|
| json_serialize
| Json serializer callable
|
| loop
| Session's loop.
|
| raise_for_status
| Should `ClientResponse.raise_for_status()` be called for each response.
|
| skip_auto_headers
| Headers for which autogeneration should be skipped
|
| timeout
| Timeout for the session.
|
| trace_configs
| A list of TraceConfig instances used for client tracing
|
| trust_env
| Should proxies information from environment or netrc be trusted.
|
| Information is from HTTP_PROXY / HTTPS_PROXY environment variables
| or ~/.netrc file if present.
|
| version
| The session HTTP protocol version.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| requote_redirect_url
| Do URL requoting on redirection handling.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| ATTRS = frozenset({'_auto_decompress', '_base_url', '_base_url_origin'...
|
| __annotations__ = {'_connector': aiohttp.connector.BaseConnector | Non...
aiohttp.ClientTimeout
Python Library Documentation: class ClientTimeout in module aiohttp.client
class ClientTimeout(builtins.object)
| ClientTimeout(total: float | None = None, connect: float | None = None, sock_read: float | None = None, sock_connect: float | None = None, ceil_threshold: float = 5) -> None
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class ClientTimeout.
|
| __ge__(self, other)
| Method generated by attrs for class ClientTimeout.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class ClientTimeout.
|
| __hash__(self)
| Method generated by attrs for class ClientTimeout.
|
| __init__(self, total: float | None = None, connect: float | None = None, sock_read: float | None = None, sock_connect: float | None = None, ceil_threshold: float = 5) -> None
| Method generated by attrs for class ClientTimeout.
|
| __le__(self, other)
| Method generated by attrs for class ClientTimeout.
|
| __lt__(self, other)
| Method generated by attrs for class ClientTimeout.
|
| __ne__(self, other)
| Method generated by attrs for class ClientTimeout.
|
| __repr__(self)
| Method generated by attrs for class ClientTimeout.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ceil_threshold
|
| connect
|
| sock_connect
|
| sock_read
|
| total
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'ceil_threshold': <class 'float'>, 'connect': float...
|
| __attrs_attrs__ = (Attribute(name='total', default=None, validator...=...
|
| __match_args__ = ('total', 'connect', 'sock_read', 'sock_connect', 'ce...
aiohttp.ClientWSTimeout
Python Library Documentation: class ClientWSTimeout in module aiohttp.client_ws
class ClientWSTimeout(builtins.object)
| ClientWSTimeout(ws_receive: Optional[float] = None, ws_close: Optional[float] = None) -> None
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class ClientWSTimeout.
|
| __ge__(self, other)
| Method generated by attrs for class ClientWSTimeout.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class ClientWSTimeout.
|
| __hash__(self)
| Method generated by attrs for class ClientWSTimeout.
|
| __init__(self, ws_receive: Optional[float] = None, ws_close: Optional[float] = None) -> None
| Method generated by attrs for class ClientWSTimeout.
|
| __le__(self, other)
| Method generated by attrs for class ClientWSTimeout.
|
| __lt__(self, other)
| Method generated by attrs for class ClientWSTimeout.
|
| __ne__(self, other)
| Method generated by attrs for class ClientWSTimeout.
|
| __repr__(self)
| Method generated by attrs for class ClientWSTimeout.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ws_close
|
| ws_receive
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __attrs_attrs__ = (Attribute(name='ws_receive', default=None, vali...e...
|
| __match_args__ = ('ws_receive', 'ws_close')
aiohttp.ClientWebSocketResponse
Python Library Documentation: class ClientWebSocketResponse in module aiohttp.client_ws class ClientWebSocketResponse(typing.Generic) | ClientWebSocketResponse(reader: aiohttp._websocket.reader_c.WebSocketDataQueue, writer: aiohttp._websocket.writer.WebSocketWriter, protocol: str | None, response: aiohttp.client_reqrep.ClientResponse, timeout: aiohttp.client_ws.ClientWSTimeout, autoclose: bool, autoping: bool, loop: asyncio.events.AbstractEventLoop, *, heartbeat: float | None = None, compress: int = 0, client_notakeover: bool = False) -> None | | Method resolution order: | ClientWebSocketResponse | typing.Generic | builtins.object | | Methods defined here: | | async __aenter__(self) -> Self | | async __aexit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: traceback | None) -> None | | __aiter__(self) -> Self | | async __anext__(self) -> aiohttp._websocket.models.WSMessage | aiohttp._websocket.models.WSMessageTextBytes | | __init__(self, reader: aiohttp._websocket.reader_c.WebSocketDataQueue, writer: aiohttp._websocket.writer.WebSocketWriter, protocol: str | None, response: aiohttp.client_reqrep.ClientResponse, timeout: aiohttp.client_ws.ClientWSTimeout, autoclose: bool, autoping: bool, loop: asyncio.events.AbstractEventLoop, *, heartbeat: float | None = None, compress: int = 0, client_notakeover: bool = False) -> None | Initialize self. See help(type(self)) for accurate signature. | | async close(self, *, code: int = <WSCloseCode.OK: 1000>, message: bytes = b'') -> bool | | exception(self) -> BaseException | None | | get_extra_info(self, name: str, default: Any = None) -> Any | extra info from connection transport | | async ping(self, message: bytes = b'') -> None | | async pong(self, message: bytes = b'') -> None | | async receive(self, timeout: float | None = None) -> aiohttp._websocket.models.WSMessage | aiohttp._websocket.models.WSMessageTextBytes | | async receive_bytes(self, *, timeout: float | None = None) -> bytes | | async receive_json(self, *, loads: collections.abc.Callable[[str], typing.Any] | collections.abc.Callable[[bytes], typing.Any] = <function loads at 0x0000022698C144A0>, timeout: float | None = None) -> Any | | async receive_str(self, *, timeout: float | None = None) -> str | bytes | Receive TEXT message. | | Returns str when decode_text=True (default), bytes when decode_text=False. | | async send_bytes(self, data: bytes, compress: int | None = None) -> None | | async send_frame(self, message: bytes, opcode: aiohttp._websocket.models.WSMsgType, compress: int | None = None) -> None | Send a frame over the websocket. | | async send_json(self, data: Any, compress: int | None = None, *, dumps: collections.abc.Callable[[typing.Any], str] = <function dumps at 0x0000022698C03740>) -> None | | async send_json_bytes(self, data: Any, compress: int | None = None, *, dumps: collections.abc.Callable[[typing.Any], bytes]) -> None | Send JSON data using a bytes-returning encoder as a binary frame. | | Use this when your JSON encoder (like orjson) returns bytes | instead of str, avoiding the encode/decode overhead. | | async send_str(self, data: str, compress: int | None = None) -> None | | ---------------------------------------------------------------------- | Readonly properties defined here: | | client_notakeover | | close_code | | closed | | compress | | protocol | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __orig_bases__ = (typing.Generic[+_DecodeText],) | | __parameters__ = (+_DecodeText,) | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(...) | Parameterizes a generic class. | | At least, parameterizing a generic class is the *main* thing this | method does. For example, for some generic class `Foo`, this is called | when we do `Foo[int]` - there, with `cls=Foo` and `params=int`. | | However, note that this method is also called when defining generic | classes in the first place with `class Foo[T]: ...`. | | __init_subclass__(...) | Function to initialize subclasses.
aiohttp.ConnectionTimeoutError
Python Library Documentation: class ConnectionTimeoutError in module aiohttp.client_exceptions
class ConnectionTimeoutError(ServerTimeoutError)
| Connection timeout error.
|
| Method resolution order:
| ConnectionTimeoutError
| ServerTimeoutError
| ServerConnectionError
| ClientConnectionError
| ClientError
| builtins.TimeoutError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ServerTimeoutError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.TimeoutError:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ContentTypeError
Python Library Documentation: class ContentTypeError in module aiohttp.client_exceptions
class ContentTypeError(ClientResponseError)
| ContentTypeError(request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
|
| ContentType found is not valid.
|
| Method resolution order:
| ContentTypeError
| ClientResponseError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientResponseError:
|
| __init__(self, request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientResponseError:
|
| code
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.CookieJar
Python Library Documentation: class CookieJar in module aiohttp.cookiejar
class CookieJar(aiohttp.abc.AbstractCookieJar)
| CookieJar(*, unsafe: bool = False, quote_cookie: bool = True, treat_as_secure_origin: Union[str, yarl.URL, list[Union[str, yarl.URL]], NoneType] = None, loop: asyncio.events.AbstractEventLoop | None = None) -> None
|
| Implements cookie storage adhering to RFC 6265.
|
| Method resolution order:
| CookieJar
| aiohttp.abc.AbstractCookieJar
| collections.abc.Sized
| collections.abc.Iterable
| builtins.object
|
| Methods defined here:
|
| __init__(self, *, unsafe: bool = False, quote_cookie: bool = True, treat_as_secure_origin: Union[str, yarl.URL, list[Union[str, yarl.URL]], NoneType] = None, loop: asyncio.events.AbstractEventLoop | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self) -> 'Iterator[Morsel[str]]'
|
| __len__(self) -> int
| Return number of cookies.
|
| This function does not iterate self to avoid unnecessary expiration
| checks.
|
| clear(self, predicate: collections.abc.Callable[['Morsel[str]'], bool] | None = None) -> None
| Clear all cookies if no predicate is passed.
|
| clear_domain(self, domain: str) -> None
| Clear all cookies for domain and all subdomains.
|
| filter_cookies(self, request_url: yarl.URL = URL('')) -> 'BaseCookie[str]'
| Returns this jar's cookies filtered by their attributes.
|
| load(self, file_path: Union[str, ForwardRef('os.PathLike[str]')]) -> None
| Load cookies from a file.
|
| Tries to load JSON format first. Falls back to loading legacy
| pickle format (using a restricted unpickler) for backward
| compatibility with existing cookie files.
|
| Replaces the current jar contents; loaded cookies pass through the
| same acceptance rules as :meth:`update_cookies`.
|
| :param file_path: Path to file from where cookies will be
| imported, :class:`str` or :class:`pathlib.Path` instance.
|
| save(self, file_path: Union[str, ForwardRef('os.PathLike[str]')]) -> None
| Save cookies to a file using JSON format.
|
| :param file_path: Path to file where cookies will be serialized,
| :class:`str` or :class:`pathlib.Path` instance.
|
| update_cookies(self, cookies: Union[collections.abc.Mapping[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]], collections.abc.Iterable[tuple[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]]], ForwardRef('BaseCookie[str]')], response_url: yarl.URL = URL('')) -> None
| Update cookies.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| cookies
| Return the cookies stored in this jar.
|
| host_only_cookies
| Return the host-only cookies stored in this jar.
|
| quote_cookie
| Return True if cookies should be quoted.
|
| unsafe
| Return True if cookies can be used with IP addresses.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| DATE_DAY_OF_MONTH_RE = re.compile('(\\d{1,2})')
|
| DATE_HMS_TIME_RE = re.compile('(\\d{1,2}):(\\d{1,2}):(\\d{1,2})')
|
| DATE_MONTH_RE = re.compile('(jan)|(feb)|(mar)|(apr)|(may)|(jun)|(jul)|...
|
| DATE_TOKENS_RE = re.compile('[\\x09\\x20-\\x2F\\x3B-\\x40\\x5B-\\...[\...
|
| DATE_YEAR_RE = re.compile('(\\d{2,4})')
|
| MAX_TIME = 32535215999
|
| SUB_MAX_TIME = 32535215998
|
| __abstractmethods__ = frozenset()
|
| ----------------------------------------------------------------------
| Methods inherited from aiohttp.abc.AbstractCookieJar:
|
| update_cookies_from_headers(self, headers: collections.abc.Sequence[str], response_url: yarl.URL) -> None
| Update cookies from raw Set-Cookie headers.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from aiohttp.abc.AbstractCookieJar:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Sized:
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Iterable:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
aiohttp.DataQueue
Python Library Documentation: class DataQueue in module aiohttp.streams class DataQueue(typing.Generic) | DataQueue(loop: asyncio.events.AbstractEventLoop) -> None | | DataQueue is a general-purpose blocking queue with one reader. | | Method resolution order: | DataQueue | typing.Generic | builtins.object | | Methods defined here: | | __aiter__(self) -> aiohttp.streams.AsyncStreamIterator[~_T] | | __init__(self, loop: asyncio.events.AbstractEventLoop) -> None | Initialize self. See help(type(self)) for accurate signature. | | __len__(self) -> int | | at_eof(self) -> bool | | exception(self) -> BaseException | None | | feed_data(self, data: ~_T, size: int = 0) -> None | | feed_eof(self) -> None | | is_eof(self) -> bool | | async read(self) -> ~_T | | set_exception(self, exc: BaseException, exc_cause: BaseException = BaseException()) -> None | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __orig_bases__ = (typing.Generic[~_T],) | | __parameters__ = (~_T,) | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(...) | Parameterizes a generic class. | | At least, parameterizing a generic class is the *main* thing this | method does. For example, for some generic class `Foo`, this is called | when we do `Foo[int]` - there, with `cls=Foo` and `params=int`. | | However, note that this method is also called when defining generic | classes in the first place with `class Foo[T]: ...`. | | __init_subclass__(...) | Function to initialize subclasses.
aiohttp.DefaultResolver
Python Library Documentation: class ThreadedResolver in module aiohttp.resolver
class ThreadedResolver(aiohttp.abc.AbstractResolver)
| ThreadedResolver(loop: asyncio.events.AbstractEventLoop | None = None) -> None
|
| Threaded resolver.
|
| Uses an Executor for synchronous getaddrinfo() calls.
| concurrent.futures.ThreadPoolExecutor is used by default.
|
| Method resolution order:
| ThreadedResolver
| aiohttp.abc.AbstractResolver
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, loop: asyncio.events.AbstractEventLoop | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async close(self) -> None
| Release resolver
|
| async resolve(self, host: str, port: int = 0, family: socket.AddressFamily = <AddressFamily.AF_INET: 2>) -> list[aiohttp.abc.ResolveResult]
| Return IP address for given hostname
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from aiohttp.abc.AbstractResolver:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.DigestAuthMiddleware
Python Library Documentation: class DigestAuthMiddleware in module aiohttp.client_middleware_digest_auth class DigestAuthMiddleware(builtins.object) | DigestAuthMiddleware(login: str, password: str, preemptive: bool = True) -> None | | HTTP digest authentication middleware for aiohttp client. | | This middleware intercepts 401 Unauthorized responses containing a Digest | authentication challenge, calculates the appropriate digest credentials, | and automatically retries the request with the proper Authorization header. | | Features: | - Handles all aspects of Digest authentication handshake automatically | - Supports all standard hash algorithms: | - MD5, MD5-SESS | - SHA, SHA-SESS | - SHA256, SHA256-SESS, SHA-256, SHA-256-SESS | - SHA512, SHA512-SESS, SHA-512, SHA-512-SESS | - Supports 'auth' and 'auth-int' quality of protection modes | - Properly handles quoted strings and parameter parsing | - Includes replay attack protection with client nonce count tracking | - Supports preemptive authentication per RFC 7616 Section 3.6 | | Origin scoping: | The credentials are scoped to the origin of the first request the | middleware handles. A request to a different origin is passed through | untouched, so it never receives a digest response computed from those | credentials, unless that origin falls within a protection space the | anchor origin advertised through the RFC 7616 ``domain`` directive. Make | the first request through the middleware against the intended origin, as | the anchor is pinned to it and not reset for the life of the instance. | | Standards compliance: | - RFC 7616: HTTP Digest Access Authentication (primary reference) | - RFC 2617: HTTP Authentication (deprecated by RFC 7616) | - RFC 1945: Section 11.1 (username restrictions) | | Implementation notes: | The core digest calculation is inspired by the implementation in | https://github.com/requests/requests/blob/v2.18.4/requests/auth.py | with added support for modern digest auth features and error handling. | | Methods defined here: | | async __call__(self, request: aiohttp.client_reqrep.ClientRequest, handler: collections.abc.Callable[[aiohttp.client_reqrep.ClientRequest], collections.abc.Awaitable[aiohttp.client_reqrep.ClientResponse]]) -> aiohttp.client_reqrep.ClientResponse | Run the digest auth middleware. | | __init__(self, login: str, password: str, preemptive: bool = True) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
aiohttp.DummyCookieJar
Python Library Documentation: class DummyCookieJar in module aiohttp.cookiejar
class DummyCookieJar(aiohttp.abc.AbstractCookieJar)
| DummyCookieJar(*, loop: asyncio.events.AbstractEventLoop | None = None) -> None
|
| Implements a dummy cookie storage.
|
| It can be used with the ClientSession when no cookie processing is needed.
|
| Method resolution order:
| DummyCookieJar
| aiohttp.abc.AbstractCookieJar
| collections.abc.Sized
| collections.abc.Iterable
| builtins.object
|
| Methods defined here:
|
| __init__(self, *, loop: asyncio.events.AbstractEventLoop | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self) -> 'Iterator[Morsel[str]]'
|
| __len__(self) -> int
|
| clear(self, predicate: collections.abc.Callable[['Morsel[str]'], bool] | None = None) -> None
| Clear all cookies if no predicate is passed.
|
| clear_domain(self, domain: str) -> None
| Clear all cookies for domain and all subdomains.
|
| filter_cookies(self, request_url: yarl.URL) -> 'BaseCookie[str]'
| Return the jar's cookies filtered by their attributes.
|
| update_cookies(self, cookies: Union[collections.abc.Mapping[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]], collections.abc.Iterable[tuple[str, Union[str, ForwardRef('BaseCookie[str]'), ForwardRef('Morsel[Any]')]]], ForwardRef('BaseCookie[str]')], response_url: yarl.URL = URL('')) -> None
| Update cookies.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| cookies
| Return an empty mapping.
|
| host_only_cookies
| Return an empty frozenset.
|
| quote_cookie
| Return True if cookies should be quoted.
|
| unsafe
| Return True if cookies can be used with IP addresses.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| ----------------------------------------------------------------------
| Methods inherited from aiohttp.abc.AbstractCookieJar:
|
| update_cookies_from_headers(self, headers: collections.abc.Sequence[str], response_url: yarl.URL) -> None
| Update cookies from raw Set-Cookie headers.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from aiohttp.abc.AbstractCookieJar:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Sized:
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Iterable:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
aiohttp.EMPTY_PAYLOAD
Python Library Documentation: EmptyStreamReader in module aiohttp.streams object class EmptyStreamReader(StreamReader) | EmptyStreamReader() -> None | | Method resolution order: | EmptyStreamReader | StreamReader | builtins.object | | Methods defined here: | | __init__(self) -> None | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> str | Return repr(self). | | at_eof(self) -> bool | Return True if the buffer is empty and 'feed_eof' was called. | | exception(self) -> BaseException | None | | feed_data(self, data: bytes, n: int = 0) -> bool | | feed_eof(self) -> None | | is_eof(self) -> bool | Return True if 'feed_eof' was called. | | on_eof(self, callback: collections.abc.Callable[[], None]) -> None | | async read(self, n: int = -1) -> bytes | | read_nowait(self, n: int = -1) -> bytes | | async readany(self) -> bytes | | async readchunk(self) -> tuple[bytes, bool] | Returns a tuple of (data, end_of_http_chunk). | | When chunked transfer | encoding is used, end_of_http_chunk is a boolean indicating if the end | of the data corresponds to the end of a HTTP chunk , otherwise it is | always False. | | async readexactly(self, n: int) -> bytes | | async readline(self, *, max_line_length: int | None = None) -> bytes | | set_exception(self, exc: BaseException, exc_cause: BaseException = BaseException()) -> None | | set_read_chunk_size(self, n: int) -> None | Raise buffer limits to match the consumer's chunk size. | | async wait_eof(self) -> None | | ---------------------------------------------------------------------- | Methods inherited from StreamReader: | | __aiter__(self) -> aiohttp.streams.AsyncStreamIterator[bytes] | | begin_http_chunk_receiving(self) -> None | | end_http_chunk_receiving(self) -> None | | get_read_buffer_limits(self) -> tuple[int, int] | | iter_any(self) -> aiohttp.streams.AsyncStreamIterator[bytes] | Yield all available data as soon as it is received. | | iter_chunked(self, n: int) -> aiohttp.streams.AsyncStreamIterator[bytes] | Returns an asynchronous iterator that yields chunks of size n. | | iter_chunks(self) -> aiohttp.streams.ChunkTupleAsyncStreamIterator | Yield chunks of data as they are received by the server. | | The yielded objects are tuples | of (bytes, bool) as returned by the StreamReader.readchunk method. | | async readuntil(self, separator: bytes = b'\n', *, max_size: int | None = None) -> bytes | | unread_data(self, data: bytes) -> None | rollback reading some data from stream, inserting it to buffer head. | | ---------------------------------------------------------------------- | Readonly properties inherited from StreamReader: | | total_raw_bytes | | ---------------------------------------------------------------------- | Data descriptors inherited from StreamReader: | | total_bytes | | total_compressed_bytes
aiohttp.ETag
Python Library Documentation: class ETag in module aiohttp.helpers
class ETag(builtins.object)
| ETag(value: str, is_weak: bool = False) -> None
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class ETag.
|
| __ge__(self, other)
| Method generated by attrs for class ETag.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class ETag.
|
| __hash__(self)
| Method generated by attrs for class ETag.
|
| __init__(self, value: str, is_weak: bool = False) -> None
| Method generated by attrs for class ETag.
|
| __le__(self, other)
| Method generated by attrs for class ETag.
|
| __lt__(self, other)
| Method generated by attrs for class ETag.
|
| __ne__(self, other)
| Method generated by attrs for class ETag.
|
| __repr__(self)
| Method generated by attrs for class ETag.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| is_weak
|
| value
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'is_weak': <class 'bool'>, 'value': <class 'str'>}
|
| __attrs_attrs__ = (Attribute(name='value', default=NOTHING, valida...h...
|
| __match_args__ = ('value', 'is_weak')
aiohttp.EofStream
Python Library Documentation: class EofStream in module aiohttp.streams class EofStream(builtins.Exception) | eof stream indication. | | Method resolution order: | EofStream | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
aiohttp.Fingerprint
Python Library Documentation: class Fingerprint in module aiohttp.client_reqrep
class Fingerprint(builtins.object)
| Fingerprint(fingerprint: bytes) -> None
|
| Methods defined here:
|
| __init__(self, fingerprint: bytes) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| check(self, transport: asyncio.transports.Transport) -> None
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| fingerprint
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| HASHFUNC_BY_DIGESTLEN = {16: <built-in function openssl_md5>, 20: <bui...
aiohttp.FlowControlDataQueue
Python Library Documentation: class FlowControlDataQueue in module aiohttp.streams class FlowControlDataQueue(DataQueue) | FlowControlDataQueue(protocol: aiohttp.base_protocol.BaseProtocol, limit: int, *, loop: asyncio.events.AbstractEventLoop) -> None | | FlowControlDataQueue resumes and pauses an underlying stream. | | It is a destination for parsed data. | | This class is deprecated and will be removed in version 4.0. | | Method resolution order: | FlowControlDataQueue | DataQueue | typing.Generic | builtins.object | | Methods defined here: | | __init__(self, protocol: aiohttp.base_protocol.BaseProtocol, limit: int, *, loop: asyncio.events.AbstractEventLoop) -> None | Initialize self. See help(type(self)) for accurate signature. | | feed_data(self, data: ~_T, size: int = 0) -> None | | async read(self) -> ~_T | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __orig_bases__ = (aiohttp.streams.DataQueue[~_T],) | | __parameters__ = (~_T,) | | ---------------------------------------------------------------------- | Methods inherited from DataQueue: | | __aiter__(self) -> aiohttp.streams.AsyncStreamIterator[~_T] | | __len__(self) -> int | | at_eof(self) -> bool | | exception(self) -> BaseException | None | | feed_eof(self) -> None | | is_eof(self) -> bool | | set_exception(self, exc: BaseException, exc_cause: BaseException = BaseException()) -> None | | ---------------------------------------------------------------------- | Data descriptors inherited from DataQueue: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Class methods inherited from typing.Generic: | | __class_getitem__(...) | Parameterizes a generic class. | | At least, parameterizing a generic class is the *main* thing this | method does. For example, for some generic class `Foo`, this is called | when we do `Foo[int]` - there, with `cls=Foo` and `params=int`. | | However, note that this method is also called when defining generic | classes in the first place with `class Foo[T]: ...`. | | __init_subclass__(...) | Function to initialize subclasses.
aiohttp.FormData
Python Library Documentation: class FormData in module aiohttp.formdata class FormData(builtins.object) | FormData(fields: collections.abc.Iterable[typing.Any] = (), quote_fields: bool = True, charset: str | None = None, *, default_to_multipart: bool = False) -> None | | Helper class for form body generation. | | Supports multipart/form-data and application/x-www-form-urlencoded. | | Methods defined here: | | __call__(self) -> aiohttp.payload.Payload | Call self as a function. | | __init__(self, fields: collections.abc.Iterable[typing.Any] = (), quote_fields: bool = True, charset: str | None = None, *, default_to_multipart: bool = False) -> None | Initialize self. See help(type(self)) for accurate signature. | | add_field(self, name: str, value: Any, *, content_type: str | None = None, filename: str | None = None, content_transfer_encoding: str | None = None) -> None | | add_fields(self, *fields: Any) -> None | | ---------------------------------------------------------------------- | Readonly properties defined here: | | is_multipart | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
aiohttp.GunicornUVLoopWebWorker
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
aiohttp.GunicornWebWorker
Python Library Documentation: NoneType object class NoneType(object) | Methods defined here: | | __bool__(self, /) | True if self else False | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __le__(self, value, /) | Return self<=value. | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __repr__(self, /) | Return repr(self). | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature.
aiohttp.HttpVersion
Python Library Documentation: class HttpVersion in module aiohttp.http_writer
class HttpVersion(builtins.tuple)
| HttpVersion(major: int, minor: int)
|
| HttpVersion(major, minor)
|
| Method resolution order:
| HttpVersion
| builtins.tuple
| builtins.object
|
| Methods defined here:
|
| __getnewargs__(self) from collections.HttpVersion
| Return self as a plain tuple. Used by copy and pickle.
|
| __repr__(self) from collections.HttpVersion
| Return a nicely formatted representation string
|
| _asdict(self) from collections.HttpVersion
| Return a new dict which maps field names to their values.
|
| _replace(self, /, **kwds) from collections.HttpVersion
| Return a new HttpVersion object replacing specified fields with new values
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| _make(iterable) from collections.HttpVersion
| Make a new HttpVersion object from a sequence or iterable
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(_cls, major: int, minor: int) from namedtuple_HttpVersion.HttpVersion
| Create new instance of HttpVersion(major, minor)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| major
| Alias for field number 0
|
| minor
| Alias for field number 1
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'major': <class 'int'>, 'minor': <class 'int'>}
|
| __match_args__ = ('major', 'minor')
|
| __orig_bases__ = (<function NamedTuple>,)
|
| _field_defaults = {}
|
| _fields = ('major', 'minor')
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.tuple:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.tuple:
|
| __class_getitem__(...)
| See PEP 585
aiohttp.HttpVersion10
Python Library Documentation: HttpVersion in module aiohttp.http_writer object
class HttpVersion(builtins.tuple)
| HttpVersion(major: int, minor: int)
|
| HttpVersion(major, minor)
|
| Method resolution order:
| HttpVersion
| builtins.tuple
| builtins.object
|
| Methods defined here:
|
| __getnewargs__(self) from collections.HttpVersion
| Return self as a plain tuple. Used by copy and pickle.
|
| __repr__(self) from collections.HttpVersion
| Return a nicely formatted representation string
|
| _asdict(self) from collections.HttpVersion
| Return a new dict which maps field names to their values.
|
| _replace(self, /, **kwds) from collections.HttpVersion
| Return a new HttpVersion object replacing specified fields with new values
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| _make(iterable) from collections.HttpVersion
| Make a new HttpVersion object from a sequence or iterable
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(_cls, major: int, minor: int) from namedtuple_HttpVersion.HttpVersion
| Create new instance of HttpVersion(major, minor)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| major
| Alias for field number 0
|
| minor
| Alias for field number 1
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'major': <class 'int'>, 'minor': <class 'int'>}
|
| __match_args__ = ('major', 'minor')
|
| __orig_bases__ = (<function NamedTuple>,)
|
| _field_defaults = {}
|
| _fields = ('major', 'minor')
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.tuple:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.tuple:
|
| __class_getitem__(...)
| See PEP 585
aiohttp.HttpVersion11
Python Library Documentation: HttpVersion in module aiohttp.http_writer object
class HttpVersion(builtins.tuple)
| HttpVersion(major: int, minor: int)
|
| HttpVersion(major, minor)
|
| Method resolution order:
| HttpVersion
| builtins.tuple
| builtins.object
|
| Methods defined here:
|
| __getnewargs__(self) from collections.HttpVersion
| Return self as a plain tuple. Used by copy and pickle.
|
| __repr__(self) from collections.HttpVersion
| Return a nicely formatted representation string
|
| _asdict(self) from collections.HttpVersion
| Return a new dict which maps field names to their values.
|
| _replace(self, /, **kwds) from collections.HttpVersion
| Return a new HttpVersion object replacing specified fields with new values
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| _make(iterable) from collections.HttpVersion
| Make a new HttpVersion object from a sequence or iterable
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(_cls, major: int, minor: int) from namedtuple_HttpVersion.HttpVersion
| Create new instance of HttpVersion(major, minor)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| major
| Alias for field number 0
|
| minor
| Alias for field number 1
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'major': <class 'int'>, 'minor': <class 'int'>}
|
| __match_args__ = ('major', 'minor')
|
| __orig_bases__ = (<function NamedTuple>,)
|
| _field_defaults = {}
|
| _fields = ('major', 'minor')
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.tuple:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.tuple:
|
| __class_getitem__(...)
| See PEP 585
aiohttp.IOBasePayload
Python Library Documentation: class IOBasePayload in module aiohttp.payload
class IOBasePayload(Payload)
| IOBasePayload(value: IO[Any], disposition: str = 'attachment', *args: Any, **kwargs: Any) -> None
|
| Method resolution order:
| IOBasePayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: IO[Any], disposition: str = 'attachment', *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method reads the entire file content and returns it as bytes.
| It is equivalent to reading the file-like object directly.
| The file reading is performed in an executor to avoid blocking the event loop.
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| WARNING: This method does blocking I/O and should not be called in the event loop.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire file-like payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire file content without any length constraint.
| It delegates to write_with_length() with no length limit for implementation
| consistency.
|
| Note:
| For new implementations that need length control, use write_with_length() directly.
| This method is maintained for backwards compatibility with existing code.
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write file-like payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method implements optimized streaming of file content with length constraints:
|
| 1. File reading is performed in a thread pool to avoid blocking the event loop
| 2. Content is read and written in chunks to maintain memory efficiency
| 3. Writing stops when either:
| - All available file content has been written (when size is known)
| - The specified content_length has been reached
| 4. File resources are properly closed even if the operation is cancelled
|
| The implementation carefully handles both known-size and unknown-size payloads,
| as well as constrained and unconstrained content lengths.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| size
| Size of the payload in bytes.
|
| Returns the total size of the payload content from the initial position.
| This ensures consistent Content-Length for requests, including 307/308 redirects
| where the same payload instance is reused.
|
| Returns None if the size cannot be determined (e.g., for unseekable streams).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {'_start_position': int | None, '_value': <class 'io...
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.InvalidURL
Python Library Documentation: class InvalidURL in module aiohttp.client_exceptions
class InvalidURL(ClientError, builtins.ValueError)
| InvalidURL(url: Union[str, yarl.URL], description: str | None = None) -> None
|
| Invalid URL.
|
| URL used for fetching is malformed, e.g. it doesn't contains host
| part.
|
| Method resolution order:
| InvalidURL
| ClientError
| builtins.ValueError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, url: Union[str, yarl.URL], description: str | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| description
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.ValueError:
|
| __new__(*args, **kwargs) class method of builtins.ValueError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.InvalidUrlClientError
Python Library Documentation: class InvalidUrlClientError in module aiohttp.client_exceptions
class InvalidUrlClientError(InvalidURL)
| InvalidUrlClientError(url: Union[str, yarl.URL], description: str | None = None) -> None
|
| Invalid URL client error.
|
| Method resolution order:
| InvalidUrlClientError
| InvalidURL
| ClientError
| builtins.ValueError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from InvalidURL:
|
| __init__(self, url: Union[str, yarl.URL], description: str | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from InvalidURL:
|
| description
|
| url
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.ValueError:
|
| __new__(*args, **kwargs) class method of builtins.ValueError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.InvalidUrlRedirectClientError
Python Library Documentation: class InvalidUrlRedirectClientError in module aiohttp.client_exceptions
class InvalidUrlRedirectClientError(InvalidUrlClientError, RedirectClientError)
| InvalidUrlRedirectClientError(url: Union[str, yarl.URL], description: str | None = None) -> None
|
| Invalid URL redirect client error.
|
| Method resolution order:
| InvalidUrlRedirectClientError
| InvalidUrlClientError
| InvalidURL
| RedirectClientError
| ClientError
| builtins.ValueError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from InvalidURL:
|
| __init__(self, url: Union[str, yarl.URL], description: str | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Readonly properties inherited from InvalidURL:
|
| description
|
| url
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.ValueError:
|
| __new__(*args, **kwargs) class method of builtins.ValueError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.JsonPayload
Python Library Documentation: class JsonPayload in module aiohttp.payload
class JsonPayload(BytesPayload)
| JsonPayload(value: Any, encoding: str = 'utf-8', content_type: str = 'application/json', dumps: collections.abc.Callable[[typing.Any], str] = <function dumps at 0x0000022698C03740>, *args: Any, **kwargs: Any) -> None
|
| Method resolution order:
| JsonPayload
| BytesPayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: Any, encoding: str = 'utf-8', content_type: str = 'application/json', dumps: collections.abc.Callable[[typing.Any], str] = <function dumps at 0x0000022698C03740>, *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from BytesPayload:
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method returns the raw bytes content of the payload.
| It is equivalent to accessing the _value attribute directly.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| This is named decode() to allow compatibility with bytes objects.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire bytes payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire bytes content without any length constraint.
|
| Note:
| For new implementations that need length control, use write_with_length().
| This method is maintained for backwards compatibility and is equivalent
| to write_with_length(writer, None).
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write bytes payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method writes either the entire byte sequence or a slice of it
| up to the specified content_length. For BytesPayload, this operation
| is performed efficiently using array slicing.
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| In the future, this will be the only close method supported.
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| size
| Size of the payload in bytes.
|
| Returns the number of bytes that will be transmitted when the payload
| is written. For string payloads, this is the size after encoding to bytes,
| not the length of the string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.MultipartReader
Python Library Documentation: class MultipartReader in module aiohttp.multipart
class MultipartReader(builtins.object)
| MultipartReader(headers: collections.abc.Mapping[str, str], content: aiohttp.streams.StreamReader, *, client_max_size: int = 9223372036854775807, max_field_size: int = 8190, max_headers: int = 128, max_size_error_cls: type[Exception] = <class 'ValueError'>) -> None
|
| Multipart body reader.
|
| Methods defined here:
|
| __aiter__(self: Self) -> Self
|
| async __anext__(self) -> Union[ForwardRef('MultipartReader'), aiohttp.multipart.BodyPartReader, NoneType]
|
| __init__(self, headers: collections.abc.Mapping[str, str], content: aiohttp.streams.StreamReader, *, client_max_size: int = 9223372036854775807, max_field_size: int = 8190, max_headers: int = 128, max_size_error_cls: type[Exception] = <class 'ValueError'>) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| at_eof(self) -> bool
| Returns True if the final boundary was reached, false otherwise.
|
| async fetch_next_part(self) -> Union[ForwardRef('MultipartReader'), aiohttp.multipart.BodyPartReader]
| Returns the next body part reader.
|
| async next(self) -> Union[ForwardRef('MultipartReader'), aiohttp.multipart.BodyPartReader, NoneType]
| Emits the next multipart body part.
|
| async release(self) -> None
| Reads all the body parts to the void till the final boundary.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| from_response(response: 'ClientResponse') -> aiohttp.multipart.MultipartResponseWrapper
| Constructs reader instance from HTTP response.
|
| :param response: :class:`~aiohttp.client.ClientResponse` instance
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'multipart_reader_cls': type['MultipartReader'] | N...
|
| multipart_reader_cls = None
|
| part_reader_cls = <class 'aiohttp.multipart.BodyPartReader'>
| Multipart reader for single body part.
|
|
| response_wrapper_cls = <class 'aiohttp.multipart.MultipartResponseWrap...
| Wrapper around the MultipartReader.
|
| It takes care about
| underlying connection and close it when it needs in.
aiohttp.MultipartWriter
Python Library Documentation: class MultipartWriter in module aiohttp.multipart
class MultipartWriter(aiohttp.payload.Payload)
| MultipartWriter(subtype: str = 'mixed', boundary: str | None = None) -> None
|
| Multipart body writer.
|
| Method resolution order:
| MultipartWriter
| aiohttp.payload.Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __bool__(self) -> bool
|
| __enter__(self) -> 'MultipartWriter'
|
| __exit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: traceback | None) -> None
|
| __init__(self, subtype: str = 'mixed', boundary: str | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self) -> collections.abc.Iterator[tuple[aiohttp.payload.Payload, str, str]]
|
| __len__(self) -> int
|
| append(self, obj: Any, headers: collections.abc.Mapping[str, str] | None = None) -> aiohttp.payload.Payload
|
| append_form(self, obj: collections.abc.Sequence[tuple[str, str]] | collections.abc.Mapping[str, str], headers: collections.abc.Mapping[str, str] | None = None) -> aiohttp.payload.Payload
| Helper to append form urlencoded part.
|
| append_json(self, obj: Any, headers: collections.abc.Mapping[str, str] | None = None) -> aiohttp.payload.Payload
| Helper to append JSON part.
|
| append_payload(self, payload: aiohttp.payload.Payload) -> aiohttp.payload.Payload
| Adds a new body part to multipart writer.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the multipart data.
|
| This method is async-safe and calls as_bytes on underlying payloads.
|
| async close(self) -> None
| Close all part payloads that need explicit closing.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the multipart data.
|
| WARNING: This method may do blocking I/O if parts contain file payloads.
| It should not be called in the event loop. Use as_bytes().decode() instead.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter, close_boundary: bool = True) -> None
| Write body.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| boundary
|
| size
| Size of the payload.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {'_value': None}
|
| ----------------------------------------------------------------------
| Methods inherited from aiohttp.payload.Payload:
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method allows writing payload content with a specific length constraint,
| which is particularly useful for HTTP responses with Content-Length header.
|
| Note:
| This is the base implementation that provides backwards compatibility
| for subclasses that don't override this method. Specific payload types
| should override this method to implement proper length-constrained writing.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from aiohttp.payload.Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| ----------------------------------------------------------------------
| Data descriptors inherited from aiohttp.payload.Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.NamedPipeConnector
Python Library Documentation: class NamedPipeConnector in module aiohttp.connector
class NamedPipeConnector(BaseConnector)
| NamedPipeConnector(path: str, force_close: bool = False, keepalive_timeout: object | float | None = <_SENTINEL.sentinel: 1>, limit: int = 100, limit_per_host: int = 0, loop: asyncio.events.AbstractEventLoop | None = None) -> None
|
| Named pipe connector.
|
| Only supported by the proactor event loop.
| See also: https://docs.python.org/3/library/asyncio-eventloop.html
|
| path - Windows named pipe path.
| keepalive_timeout - (optional) Keep-alive timeout.
| force_close - Set to True to force close and do reconnect
| after each request (and between redirects).
| limit - The total number of simultaneous connections.
| limit_per_host - Number of simultaneous connections to one host.
| loop - Optional event loop.
|
| Method resolution order:
| NamedPipeConnector
| BaseConnector
| builtins.object
|
| Methods defined here:
|
| __init__(self, path: str, force_close: bool = False, keepalive_timeout: object | float | None = <_SENTINEL.sentinel: 1>, limit: int = 100, limit_per_host: int = 0, loop: asyncio.events.AbstractEventLoop | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| path
| Path to the named pipe.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| allowed_protocol_schema_set = frozenset({'', 'http', 'https', 'npipe',...
|
| ----------------------------------------------------------------------
| Methods inherited from BaseConnector:
|
| async __aenter__(self) -> 'BaseConnector'
|
| async __aexit__(self, exc_type: type[BaseException] | None = None, exc_value: BaseException | None = None, exc_traceback: traceback | None = None) -> None
|
| __del__(self, _warnings: Any = <module 'warnings' from 'C:\\Users\\Youse\\AppData\\Local\\Programs\\Python\\Python312\\Lib\\warnings.py'>) -> None
|
| __enter__(self) -> 'BaseConnector'
|
| __exit__(self, *exc: Any) -> None
|
| close(self, *, abort_ssl: bool = False) -> collections.abc.Awaitable[None]
| Close all opened transports.
|
| :param abort_ssl: If True, SSL connections will be aborted immediately
| without performing the shutdown handshake. This provides
| faster cleanup at the cost of less graceful disconnection.
|
| async connect(self, req: aiohttp.client_reqrep.ClientRequest, traces: list['Trace'], timeout: 'ClientTimeout') -> aiohttp.connector.Connection
| Get from pool or create new connection.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from BaseConnector:
|
| closed
| Is connector closed.
|
| A readonly property.
|
| force_close
| Ultimately close connection on releasing if True.
|
| limit
| The total number for simultaneous connections.
|
| If limit is 0 the connector has no limit.
| The default limit size is 100.
|
| limit_per_host
| The limit for simultaneous connections to the same endpoint.
|
| Endpoints are the same if they are have equal
| (host, port, is_ssl) triple.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseConnector:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.NonHttpUrlClientError
Python Library Documentation: class NonHttpUrlClientError in module aiohttp.client_exceptions
class NonHttpUrlClientError(ClientError)
| Non http URL client error.
|
| Method resolution order:
| NonHttpUrlClientError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.NonHttpUrlRedirectClientError
Python Library Documentation: class NonHttpUrlRedirectClientError in module aiohttp.client_exceptions
class NonHttpUrlRedirectClientError(NonHttpUrlClientError, RedirectClientError)
| Non http URL redirect client error.
|
| Method resolution order:
| NonHttpUrlRedirectClientError
| NonHttpUrlClientError
| RedirectClientError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.PAYLOAD_REGISTRY
Python Library Documentation: PayloadRegistry in module aiohttp.payload object class PayloadRegistry(builtins.object) | PayloadRegistry() -> None | | Payload registry. | | note: we need zope.interface for more efficient adapter search | | Methods defined here: | | __init__(self) -> None | Initialize self. See help(type(self)) for accurate signature. | | get(self, data: Any, *args: Any, _CHAIN: 'type[chain[_PayloadRegistryItem]]' = <class 'itertools.chain'>, **kwargs: Any) -> 'Payload' | | register(self, factory: type['Payload'], type: Any, *, order: aiohttp.payload.Order = <Order.normal: 'normal'>) -> None
aiohttp.Payload
Python Library Documentation: class Payload in module aiohttp.payload
class Payload(abc.ABC)
| Payload(value: Any, headers: multidict._multidict.CIMultiDict | dict[str, str] | collections.abc.Iterable[tuple[str, str]] | None = None, content_type: str | None | aiohttp.helpers._SENTINEL = <_SENTINEL.sentinel: 1>, filename: str | None = None, encoding: str | None = None, **kwargs: Any) -> None
|
| Method resolution order:
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: Any, headers: multidict._multidict.CIMultiDict | dict[str, str] | collections.abc.Iterable[tuple[str, str]] | None = None, content_type: str | None | aiohttp.helpers._SENTINEL = <_SENTINEL.sentinel: 1>, filename: str | None = None, encoding: str | None = None, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This is a convenience method that calls decode() and encodes the result
| to bytes using the specified encoding.
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| In the future, this will be the only close method supported.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| This is named decode() to allow compatibility with bytes objects.
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This is a legacy method that writes the entire payload without length constraints.
|
| Important:
| For new implementations, use write_with_length() instead of this method.
| This method is maintained for backwards compatibility and will eventually
| delegate to write_with_length(writer, None) in all implementations.
|
| All payload subclasses must override this method for backwards compatibility,
| but new code should use write_with_length for more flexibility and control.
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method allows writing payload content with a specific length constraint,
| which is particularly useful for HTTP responses with Content-Length header.
|
| Note:
| This is the base implementation that provides backwards compatibility
| for subclasses that don't override this method. Specific payload types
| should override this method to implement proper length-constrained writing.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| size
| Size of the payload in bytes.
|
| Returns the number of bytes that will be transmitted when the payload
| is written. For string payloads, this is the size after encoding to bytes,
| not the length of the string.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset({'decode', 'write'})
|
| __annotations__ = {'_autoclose': <class 'bool'>, '_consumed': <class '...
aiohttp.RedirectClientError
Python Library Documentation: class RedirectClientError in module aiohttp.client_exceptions
class RedirectClientError(ClientError)
| Client redirect error.
|
| Method resolution order:
| RedirectClientError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.RequestInfo
Python Library Documentation: class RequestInfo in module aiohttp.client_reqrep
class RequestInfo(_RequestInfo)
| RequestInfo(url: yarl.URL, method: str, headers: 'CIMultiDictProxy[str]', real_url: yarl.URL | aiohttp.helpers._SENTINEL = <_SENTINEL.sentinel: 1>) -> 'RequestInfo'
|
| Method resolution order:
| RequestInfo
| _RequestInfo
| builtins.tuple
| builtins.object
|
| Static methods defined here:
|
| __new__(cls, url: yarl.URL, method: str, headers: 'CIMultiDictProxy[str]', real_url: yarl.URL | aiohttp.helpers._SENTINEL = <_SENTINEL.sentinel: 1>) -> 'RequestInfo'
| Create a new RequestInfo instance.
|
| For backwards compatibility, the real_url parameter is optional.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from _RequestInfo:
|
| __getnewargs__(self) from collections._RequestInfo
| Return self as a plain tuple. Used by copy and pickle.
|
| __repr__(self) from collections._RequestInfo
| Return a nicely formatted representation string
|
| _asdict(self) from collections._RequestInfo
| Return a new dict which maps field names to their values.
|
| _replace(self, /, **kwds) from collections._RequestInfo
| Return a new _RequestInfo object replacing specified fields with new values
|
| ----------------------------------------------------------------------
| Class methods inherited from _RequestInfo:
|
| _make(iterable) from collections._RequestInfo
| Make a new _RequestInfo object from a sequence or iterable
|
| ----------------------------------------------------------------------
| Data descriptors inherited from _RequestInfo:
|
| url
| Alias for field number 0
|
| method
| Alias for field number 1
|
| headers
| Alias for field number 2
|
| real_url
| Alias for field number 3
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from _RequestInfo:
|
| __match_args__ = ('url', 'method', 'headers', 'real_url')
|
| __orig_bases__ = (<function NamedTuple>,)
|
| _field_defaults = {}
|
| _fields = ('url', 'method', 'headers', 'real_url')
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.tuple:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.tuple:
|
| __class_getitem__(...)
| See PEP 585
aiohttp.ServerConnectionError
Python Library Documentation: class ServerConnectionError in module aiohttp.client_exceptions
class ServerConnectionError(ClientConnectionError)
| Server connection errors.
|
| Method resolution order:
| ServerConnectionError
| ClientConnectionError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.Exception:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ServerDisconnectedError
Python Library Documentation: class ServerDisconnectedError in module aiohttp.client_exceptions
class ServerDisconnectedError(ServerConnectionError)
| ServerDisconnectedError(message: None | str = None) -> None
|
| Server disconnected.
|
| Method resolution order:
| ServerDisconnectedError
| ServerConnectionError
| ClientConnectionError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: None | str = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ServerFingerprintMismatch
Python Library Documentation: class ServerFingerprintMismatch in module aiohttp.client_exceptions
class ServerFingerprintMismatch(ServerConnectionError)
| ServerFingerprintMismatch(expected: bytes, got: bytes, host: str, port: int) -> None
|
| SSL certificate does not match expected fingerprint.
|
| Method resolution order:
| ServerFingerprintMismatch
| ServerConnectionError
| ClientConnectionError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, expected: bytes, got: bytes, host: str, port: int) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.ServerTimeoutError
Python Library Documentation: class ServerTimeoutError in module aiohttp.client_exceptions
class ServerTimeoutError(ServerConnectionError, builtins.TimeoutError)
| Server timeout error.
|
| Method resolution order:
| ServerTimeoutError
| ServerConnectionError
| ClientConnectionError
| ClientError
| builtins.TimeoutError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.TimeoutError:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.SocketFactoryType
Python Library Documentation: _CallableGenericAlias in module collections.abc
class Callable(builtins.object)
| Methods defined here:
|
| __call__(self, *args, **kwds)
| Call self as a function.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| __class_getitem__ = _CallableGenericAlias(args)
| Represent `Callable[argtypes, resulttype]`.
|
| This sets ``__args__`` to a tuple containing the flattened ``argtypes``
| followed by ``resulttype``.
|
| Example: ``Callable[[int, str], float]`` sets ``__args__`` to
| ``(int, str, float)``.
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset({'__call__'})
aiohttp.SocketTimeoutError
Python Library Documentation: class SocketTimeoutError in module aiohttp.client_exceptions
class SocketTimeoutError(ServerTimeoutError)
| Socket timeout error.
|
| Method resolution order:
| SocketTimeoutError
| ServerTimeoutError
| ServerConnectionError
| ClientConnectionError
| ClientError
| builtins.TimeoutError
| builtins.OSError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ServerTimeoutError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.TimeoutError:
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.OSError:
|
| __reduce__(...)
| Helper for pickle.
|
| __str__(self, /)
| Return str(self).
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.OSError:
|
| __new__(*args, **kwargs) class method of builtins.OSError
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.OSError:
|
| characters_written
|
| errno
| POSIX exception code
|
| filename
| exception filename
|
| filename2
| second exception filename
|
| strerror
| exception strerror
|
| winerror
| Win32 exception code
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.StreamReader
Python Library Documentation: class StreamReader in module aiohttp.streams class StreamReader(builtins.object) | StreamReader(protocol: aiohttp.base_protocol.BaseProtocol, limit: int, *, timer: aiohttp.helpers.BaseTimerContext | None = None, loop: asyncio.events.AbstractEventLoop | None = None) -> None | | An enhancement of asyncio.StreamReader. | | Supports asynchronous iteration by line, chunk or as available:: | | async for line in reader: | ... | async for chunk in reader.iter_chunked(1024): | ... | async for slice in reader.iter_any(): | ... | | Methods defined here: | | __aiter__(self) -> aiohttp.streams.AsyncStreamIterator[bytes] | | __init__(self, protocol: aiohttp.base_protocol.BaseProtocol, limit: int, *, timer: aiohttp.helpers.BaseTimerContext | None = None, loop: asyncio.events.AbstractEventLoop | None = None) -> None | Initialize self. See help(type(self)) for accurate signature. | | __repr__(self) -> str | Return repr(self). | | at_eof(self) -> bool | Return True if the buffer is empty and 'feed_eof' was called. | | begin_http_chunk_receiving(self) -> None | | end_http_chunk_receiving(self) -> None | | exception(self) -> BaseException | None | | feed_data(self, data: bytes, size: int = 0) -> bool | # TODO: size is ignored, remove the param later | | feed_eof(self) -> None | | get_read_buffer_limits(self) -> tuple[int, int] | | is_eof(self) -> bool | Return True if 'feed_eof' was called. | | iter_any(self) -> aiohttp.streams.AsyncStreamIterator[bytes] | Yield all available data as soon as it is received. | | iter_chunked(self, n: int) -> aiohttp.streams.AsyncStreamIterator[bytes] | Returns an asynchronous iterator that yields chunks of size n. | | iter_chunks(self) -> aiohttp.streams.ChunkTupleAsyncStreamIterator | Yield chunks of data as they are received by the server. | | The yielded objects are tuples | of (bytes, bool) as returned by the StreamReader.readchunk method. | | on_eof(self, callback: collections.abc.Callable[[], None]) -> None | | async read(self, n: int = -1) -> bytes | | read_nowait(self, n: int = -1) -> bytes | | async readany(self) -> bytes | | async readchunk(self) -> tuple[bytes, bool] | Returns a tuple of (data, end_of_http_chunk). | | When chunked transfer | encoding is used, end_of_http_chunk is a boolean indicating if the end | of the data corresponds to the end of a HTTP chunk , otherwise it is | always False. | | async readexactly(self, n: int) -> bytes | | async readline(self, *, max_line_length: int | None = None) -> bytes | | async readuntil(self, separator: bytes = b'\n', *, max_size: int | None = None) -> bytes | | set_exception(self, exc: BaseException, exc_cause: BaseException = BaseException()) -> None | | set_read_chunk_size(self, n: int) -> None | Raise buffer limits to match the consumer's chunk size. | | unread_data(self, data: bytes) -> None | rollback reading some data from stream, inserting it to buffer head. | | async wait_eof(self) -> None | | ---------------------------------------------------------------------- | Readonly properties defined here: | | total_raw_bytes | | ---------------------------------------------------------------------- | Data descriptors defined here: | | total_bytes | | total_compressed_bytes
aiohttp.StringIOPayload
Python Library Documentation: class StringIOPayload in module aiohttp.payload
class StringIOPayload(StringPayload)
| StringIOPayload(value: IO[str], *args: Any, **kwargs: Any) -> None
|
| Method resolution order:
| StringIOPayload
| StringPayload
| BytesPayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: IO[str], *args: Any, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from BytesPayload:
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method returns the raw bytes content of the payload.
| It is equivalent to accessing the _value attribute directly.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| This is named decode() to allow compatibility with bytes objects.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire bytes payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire bytes content without any length constraint.
|
| Note:
| For new implementations that need length control, use write_with_length().
| This method is maintained for backwards compatibility and is equivalent
| to write_with_length(writer, None).
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write bytes payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method writes either the entire byte sequence or a slice of it
| up to the specified content_length. For BytesPayload, this operation
| is performed efficiently using array slicing.
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| In the future, this will be the only close method supported.
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| size
| Size of the payload in bytes.
|
| Returns the number of bytes that will be transmitted when the payload
| is written. For string payloads, this is the size after encoding to bytes,
| not the length of the string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.StringPayload
Python Library Documentation: class StringPayload in module aiohttp.payload
class StringPayload(BytesPayload)
| StringPayload(value: str, *args: Any, encoding: str | None = None, content_type: str | None = None, **kwargs: Any) -> None
|
| Method resolution order:
| StringPayload
| BytesPayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: str, *args: Any, encoding: str | None = None, content_type: str | None = None, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from BytesPayload:
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method returns the raw bytes content of the payload.
| It is equivalent to accessing the _value attribute directly.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| This is named decode() to allow compatibility with bytes objects.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire bytes payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire bytes content without any length constraint.
|
| Note:
| For new implementations that need length control, use write_with_length().
| This method is maintained for backwards compatibility and is equivalent
| to write_with_length(writer, None).
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write bytes payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method writes either the entire byte sequence or a slice of it
| up to the specified content_length. For BytesPayload, this operation
| is performed efficiently using array slicing.
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| In the future, this will be the only close method supported.
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| size
| Size of the payload in bytes.
|
| Returns the number of bytes that will be transmitted when the payload
| is written. For string payloads, this is the size after encoding to bytes,
| not the length of the string.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.TCPConnector
Python Library Documentation: class TCPConnector in module aiohttp.connector
class TCPConnector(BaseConnector)
| TCPConnector(*, verify_ssl: bool = True, fingerprint: bytes | None = None, use_dns_cache: bool = True, ttl_dns_cache: int | None = 10, dns_cache_max_size: int = 1000, family: socket.AddressFamily = <AddressFamily.AF_UNSPEC: 0>, ssl_context: ssl.SSLContext | None = None, ssl: bool | aiohttp.client_reqrep.Fingerprint | ssl.SSLContext = True, local_addr: tuple[str, int] | None = None, resolver: aiohttp.abc.AbstractResolver | None = None, keepalive_timeout: None | float | object = <_SENTINEL.sentinel: 1>, force_close: bool = False, limit: int = 100, limit_per_host: int = 0, enable_cleanup_closed: bool = False, loop: asyncio.events.AbstractEventLoop | None = None, timeout_ceil_threshold: float = 5, happy_eyeballs_delay: float | None = 0.25, interleave: int | None = None, socket_factory: collections.abc.Callable[[tuple[int | socket.AddressFamily, int | socket.SocketKind, int, str, tuple]], socket.socket] | None = None, ssl_shutdown_timeout: aiohttp.helpers._SENTINEL | None | float = <_SENTINEL.sentinel: 1>)
|
| TCP connector.
|
| verify_ssl - Set to True to check ssl certifications.
| fingerprint - Pass the binary sha256
| digest of the expected certificate in DER format to verify
| that the certificate the server presents matches. See also
| https://en.wikipedia.org/wiki/HTTP_Public_Key_Pinning
| resolver - Enable DNS lookups and use this
| resolver
| use_dns_cache - Use memory cache for DNS lookups.
| ttl_dns_cache - Max seconds having cached a DNS entry, None forever.
| family - socket address family
| local_addr - local tuple of (host, port) to bind socket to
|
| keepalive_timeout - (optional) Keep-alive timeout.
| force_close - Set to True to force close and do reconnect
| after each request (and between redirects).
| limit - The total number of simultaneous connections.
| limit_per_host - Number of simultaneous connections to one host.
| enable_cleanup_closed - Enables clean-up closed ssl transports.
| Disabled by default.
| happy_eyeballs_delay - This is the “Connection Attempt Delay”
| as defined in RFC 8305. To disable
| the happy eyeballs algorithm, set to None.
| interleave - “First Address Family Count” as defined in RFC 8305
| loop - Optional event loop.
| socket_factory - A SocketFactoryType function that, if supplied,
| will be used to create sockets given an
| AddrInfoType.
| ssl_shutdown_timeout - DEPRECATED. Will be removed in aiohttp 4.0.
| Grace period for SSL shutdown handshake on TLS
| connections. Default is 0 seconds (immediate abort).
| This parameter allowed for a clean SSL shutdown by
| notifying the remote peer of connection closure,
| while avoiding excessive delays during connector cleanup.
| Note: Only takes effect on Python 3.11+.
|
| Method resolution order:
| TCPConnector
| BaseConnector
| builtins.object
|
| Methods defined here:
|
| __init__(self, *, verify_ssl: bool = True, fingerprint: bytes | None = None, use_dns_cache: bool = True, ttl_dns_cache: int | None = 10, dns_cache_max_size: int = 1000, family: socket.AddressFamily = <AddressFamily.AF_UNSPEC: 0>, ssl_context: ssl.SSLContext | None = None, ssl: bool | aiohttp.client_reqrep.Fingerprint | ssl.SSLContext = True, local_addr: tuple[str, int] | None = None, resolver: aiohttp.abc.AbstractResolver | None = None, keepalive_timeout: None | float | object = <_SENTINEL.sentinel: 1>, force_close: bool = False, limit: int = 100, limit_per_host: int = 0, enable_cleanup_closed: bool = False, loop: asyncio.events.AbstractEventLoop | None = None, timeout_ceil_threshold: float = 5, happy_eyeballs_delay: float | None = 0.25, interleave: int | None = None, socket_factory: collections.abc.Callable[[tuple[int | socket.AddressFamily, int | socket.SocketKind, int, str, tuple]], socket.socket] | None = None, ssl_shutdown_timeout: aiohttp.helpers._SENTINEL | None | float = <_SENTINEL.sentinel: 1>)
| Initialize self. See help(type(self)) for accurate signature.
|
| clear_dns_cache(self, host: str | None = None, port: int | None = None) -> None
| Remove specified host/port or clear all dns local cache.
|
| async close(self, *, abort_ssl: bool = False) -> None
| Close all opened transports.
|
| :param abort_ssl: If True, SSL connections will be aborted immediately
| without performing the shutdown handshake. If False (default),
| the behavior is determined by ssl_shutdown_timeout:
| - If ssl_shutdown_timeout=0: connections are aborted
| - If ssl_shutdown_timeout>0: graceful shutdown is performed
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| family
| Socket family like AF_INET.
|
| use_dns_cache
| True if local DNS caching is enabled.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| allowed_protocol_schema_set = frozenset({'', 'http', 'https', 'tcp', '...
|
| ----------------------------------------------------------------------
| Methods inherited from BaseConnector:
|
| async __aenter__(self) -> 'BaseConnector'
|
| async __aexit__(self, exc_type: type[BaseException] | None = None, exc_value: BaseException | None = None, exc_traceback: traceback | None = None) -> None
|
| __del__(self, _warnings: Any = <module 'warnings' from 'C:\\Users\\Youse\\AppData\\Local\\Programs\\Python\\Python312\\Lib\\warnings.py'>) -> None
|
| __enter__(self) -> 'BaseConnector'
|
| __exit__(self, *exc: Any) -> None
|
| async connect(self, req: aiohttp.client_reqrep.ClientRequest, traces: list['Trace'], timeout: 'ClientTimeout') -> aiohttp.connector.Connection
| Get from pool or create new connection.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from BaseConnector:
|
| closed
| Is connector closed.
|
| A readonly property.
|
| force_close
| Ultimately close connection on releasing if True.
|
| limit
| The total number for simultaneous connections.
|
| If limit is 0 the connector has no limit.
| The default limit size is 100.
|
| limit_per_host
| The limit for simultaneous connections to the same endpoint.
|
| Endpoints are the same if they are have equal
| (host, port, is_ssl) triple.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseConnector:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.TextIOPayload
Python Library Documentation: class TextIOPayload in module aiohttp.payload
class TextIOPayload(IOBasePayload)
| TextIOPayload(value: <class 'TextIO'>, *args: Any, encoding: str | None = None, content_type: str | None = None, **kwargs: Any) -> None
|
| Method resolution order:
| TextIOPayload
| IOBasePayload
| Payload
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, value: <class 'TextIO'>, *args: Any, encoding: str | None = None, content_type: str | None = None, **kwargs: Any) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async as_bytes(self, encoding: str = 'utf-8', errors: str = 'strict') -> bytes
| Return bytes representation of the value.
|
| This method reads the entire text file content and returns it as bytes.
| It encodes the text content using the specified encoding.
| The file reading is performed in an executor to avoid blocking the event loop.
|
| decode(self, encoding: str = 'utf-8', errors: str = 'strict') -> str
| Return string representation of the value.
|
| WARNING: This method does blocking I/O and should not be called in the event loop.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {'_value': <class 'io.TextIOBase'>}
|
| ----------------------------------------------------------------------
| Methods inherited from IOBasePayload:
|
| async close(self) -> None
| Close the payload if it holds any resources.
|
| IMPORTANT: This method must not await anything that might not finish
| immediately, as it may be called during cleanup/cancellation. Schedule
| any long-running operations without awaiting them.
|
| async write(self, writer: aiohttp.abc.AbstractStreamWriter) -> None
| Write the entire file-like payload to the writer stream.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
|
| This method writes the entire file content without any length constraint.
| It delegates to write_with_length() with no length limit for implementation
| consistency.
|
| Note:
| For new implementations that need length control, use write_with_length() directly.
| This method is maintained for backwards compatibility with existing code.
|
| async write_with_length(self, writer: aiohttp.abc.AbstractStreamWriter, content_length: int | None) -> None
| Write file-like payload with a specific content length constraint.
|
| Args:
| writer: An AbstractStreamWriter instance that handles the actual writing
| content_length: Maximum number of bytes to write (None for unlimited)
|
| This method implements optimized streaming of file content with length constraints:
|
| 1. File reading is performed in a thread pool to avoid blocking the event loop
| 2. Content is read and written in chunks to maintain memory efficiency
| 3. Writing stops when either:
| - All available file content has been written (when size is known)
| - The specified content_length has been reached
| 4. File resources are properly closed even if the operation is cancelled
|
| The implementation carefully handles both known-size and unknown-size payloads,
| as well as constrained and unconstrained content lengths.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from IOBasePayload:
|
| size
| Size of the payload in bytes.
|
| Returns the total size of the payload content from the initial position.
| This ensures consistent Content-Length for requests, including 307/308 redirects
| where the same payload instance is reused.
|
| Returns None if the size cannot be determined (e.g., for unseekable streams).
|
| ----------------------------------------------------------------------
| Methods inherited from Payload:
|
| set_content_disposition(self, disptype: str, quote_fields: bool = True, _charset: str = 'utf-8', **params: Any) -> None
| Sets ``Content-Disposition`` header.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from Payload:
|
| autoclose
| Whether the payload can close itself automatically.
|
| Returns True if the payload has no file handles or resources that need
| explicit closing. If False, callers must await close() to release resources.
|
| consumed
| Whether the payload has been consumed and cannot be reused.
|
| content_type
| Content type
|
| encoding
| Payload encoding
|
| filename
| Filename of the payload.
|
| headers
| Custom item headers
|
| ----------------------------------------------------------------------
| Data descriptors inherited from Payload:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.ThreadedResolver
Python Library Documentation: class ThreadedResolver in module aiohttp.resolver
class ThreadedResolver(aiohttp.abc.AbstractResolver)
| ThreadedResolver(loop: asyncio.events.AbstractEventLoop | None = None) -> None
|
| Threaded resolver.
|
| Uses an Executor for synchronous getaddrinfo() calls.
| concurrent.futures.ThreadPoolExecutor is used by default.
|
| Method resolution order:
| ThreadedResolver
| aiohttp.abc.AbstractResolver
| abc.ABC
| builtins.object
|
| Methods defined here:
|
| __init__(self, loop: asyncio.events.AbstractEventLoop | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| async close(self) -> None
| Release resolver
|
| async resolve(self, host: str, port: int = 0, family: socket.AddressFamily = <AddressFamily.AF_INET: 2>) -> list[aiohttp.abc.ResolveResult]
| Return IP address for given hostname
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Data descriptors inherited from aiohttp.abc.AbstractResolver:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.TooManyRedirects
Python Library Documentation: class TooManyRedirects in module aiohttp.client_exceptions
class TooManyRedirects(ClientResponseError)
| TooManyRedirects(request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
|
| Client was redirected too many times.
|
| Method resolution order:
| TooManyRedirects
| ClientResponseError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientResponseError:
|
| __init__(self, request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientResponseError:
|
| code
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.TraceConfig
Python Library Documentation: class TraceConfig in module aiohttp.tracing class TraceConfig(builtins.object) | TraceConfig(trace_config_ctx_factory: type[types.SimpleNamespace] = <class 'types.SimpleNamespace'>) -> None | | First-class used to trace requests launched via ClientSession objects. | | Methods defined here: | | __init__(self, trace_config_ctx_factory: type[types.SimpleNamespace] = <class 'types.SimpleNamespace'>) -> None | Initialize self. See help(type(self)) for accurate signature. | | freeze(self) -> None | | trace_config_ctx(self, trace_request_ctx: Any = None) -> types.SimpleNamespace | Return a new trace_config_ctx instance | | ---------------------------------------------------------------------- | Readonly properties defined here: | | on_connection_create_end | | on_connection_create_start | | on_connection_queued_end | | on_connection_queued_start | | on_connection_reuseconn | | on_dns_cache_hit | | on_dns_cache_miss | | on_dns_resolvehost_end | | on_dns_resolvehost_start | | on_request_chunk_sent | | on_request_end | | on_request_exception | | on_request_headers_sent | | on_request_redirect | | on_request_start | | on_response_chunk_received | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
aiohttp.TraceConnectionCreateEndParams
Python Library Documentation: class TraceConnectionCreateEndParams in module aiohttp.tracing class TraceConnectionCreateEndParams(builtins.object) | TraceConnectionCreateEndParams() -> None | | Parameters sent by the `on_connection_create_end` signal | | Methods defined here: | | __delattr__ = _frozen_delattrs(self, name) from attr._make | Attached to frozen classes as __delattr__. | | __eq__(self, other) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __ge__(self, other) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | __gt__(self, other) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __hash__(self) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __init__(self) -> None | Method generated by attrs for class TraceConnectionCreateEndParams. | | __le__(self, other) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __lt__(self, other) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __ne__(self, other) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __repr__(self) | Method generated by attrs for class TraceConnectionCreateEndParams. | | __setattr__ = _frozen_setattrs(self, name, value) from attr._make | Attached to frozen classes as __setattr__. | | __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __attrs_attrs__ = () | | __match_args__ = ()
aiohttp.TraceConnectionCreateStartParams
Python Library Documentation: class TraceConnectionCreateStartParams in module aiohttp.tracing class TraceConnectionCreateStartParams(builtins.object) | TraceConnectionCreateStartParams() -> None | | Parameters sent by the `on_connection_create_start` signal | | Methods defined here: | | __delattr__ = _frozen_delattrs(self, name) from attr._make | Attached to frozen classes as __delattr__. | | __eq__(self, other) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __ge__(self, other) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | __gt__(self, other) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __hash__(self) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __init__(self) -> None | Method generated by attrs for class TraceConnectionCreateStartParams. | | __le__(self, other) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __lt__(self, other) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __ne__(self, other) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __repr__(self) | Method generated by attrs for class TraceConnectionCreateStartParams. | | __setattr__ = _frozen_setattrs(self, name, value) from attr._make | Attached to frozen classes as __setattr__. | | __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __attrs_attrs__ = () | | __match_args__ = ()
aiohttp.TraceConnectionQueuedEndParams
Python Library Documentation: class TraceConnectionQueuedEndParams in module aiohttp.tracing class TraceConnectionQueuedEndParams(builtins.object) | TraceConnectionQueuedEndParams() -> None | | Parameters sent by the `on_connection_queued_end` signal | | Methods defined here: | | __delattr__ = _frozen_delattrs(self, name) from attr._make | Attached to frozen classes as __delattr__. | | __eq__(self, other) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __ge__(self, other) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | __gt__(self, other) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __hash__(self) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __init__(self) -> None | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __le__(self, other) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __lt__(self, other) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __ne__(self, other) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __repr__(self) | Method generated by attrs for class TraceConnectionQueuedEndParams. | | __setattr__ = _frozen_setattrs(self, name, value) from attr._make | Attached to frozen classes as __setattr__. | | __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __attrs_attrs__ = () | | __match_args__ = ()
aiohttp.TraceConnectionQueuedStartParams
Python Library Documentation: class TraceConnectionQueuedStartParams in module aiohttp.tracing class TraceConnectionQueuedStartParams(builtins.object) | TraceConnectionQueuedStartParams() -> None | | Parameters sent by the `on_connection_queued_start` signal | | Methods defined here: | | __delattr__ = _frozen_delattrs(self, name) from attr._make | Attached to frozen classes as __delattr__. | | __eq__(self, other) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __ge__(self, other) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | __gt__(self, other) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __hash__(self) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __init__(self) -> None | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __le__(self, other) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __lt__(self, other) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __ne__(self, other) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __repr__(self) | Method generated by attrs for class TraceConnectionQueuedStartParams. | | __setattr__ = _frozen_setattrs(self, name, value) from attr._make | Attached to frozen classes as __setattr__. | | __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __attrs_attrs__ = () | | __match_args__ = ()
aiohttp.TraceConnectionReuseconnParams
Python Library Documentation: class TraceConnectionReuseconnParams in module aiohttp.tracing class TraceConnectionReuseconnParams(builtins.object) | TraceConnectionReuseconnParams() -> None | | Parameters sent by the `on_connection_reuseconn` signal | | Methods defined here: | | __delattr__ = _frozen_delattrs(self, name) from attr._make | Attached to frozen classes as __delattr__. | | __eq__(self, other) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __ge__(self, other) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | __gt__(self, other) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __hash__(self) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __init__(self) -> None | Method generated by attrs for class TraceConnectionReuseconnParams. | | __le__(self, other) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __lt__(self, other) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __ne__(self, other) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __repr__(self) | Method generated by attrs for class TraceConnectionReuseconnParams. | | __setattr__ = _frozen_setattrs(self, name, value) from attr._make | Attached to frozen classes as __setattr__. | | __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals> | Automatically created by attrs. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | __attrs_attrs__ = () | | __match_args__ = ()
aiohttp.TraceDnsCacheHitParams
Python Library Documentation: class TraceDnsCacheHitParams in module aiohttp.tracing
class TraceDnsCacheHitParams(builtins.object)
| TraceDnsCacheHitParams(host: str) -> None
|
| Parameters sent by the `on_dns_cache_hit` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __hash__(self)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __init__(self, host: str) -> None
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __repr__(self)
| Method generated by attrs for class TraceDnsCacheHitParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| host
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'host': <class 'str'>}
|
| __attrs_attrs__ = (Attribute(name='host', default=NOTHING, validat...i...
|
| __match_args__ = ('host',)
aiohttp.TraceDnsCacheMissParams
Python Library Documentation: class TraceDnsCacheMissParams in module aiohttp.tracing
class TraceDnsCacheMissParams(builtins.object)
| TraceDnsCacheMissParams(host: str) -> None
|
| Parameters sent by the `on_dns_cache_miss` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __hash__(self)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __init__(self, host: str) -> None
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __repr__(self)
| Method generated by attrs for class TraceDnsCacheMissParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| host
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'host': <class 'str'>}
|
| __attrs_attrs__ = (Attribute(name='host', default=NOTHING, validat...i...
|
| __match_args__ = ('host',)
aiohttp.TraceDnsResolveHostEndParams
Python Library Documentation: class TraceDnsResolveHostEndParams in module aiohttp.tracing
class TraceDnsResolveHostEndParams(builtins.object)
| TraceDnsResolveHostEndParams(host: str) -> None
|
| Parameters sent by the `on_dns_resolvehost_end` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __hash__(self)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __init__(self, host: str) -> None
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __repr__(self)
| Method generated by attrs for class TraceDnsResolveHostEndParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| host
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'host': <class 'str'>}
|
| __attrs_attrs__ = (Attribute(name='host', default=NOTHING, validat...i...
|
| __match_args__ = ('host',)
aiohttp.TraceDnsResolveHostStartParams
Python Library Documentation: class TraceDnsResolveHostStartParams in module aiohttp.tracing
class TraceDnsResolveHostStartParams(builtins.object)
| TraceDnsResolveHostStartParams(host: str) -> None
|
| Parameters sent by the `on_dns_resolvehost_start` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __hash__(self)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __init__(self, host: str) -> None
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __repr__(self)
| Method generated by attrs for class TraceDnsResolveHostStartParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| host
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'host': <class 'str'>}
|
| __attrs_attrs__ = (Attribute(name='host', default=NOTHING, validat...i...
|
| __match_args__ = ('host',)
aiohttp.TraceRequestChunkSentParams
Python Library Documentation: class TraceRequestChunkSentParams in module aiohttp.tracing
class TraceRequestChunkSentParams(builtins.object)
| TraceRequestChunkSentParams(method: str, url: yarl.URL, chunk: bytes) -> None
|
| Parameters sent by the `on_request_chunk_sent` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __hash__(self)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __init__(self, method: str, url: yarl.URL, chunk: bytes) -> None
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __repr__(self)
| Method generated by attrs for class TraceRequestChunkSentParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| chunk
|
| method
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'chunk': <class 'bytes'>, 'method': <class 'str'>, ...
|
| __attrs_attrs__ = (Attribute(name='method', default=NOTHING, valid...i...
|
| __match_args__ = ('method', 'url', 'chunk')
aiohttp.TraceRequestEndParams
Python Library Documentation: class TraceRequestEndParams in module aiohttp.tracing
class TraceRequestEndParams(builtins.object)
| TraceRequestEndParams(method: str, url: yarl.URL, headers: 'CIMultiDict[str]', response: aiohttp.client_reqrep.ClientResponse) -> None
|
| Parameters sent by the `on_request_end` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceRequestEndParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceRequestEndParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceRequestEndParams.
|
| __hash__(self)
| Method generated by attrs for class TraceRequestEndParams.
|
| __init__(self, method: str, url: yarl.URL, headers: 'CIMultiDict[str]', response: aiohttp.client_reqrep.ClientResponse) -> None
| Method generated by attrs for class TraceRequestEndParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceRequestEndParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceRequestEndParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceRequestEndParams.
|
| __repr__(self)
| Method generated by attrs for class TraceRequestEndParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| headers
|
| method
|
| response
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'headers': 'CIMultiDict[str]', 'method': <class 'st...
|
| __attrs_attrs__ = (Attribute(name='method', default=NOTHING, valid...e...
|
| __match_args__ = ('method', 'url', 'headers', 'response')
aiohttp.TraceRequestExceptionParams
Python Library Documentation: class TraceRequestExceptionParams in module aiohttp.tracing
class TraceRequestExceptionParams(builtins.object)
| TraceRequestExceptionParams(method: str, url: yarl.URL, headers: 'CIMultiDict[str]', exception: BaseException) -> None
|
| Parameters sent by the `on_request_exception` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __hash__(self)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __init__(self, method: str, url: yarl.URL, headers: 'CIMultiDict[str]', exception: BaseException) -> None
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __repr__(self)
| Method generated by attrs for class TraceRequestExceptionParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| exception
|
| headers
|
| method
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'exception': <class 'BaseException'>, 'headers': 'C...
|
| __attrs_attrs__ = (Attribute(name='method', default=NOTHING, valid...r...
|
| __match_args__ = ('method', 'url', 'headers', 'exception')
aiohttp.TraceRequestHeadersSentParams
Python Library Documentation: class TraceRequestHeadersSentParams in module aiohttp.tracing
class TraceRequestHeadersSentParams(builtins.object)
| TraceRequestHeadersSentParams(method: str, url: yarl.URL, headers: 'CIMultiDict[str]') -> None
|
| Parameters sent by the `on_request_headers_sent` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __hash__(self)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __init__(self, method: str, url: yarl.URL, headers: 'CIMultiDict[str]') -> None
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __repr__(self)
| Method generated by attrs for class TraceRequestHeadersSentParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| headers
|
| method
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'headers': 'CIMultiDict[str]', 'method': <class 'st...
|
| __attrs_attrs__ = (Attribute(name='method', default=NOTHING, valid...h...
|
| __match_args__ = ('method', 'url', 'headers')
aiohttp.TraceRequestRedirectParams
Python Library Documentation: class TraceRequestRedirectParams in module aiohttp.tracing
class TraceRequestRedirectParams(builtins.object)
| TraceRequestRedirectParams(method: str, url: yarl.URL, headers: 'CIMultiDict[str]', response: aiohttp.client_reqrep.ClientResponse) -> None
|
| Parameters sent by the `on_request_redirect` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __hash__(self)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __init__(self, method: str, url: yarl.URL, headers: 'CIMultiDict[str]', response: aiohttp.client_reqrep.ClientResponse) -> None
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __repr__(self)
| Method generated by attrs for class TraceRequestRedirectParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| headers
|
| method
|
| response
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'headers': 'CIMultiDict[str]', 'method': <class 'st...
|
| __attrs_attrs__ = (Attribute(name='method', default=NOTHING, valid...e...
|
| __match_args__ = ('method', 'url', 'headers', 'response')
aiohttp.TraceRequestStartParams
Python Library Documentation: class TraceRequestStartParams in module aiohttp.tracing
class TraceRequestStartParams(builtins.object)
| TraceRequestStartParams(method: str, url: yarl.URL, headers: 'CIMultiDict[str]') -> None
|
| Parameters sent by the `on_request_start` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceRequestStartParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceRequestStartParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceRequestStartParams.
|
| __hash__(self)
| Method generated by attrs for class TraceRequestStartParams.
|
| __init__(self, method: str, url: yarl.URL, headers: 'CIMultiDict[str]') -> None
| Method generated by attrs for class TraceRequestStartParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceRequestStartParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceRequestStartParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceRequestStartParams.
|
| __repr__(self)
| Method generated by attrs for class TraceRequestStartParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| headers
|
| method
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'headers': 'CIMultiDict[str]', 'method': <class 'st...
|
| __attrs_attrs__ = (Attribute(name='method', default=NOTHING, valid...h...
|
| __match_args__ = ('method', 'url', 'headers')
aiohttp.TraceResponseChunkReceivedParams
Python Library Documentation: class TraceResponseChunkReceivedParams in module aiohttp.tracing
class TraceResponseChunkReceivedParams(builtins.object)
| TraceResponseChunkReceivedParams(method: str, url: yarl.URL, chunk: bytes) -> None
|
| Parameters sent by the `on_response_chunk_received` signal
|
| Methods defined here:
|
| __delattr__ = _frozen_delattrs(self, name) from attr._make
| Attached to frozen classes as __delattr__.
|
| __eq__(self, other)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __ge__(self, other)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __getstate__ = slots_getstate(self) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| __gt__(self, other)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __hash__(self)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __init__(self, method: str, url: yarl.URL, chunk: bytes) -> None
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __le__(self, other)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __lt__(self, other)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __ne__(self, other)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __repr__(self)
| Method generated by attrs for class TraceResponseChunkReceivedParams.
|
| __setattr__ = _frozen_setattrs(self, name, value) from attr._make
| Attached to frozen classes as __setattr__.
|
| __setstate__ = slots_setstate(self, state) from attr._make._ClassBuilder._make_getstate_setstate.<locals>
| Automatically created by attrs.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| chunk
|
| method
|
| url
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'chunk': <class 'bytes'>, 'method': <class 'str'>, ...
|
| __attrs_attrs__ = (Attribute(name='method', default=NOTHING, valid...i...
|
| __match_args__ = ('method', 'url', 'chunk')
aiohttp.UnixConnector
Python Library Documentation: class UnixConnector in module aiohttp.connector
class UnixConnector(BaseConnector)
| UnixConnector(path: str, force_close: bool = False, keepalive_timeout: object | float | None = <_SENTINEL.sentinel: 1>, limit: int = 100, limit_per_host: int = 0, loop: asyncio.events.AbstractEventLoop | None = None) -> None
|
| Unix socket connector.
|
| path - Unix socket path.
| keepalive_timeout - (optional) Keep-alive timeout.
| force_close - Set to True to force close and do reconnect
| after each request (and between redirects).
| limit - The total number of simultaneous connections.
| limit_per_host - Number of simultaneous connections to one host.
| loop - Optional event loop.
|
| Method resolution order:
| UnixConnector
| BaseConnector
| builtins.object
|
| Methods defined here:
|
| __init__(self, path: str, force_close: bool = False, keepalive_timeout: object | float | None = <_SENTINEL.sentinel: 1>, limit: int = 100, limit_per_host: int = 0, loop: asyncio.events.AbstractEventLoop | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| path
| Path to unix socket.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| allowed_protocol_schema_set = frozenset({'', 'http', 'https', 'unix', ...
|
| ----------------------------------------------------------------------
| Methods inherited from BaseConnector:
|
| async __aenter__(self) -> 'BaseConnector'
|
| async __aexit__(self, exc_type: type[BaseException] | None = None, exc_value: BaseException | None = None, exc_traceback: traceback | None = None) -> None
|
| __del__(self, _warnings: Any = <module 'warnings' from 'C:\\Users\\Youse\\AppData\\Local\\Programs\\Python\\Python312\\Lib\\warnings.py'>) -> None
|
| __enter__(self) -> 'BaseConnector'
|
| __exit__(self, *exc: Any) -> None
|
| close(self, *, abort_ssl: bool = False) -> collections.abc.Awaitable[None]
| Close all opened transports.
|
| :param abort_ssl: If True, SSL connections will be aborted immediately
| without performing the shutdown handshake. This provides
| faster cleanup at the cost of less graceful disconnection.
|
| async connect(self, req: aiohttp.client_reqrep.ClientRequest, traces: list['Trace'], timeout: 'ClientTimeout') -> aiohttp.connector.Connection
| Get from pool or create new connection.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from BaseConnector:
|
| closed
| Is connector closed.
|
| A readonly property.
|
| force_close
| Ultimately close connection on releasing if True.
|
| limit
| The total number for simultaneous connections.
|
| If limit is 0 the connector has no limit.
| The default limit size is 100.
|
| limit_per_host
| The limit for simultaneous connections to the same endpoint.
|
| Endpoints are the same if they are have equal
| (host, port, is_ssl) triple.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from BaseConnector:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
aiohttp.WSCloseCode
Python Library Documentation: class WSCloseCode in module aiohttp._websocket.models class WSCloseCode(enum.IntEnum) | WSCloseCode(*values) | | Method resolution order: | WSCloseCode | enum.IntEnum | builtins.int | enum.ReprEnum | enum.Enum | builtins.object | | Methods defined here: | | __format__(self, format_spec, /) from builtins.int | Convert to a string according to format_spec. | | __new__(cls, value) from enum.Enum | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | ABNORMAL_CLOSURE = <WSCloseCode.ABNORMAL_CLOSURE: 1006> | | BAD_GATEWAY = <WSCloseCode.BAD_GATEWAY: 1014> | | GOING_AWAY = <WSCloseCode.GOING_AWAY: 1001> | | INTERNAL_ERROR = <WSCloseCode.INTERNAL_ERROR: 1011> | | INVALID_TEXT = <WSCloseCode.INVALID_TEXT: 1007> | | MANDATORY_EXTENSION = <WSCloseCode.MANDATORY_EXTENSION: 1010> | | MESSAGE_TOO_BIG = <WSCloseCode.MESSAGE_TOO_BIG: 1009> | | OK = <WSCloseCode.OK: 1000> | | POLICY_VIOLATION = <WSCloseCode.POLICY_VIOLATION: 1008> | | PROTOCOL_ERROR = <WSCloseCode.PROTOCOL_ERROR: 1002> | | SERVICE_RESTART = <WSCloseCode.SERVICE_RESTART: 1012> | | TRY_AGAIN_LATER = <WSCloseCode.TRY_AGAIN_LATER: 1013> | | UNSUPPORTED_DATA = <WSCloseCode.UNSUPPORTED_DATA: 1003> | | ---------------------------------------------------------------------- | Methods inherited from enum.IntEnum: | | __repr__(self) from enum.Enum | Return repr(self). | | __str__ = __repr__(self, /) from builtins.int | Return repr(self). | | ---------------------------------------------------------------------- | Methods inherited from builtins.int: | | __abs__(self, /) | abs(self) | | __add__(self, value, /) | Return self+value. | | __and__(self, value, /) | Return self&value. | | __bool__(self, /) | True if self else False | | __ceil__(...) | Ceiling of an Integral returns itself. | | __divmod__(self, value, /) | Return divmod(self, value). | | __eq__(self, value, /) | Return self==value. | | __float__(self, /) | float(self) | | __floor__(...) | Flooring an Integral returns itself. | | __floordiv__(self, value, /) | Return self//value. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __index__(self, /) | Return self converted to an integer, if self is suitable for use as an index into a list. | | __int__(self, /) | int(self) | | __invert__(self, /) | ~self | | __le__(self, value, /) | Return self<=value. | | __lshift__(self, value, /) | Return self<<value. | | __lt__(self, value, /) | Return self<value. | | __mod__(self, value, /) | Return self%value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __neg__(self, /) | -self | | __or__(self, value, /) | Return self|value. | | __pos__(self, /) | +self | | __pow__(self, value, mod=None, /) | Return pow(self, value, mod). | | __radd__(self, value, /) | Return value+self. | | __rand__(self, value, /) | Return value&self. | | __rdivmod__(self, value, /) | Return divmod(value, self). | | __rfloordiv__(self, value, /) | Return value//self. | | __rlshift__(self, value, /) | Return value<<self. | | __rmod__(self, value, /) | Return value%self. | | __rmul__(self, value, /) | Return value*self. | | __ror__(self, value, /) | Return value|self. | | __round__(...) | Rounding an Integral returns itself. | | Rounding with an ndigits argument also returns an integer. | | __rpow__(self, value, mod=None, /) | Return pow(value, self, mod). | | __rrshift__(self, value, /) | Return value>>self. | | __rshift__(self, value, /) | Return self>>value. | | __rsub__(self, value, /) | Return value-self. | | __rtruediv__(self, value, /) | Return value/self. | | __rxor__(self, value, /) | Return value^self. | | __sizeof__(self, /) | Returns size in memory, in bytes. | | __sub__(self, value, /) | Return self-value. | | __truediv__(self, value, /) | Return self/value. | | __trunc__(...) | Truncating an Integral returns itself. | | __xor__(self, value, /) | Return self^value. | | as_integer_ratio(self, /) | Return a pair of integers, whose ratio is equal to the original int. | | The ratio is in lowest terms and has a positive denominator. | | >>> (10).as_integer_ratio() | (10, 1) | >>> (-10).as_integer_ratio() | (-10, 1) | >>> (0).as_integer_ratio() | (0, 1) | | bit_count(self, /) | Number of ones in the binary representation of the absolute value of self. | | Also known as the population count. | | >>> bin(13) | '0b1101' | >>> (13).bit_count() | 3 | | bit_length(self, /) | Number of bits necessary to represent self in binary. | | >>> bin(37) | '0b100101' | >>> (37).bit_length() | 6 | | conjugate(...) | Returns self, the complex conjugate of any int. | | is_integer(self, /) | Returns True. Exists for duck type compatibility with float.is_integer. | | to_bytes(self, /, length=1, byteorder='big', *, signed=False) | Return an array of bytes representing an integer. | | length | Length of bytes object to use. An OverflowError is raised if the | integer is not representable with the given number of bytes. Default | is length 1. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Determines whether two's complement is used to represent the integer. | If signed is False and a negative integer is given, an OverflowError | is raised. | | ---------------------------------------------------------------------- | Class methods inherited from builtins.int: | | from_bytes(bytes, byteorder='big', *, signed=False) | Return the integer represented by the given array of bytes. | | bytes | Holds the array of bytes to convert. The argument must either | support the buffer protocol or be an iterable object producing bytes. | Bytes and bytearray are examples of built-in objects that support the | buffer protocol. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Indicates whether two's complement is used to represent the integer. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.int: | | denominator | the denominator of a rational number in lowest terms | | imag | the imaginary part of a complex number | | numerator | the numerator of a rational number in lowest terms | | real | the real part of a complex number | | ---------------------------------------------------------------------- | Methods inherited from enum.Enum: | | __dir__(self) | Returns public methods and other interesting attributes. | | __init__(self, *args, **kwds) | Initialize self. See help(type(self)) for accurate signature. | | __reduce_ex__(self, proto) | Helper for pickle. | | ---------------------------------------------------------------------- | Data descriptors inherited from enum.Enum: | | name | The name of the Enum member. | | value | The value of the Enum member. | | ---------------------------------------------------------------------- | Static methods inherited from enum.EnumType: | | __contains__(value) | Return True if `value` is in `cls`. | | `value` is in `cls` if: | 1) `value` is a member of `cls`, or | 2) `value` is the value of one of the `cls`'s members. | | __getitem__(name) | Return the member matching `name`. | | __iter__() | Return members in definition order. | | __len__() | Return the number of members (no aliases) | | ---------------------------------------------------------------------- | Readonly properties inherited from enum.EnumType: | | __members__ | Returns a mapping of member name->value. | | This mapping lists all enum members, including aliases. Note that this | is a read-only view of the internal mapping.
aiohttp.WSMessage
Python Library Documentation: class WSMessage in module aiohttp._websocket.models
class WSMessage(builtins.tuple)
| WSMessage(type: aiohttp._websocket.models.WSMsgType, data: Any, extra: str | None)
|
| WSMessage(type, data, extra)
|
| Method resolution order:
| WSMessage
| builtins.tuple
| builtins.object
|
| Methods defined here:
|
| __getnewargs__(self) from collections.WSMessage
| Return self as a plain tuple. Used by copy and pickle.
|
| __repr__(self) from collections.WSMessage
| Return a nicely formatted representation string
|
| _asdict(self) from collections.WSMessage
| Return a new dict which maps field names to their values.
|
| _replace(self, /, **kwds) from collections.WSMessage
| Return a new WSMessage object replacing specified fields with new values
|
| json(self, *, loads: collections.abc.Callable[[typing.Any], typing.Any] = <function loads at 0x0000022698C144A0>) -> Any
| Return parsed JSON data.
|
| .. versionadded:: 0.22
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| _make(iterable) from collections.WSMessage
| Make a new WSMessage object from a sequence or iterable
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| __new__(_cls, type: aiohttp._websocket.models.WSMsgType, data: Any, extra: str | None) from namedtuple_WSMessage.WSMessage
| Create new instance of WSMessage(type, data, extra)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| type
| Alias for field number 0
|
| data
| Alias for field number 1
|
| extra
| Alias for field number 2
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {'data': typing.Any, 'extra': str | None, 'type': <e...
|
| __match_args__ = ('type', 'data', 'extra')
|
| __orig_bases__ = (<function NamedTuple>,)
|
| _field_defaults = {}
|
| _fields = ('type', 'data', 'extra')
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.tuple:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __getitem__(self, key, /)
| Return self[key].
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmul__(self, value, /)
| Return value*self.
|
| count(self, value, /)
| Return number of occurrences of value.
|
| index(self, value, start=0, stop=9223372036854775807, /)
| Return first index of value.
|
| Raises ValueError if the value is not present.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.tuple:
|
| __class_getitem__(...)
| See PEP 585
aiohttp.WSMessageTypeError
Python Library Documentation: class WSMessageTypeError in module aiohttp.client_exceptions class WSMessageTypeError(builtins.TypeError) | WebSocket message type is not valid. | | Method resolution order: | WSMessageTypeError | builtins.TypeError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.TypeError: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.TypeError: | | __new__(*args, **kwargs) class method of builtins.TypeError | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
aiohttp.WSMsgType
Python Library Documentation: class WSMsgType in module aiohttp._websocket.models class WSMsgType(enum.IntEnum) | WSMsgType(*values) | | Method resolution order: | WSMsgType | enum.IntEnum | builtins.int | enum.ReprEnum | enum.Enum | builtins.object | | Methods defined here: | | __format__(self, format_spec, /) from builtins.int | Convert to a string according to format_spec. | | __new__(cls, value) from enum.Enum | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | BINARY = <WSMsgType.BINARY: 2> | | CLOSE = <WSMsgType.CLOSE: 8> | | CLOSED = <WSMsgType.CLOSED: 257> | | CLOSING = <WSMsgType.CLOSING: 256> | | CONTINUATION = <WSMsgType.CONTINUATION: 0> | | ERROR = <WSMsgType.ERROR: 258> | | PING = <WSMsgType.PING: 9> | | PONG = <WSMsgType.PONG: 10> | | TEXT = <WSMsgType.TEXT: 1> | | ---------------------------------------------------------------------- | Methods inherited from enum.IntEnum: | | __repr__(self) from enum.Enum | Return repr(self). | | __str__ = __repr__(self, /) from builtins.int | Return repr(self). | | ---------------------------------------------------------------------- | Methods inherited from builtins.int: | | __abs__(self, /) | abs(self) | | __add__(self, value, /) | Return self+value. | | __and__(self, value, /) | Return self&value. | | __bool__(self, /) | True if self else False | | __ceil__(...) | Ceiling of an Integral returns itself. | | __divmod__(self, value, /) | Return divmod(self, value). | | __eq__(self, value, /) | Return self==value. | | __float__(self, /) | float(self) | | __floor__(...) | Flooring an Integral returns itself. | | __floordiv__(self, value, /) | Return self//value. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __index__(self, /) | Return self converted to an integer, if self is suitable for use as an index into a list. | | __int__(self, /) | int(self) | | __invert__(self, /) | ~self | | __le__(self, value, /) | Return self<=value. | | __lshift__(self, value, /) | Return self<<value. | | __lt__(self, value, /) | Return self<value. | | __mod__(self, value, /) | Return self%value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __neg__(self, /) | -self | | __or__(self, value, /) | Return self|value. | | __pos__(self, /) | +self | | __pow__(self, value, mod=None, /) | Return pow(self, value, mod). | | __radd__(self, value, /) | Return value+self. | | __rand__(self, value, /) | Return value&self. | | __rdivmod__(self, value, /) | Return divmod(value, self). | | __rfloordiv__(self, value, /) | Return value//self. | | __rlshift__(self, value, /) | Return value<<self. | | __rmod__(self, value, /) | Return value%self. | | __rmul__(self, value, /) | Return value*self. | | __ror__(self, value, /) | Return value|self. | | __round__(...) | Rounding an Integral returns itself. | | Rounding with an ndigits argument also returns an integer. | | __rpow__(self, value, mod=None, /) | Return pow(value, self, mod). | | __rrshift__(self, value, /) | Return value>>self. | | __rshift__(self, value, /) | Return self>>value. | | __rsub__(self, value, /) | Return value-self. | | __rtruediv__(self, value, /) | Return value/self. | | __rxor__(self, value, /) | Return value^self. | | __sizeof__(self, /) | Returns size in memory, in bytes. | | __sub__(self, value, /) | Return self-value. | | __truediv__(self, value, /) | Return self/value. | | __trunc__(...) | Truncating an Integral returns itself. | | __xor__(self, value, /) | Return self^value. | | as_integer_ratio(self, /) | Return a pair of integers, whose ratio is equal to the original int. | | The ratio is in lowest terms and has a positive denominator. | | >>> (10).as_integer_ratio() | (10, 1) | >>> (-10).as_integer_ratio() | (-10, 1) | >>> (0).as_integer_ratio() | (0, 1) | | bit_count(self, /) | Number of ones in the binary representation of the absolute value of self. | | Also known as the population count. | | >>> bin(13) | '0b1101' | >>> (13).bit_count() | 3 | | bit_length(self, /) | Number of bits necessary to represent self in binary. | | >>> bin(37) | '0b100101' | >>> (37).bit_length() | 6 | | conjugate(...) | Returns self, the complex conjugate of any int. | | is_integer(self, /) | Returns True. Exists for duck type compatibility with float.is_integer. | | to_bytes(self, /, length=1, byteorder='big', *, signed=False) | Return an array of bytes representing an integer. | | length | Length of bytes object to use. An OverflowError is raised if the | integer is not representable with the given number of bytes. Default | is length 1. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Determines whether two's complement is used to represent the integer. | If signed is False and a negative integer is given, an OverflowError | is raised. | | ---------------------------------------------------------------------- | Class methods inherited from builtins.int: | | from_bytes(bytes, byteorder='big', *, signed=False) | Return the integer represented by the given array of bytes. | | bytes | Holds the array of bytes to convert. The argument must either | support the buffer protocol or be an iterable object producing bytes. | Bytes and bytearray are examples of built-in objects that support the | buffer protocol. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Indicates whether two's complement is used to represent the integer. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.int: | | denominator | the denominator of a rational number in lowest terms | | imag | the imaginary part of a complex number | | numerator | the numerator of a rational number in lowest terms | | real | the real part of a complex number | | ---------------------------------------------------------------------- | Methods inherited from enum.Enum: | | __dir__(self) | Returns public methods and other interesting attributes. | | __init__(self, *args, **kwds) | Initialize self. See help(type(self)) for accurate signature. | | __reduce_ex__(self, proto) | Helper for pickle. | | ---------------------------------------------------------------------- | Data descriptors inherited from enum.Enum: | | name | The name of the Enum member. | | value | The value of the Enum member. | | ---------------------------------------------------------------------- | Static methods inherited from enum.EnumType: | | __contains__(value) | Return True if `value` is in `cls`. | | `value` is in `cls` if: | 1) `value` is a member of `cls`, or | 2) `value` is the value of one of the `cls`'s members. | | __getitem__(name) | Return the member matching `name`. | | __iter__() | Return members in definition order. | | __len__() | Return the number of members (no aliases) | | ---------------------------------------------------------------------- | Readonly properties inherited from enum.EnumType: | | __members__ | Returns a mapping of member name->value. | | This mapping lists all enum members, including aliases. Note that this | is a read-only view of the internal mapping.
aiohttp.WSServerHandshakeError
Python Library Documentation: class WSServerHandshakeError in module aiohttp.client_exceptions
class WSServerHandshakeError(ClientResponseError)
| WSServerHandshakeError(request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
|
| websocket server handshake error.
|
| Method resolution order:
| WSServerHandshakeError
| ClientResponseError
| ClientError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from ClientResponseError:
|
| __init__(self, request_info: None, history: tuple[None, ...], *, code: int | None = None, status: int | None = None, message: str = '', headers: multidict._abc.MultiMapping[str] | None = None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __repr__(self) -> str
| Return repr(self).
|
| __str__(self) -> str
| Return str(self).
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientResponseError:
|
| code
|
| ----------------------------------------------------------------------
| Data descriptors inherited from ClientError:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __setstate__(...)
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
aiohttp.WebSocketError
Python Library Documentation: class WebSocketError in module aiohttp._websocket.models class WebSocketError(builtins.Exception) | WebSocketError(code: int, message: str) -> None | | WebSocket protocol parser error. | | Method resolution order: | WebSocketError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, code: int, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | __str__(self) -> str | Return str(self). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
aiohttp.content_disposition_filename
Python Library Documentation: function content_disposition_filename in module aiohttp.multipart content_disposition_filename(params: collections.abc.Mapping[str, str], name: str = 'filename') -> str | None
aiohttp.encode_basic_auth
Python Library Documentation: function encode_basic_auth in module aiohttp.helpers
encode_basic_auth(login: str, password: str = '', encoding: str = 'utf-8') -> str
Encode HTTP Basic Authentication credentials as an Authorization header value.
Returns a string of the form ``"Basic <base64>"`` suitable for use as the
value of the ``Authorization`` (or ``Proxy-Authorization``) header.
aiohttp.get_payload
Python Library Documentation: function get_payload in module aiohttp.payload get_payload(data: Any, *args: Any, **kwargs: Any) -> 'Payload'
aiohttp.hdrs
Python Library Documentation: module aiohttp.hdrs in aiohttp
NAME
aiohttp.hdrs - HTTP Headers constants.
DATA
ACCEPT = 'Accept'
ACCEPT_CHARSET = 'Accept-Charset'
ACCEPT_ENCODING = 'Accept-Encoding'
ACCEPT_LANGUAGE = 'Accept-Language'
ACCEPT_RANGES = 'Accept-Ranges'
ACCESS_CONTROL_ALLOW_CREDENTIALS = 'Access-Control-Allow-Credentials'
ACCESS_CONTROL_ALLOW_HEADERS = 'Access-Control-Allow-Headers'
ACCESS_CONTROL_ALLOW_METHODS = 'Access-Control-Allow-Methods'
ACCESS_CONTROL_ALLOW_ORIGIN = 'Access-Control-Allow-Origin'
ACCESS_CONTROL_EXPOSE_HEADERS = 'Access-Control-Expose-Headers'
ACCESS_CONTROL_MAX_AGE = 'Access-Control-Max-Age'
ACCESS_CONTROL_REQUEST_HEADERS = 'Access-Control-Request-Headers'
ACCESS_CONTROL_REQUEST_METHOD = 'Access-Control-Request-Method'
AGE = 'Age'
ALLOW = 'Allow'
AUTHORIZATION = 'Authorization'
CACHE_CONTROL = 'Cache-Control'
CONNECTION = 'Connection'
CONTENT_DISPOSITION = 'Content-Disposition'
CONTENT_ENCODING = 'Content-Encoding'
CONTENT_LANGUAGE = 'Content-Language'
CONTENT_LENGTH = 'Content-Length'
CONTENT_LOCATION = 'Content-Location'
CONTENT_MD5 = 'Content-MD5'
CONTENT_RANGE = 'Content-Range'
CONTENT_TRANSFER_ENCODING = 'Content-Transfer-Encoding'
CONTENT_TYPE = 'Content-Type'
COOKIE = 'Cookie'
DATE = 'Date'
DESTINATION = 'Destination'
DIGEST = 'Digest'
ETAG = 'Etag'
EXPECT = 'Expect'
EXPIRES = 'Expires'
FORWARDED = 'Forwarded'
FROM = 'From'
Final = typing.Final
Special typing construct to indicate final names to type checkers.
A final name cannot be re-assigned or overridden in a subclass.
For example::
MAX_SIZE: Final = 9000
MAX_SIZE += 1 # Error reported by type checker
class Connection:
TIMEOUT: Final[int] = 10
class FastConnector(Connection):
TIMEOUT = 1 # Error reported by type checker
There is no runtime checking of these properties.
HOST = 'Host'
HOST_ALL = frozenset({'HOST', 'HOSt', 'HOsT', 'HOst', 'HoST', 'HoSt', ...
IF_MATCH = 'If-Match'
IF_MODIFIED_SINCE = 'If-Modified-Since'
IF_NONE_MATCH = 'If-None-Match'
IF_RANGE = 'If-Range'
IF_UNMODIFIED_SINCE = 'If-Unmodified-Since'
KEEP_ALIVE = 'Keep-Alive'
LAST_EVENT_ID = 'Last-Event-ID'
LAST_MODIFIED = 'Last-Modified'
LINK = 'Link'
LOCATION = 'Location'
MAX_FORWARDS = 'Max-Forwards'
METH_ALL = {'CONNECT', 'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', .....
METH_ANY = '*'
METH_CONNECT = 'CONNECT'
METH_CONNECT_ALL = frozenset({'CONNECT', 'CONNECt', 'CONNEcT', 'CONNEc...
METH_DELETE = 'DELETE'
METH_GET = 'GET'
METH_HEAD = 'HEAD'
METH_HEAD_ALL = frozenset({'HEAD', 'HEAd', 'HEaD', 'HEad', 'HeAD', 'He...
METH_OPTIONS = 'OPTIONS'
METH_PATCH = 'PATCH'
METH_POST = 'POST'
METH_PUT = 'PUT'
METH_TRACE = 'TRACE'
ORIGIN = 'Origin'
PRAGMA = 'Pragma'
PROXY_AUTHENTICATE = 'Proxy-Authenticate'
PROXY_AUTHORIZATION = 'Proxy-Authorization'
RANGE = 'Range'
REFERER = 'Referer'
RETRY_AFTER = 'Retry-After'
SEC_WEBSOCKET_ACCEPT = 'Sec-WebSocket-Accept'
SEC_WEBSOCKET_EXTENSIONS = 'Sec-WebSocket-Extensions'
SEC_WEBSOCKET_KEY = 'Sec-WebSocket-Key'
SEC_WEBSOCKET_KEY1 = 'Sec-WebSocket-Key1'
SEC_WEBSOCKET_PROTOCOL = 'Sec-WebSocket-Protocol'
SEC_WEBSOCKET_VERSION = 'Sec-WebSocket-Version'
SERVER = 'Server'
SET_COOKIE = 'Set-Cookie'
TE = 'TE'
TRAILER = 'Trailer'
TRANSFER_ENCODING = 'Transfer-Encoding'
UPGRADE = 'Upgrade'
URI = 'URI'
USER_AGENT = 'User-Agent'
VARY = 'Vary'
VIA = 'Via'
WANT_DIGEST = 'Want-Digest'
WARNING = 'Warning'
WWW_AUTHENTICATE = 'WWW-Authenticate'
X_FORWARDED_FOR = 'X-Forwarded-For'
X_FORWARDED_HOST = 'X-Forwarded-Host'
X_FORWARDED_PROTO = 'X-Forwarded-Proto'
__annotations__ = {'ACCEPT': typing.Final[multidict._multidict.istr], ...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\aiohttp\hdrs.py
aiohttp.parse_content_disposition
Python Library Documentation: function parse_content_disposition in module aiohttp.multipart parse_content_disposition(header: str | None) -> tuple[str | None, dict[str, str]]
aiohttp.payload_type
Python Library Documentation: class payload_type in module aiohttp.payload class payload_type(builtins.object) | payload_type(type: Any, *, order: aiohttp.payload.Order = <Order.normal: 'normal'>) -> None | | Methods defined here: | | __call__(self, factory: type['Payload']) -> type['Payload'] | Call self as a function. | | __init__(self, type: Any, *, order: aiohttp.payload.Order = <Order.normal: 'normal'>) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
aiohttp.request
Python Library Documentation: function request in module aiohttp.client
request(method: str, url: Union[str, yarl.URL], *, version: aiohttp.http_writer.HttpVersion = HttpVersion(major=1, minor=1), connector: aiohttp.connector.BaseConnector | None = None, loop: asyncio.events.AbstractEventLoop | None = None, **kwargs: Any) -> aiohttp.client._SessionRequestContextManager
Constructs and sends a request.
Returns response object.
method - HTTP method
url - request url
params - (optional) Dictionary or bytes to be sent in the query
string of the new request
data - (optional) Dictionary, bytes, or file-like object to
send in the body of the request
json - (optional) Any json compatible python object
headers - (optional) Dictionary of HTTP Headers to send with
the request
cookies - (optional) Dict object to send with the request
auth - (optional) BasicAuth named tuple represent HTTP Basic Auth
auth - aiohttp.helpers.BasicAuth
allow_redirects - (optional) If set to False, do not follow
redirects
version - Request HTTP version.
compress - Set to True if request has to be compressed
with deflate encoding.
chunked - Set to chunk size for chunked transfer encoding.
expect100 - Expect 100-continue response from server.
connector - BaseConnector sub-class instance to support
connection pooling.
read_until_eof - Read response until eof if response
does not have Content-Length header.
loop - Optional event loop.
timeout - Optional ClientTimeout settings structure, 5min
total timeout by default.
Usage::
>>> import aiohttp
>>> async with aiohttp.request('GET', 'http://python.org/') as resp:
... print(resp)
... data = await resp.read()
<ClientResponse(https://www.python.org/) [200 OK]>
aiohttp.set_zlib_backend
Python Library Documentation: function set_zlib_backend in module aiohttp.compression_utils set_zlib_backend(new_zlib_backend: aiohttp.compression_utils.ZLibBackendProtocol) -> None
aiohttp.streamer
Python Library Documentation: class streamer in module aiohttp.payload_streamer class streamer(builtins.object) | streamer(coro: collections.abc.Callable[..., collections.abc.Awaitable[None]]) -> None | | Methods defined here: | | __call__(self, *args: Any, **kwargs: Any) -> aiohttp.payload_streamer._stream_wrapper | Call self as a function. | | __init__(self, coro: collections.abc.Callable[..., collections.abc.Awaitable[None]]) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object