async_http.fetch
================

.. py:module:: async_http.fetch


Classes
-------

.. autoapisummary::

   async_http.fetch.HasUrl


Functions
---------

.. autoapisummary::

   async_http.fetch.raise_by_default
   async_http.fetch.default_callback
   async_http.fetch.fetch
   async_http.fetch.fetch_many
   async_http.fetch.async_aiohttp_get_all


Module Contents
---------------

.. py:class:: HasUrl

   Bases: :py:obj:`Protocol`


   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto(Protocol[T]):
           def meth(self) -> T:
               ...


   .. py:attribute:: url
      :type:  str


.. py:function:: raise_by_default(url: Any, exception: Exception) -> None

.. py:function:: default_callback(url: UrlType, response: Any) -> tuple[UrlType, Any]

.. py:function:: fetch(url: UrlType, session: aiohttp.ClientSession, response_attr: str = 'json', callback: FetchCallback[UrlType, tuple[UrlType, Any]] = default_callback, handle_exceptions: ErrFunc[UrlType] | None = raise_by_default) -> tuple[UrlType, Any]
                 fetch(url: UrlType, session: aiohttp.ClientSession, response_attr: str, callback: FetchCallback[_UrlTypeT, _T], handle_exceptions: ErrFunc[_UrlTypeT] | None = raise_by_default) -> _T
                 fetch(url: UrlType, session: aiohttp.ClientSession, response_attr: str = 'json', *, callback: FetchCallback[_UrlTypeT, _T], handle_exceptions: ErrFunc[_UrlTypeT] | None = raise_by_default) -> _T
   :async:


   Asynchronous get request. Pass handle_exceptions in order to get your
   desired error handling.

   :param callback: callback to handle the response.
   :param url: object that has an attribute url or a string
   :param session: instance of aiohttp.ClientSession()
   :param response_attr: valid, (awaitable) attribute for response object
   :param handle_exceptions: optional callback for handling exceptions
   :return: response_attr or handled exception return for each url


.. py:function:: fetch_many(urls: collections.abc.Sequence[UrlType], response_attr: str = 'json', fetch_func: FetchFunc[UrlType, tuple[UrlType, Any]] = fetch, callback: FetchCallback[UrlType, tuple[UrlType, Any]] = default_callback, handle_exceptions: HandleExceptionType[UrlType] = raise_by_default, timeout: aiohttp.ClientTimeout | None = None) -> list[tuple[UrlType, Any]]
                 fetch_many(urls: collections.abc.Sequence[UrlType], response_attr: str, fetch_func: FetchFunc[_UrlTypeT, _T], callback: FetchCallback[_UrlTypeT, _T], handle_exceptions: HandleExceptionType[_UrlTypeT] = raise_by_default, timeout: aiohttp.ClientTimeout | None = None) -> list[_T]
                 fetch_many(urls: collections.abc.Sequence[UrlType], response_attr: str = 'json', fetch_func: FetchFunc[_UrlTypeT, _T] = fetch, *, callback: FetchCallback[_UrlTypeT, _T], handle_exceptions: HandleExceptionType[_UrlTypeT] = raise_by_default, timeout: aiohttp.ClientTimeout | None = None) -> list[_T]
   :async:


   Registers a task per url using the coroutine fetch_func with correct
   signature. 


.. py:function:: async_aiohttp_get_all(urls: collections.abc.Sequence[UrlType], response_attr: str = 'json', callback: FetchCallback[UrlType, tuple[UrlType, Any]] = default_callback, handle_exceptions: HandleExceptionType[UrlType] = raise_by_default, timeout: aiohttp.ClientTimeout | None = None) -> list[tuple[UrlType, Any]]
                 async_aiohttp_get_all(urls: collections.abc.Sequence[UrlType], response_attr: str, callback: FetchCallback[_UrlTypeT, _T], handle_exceptions: HandleExceptionType[_UrlTypeT] = raise_by_default, timeout: aiohttp.ClientTimeout | None = None) -> list[_T]
                 async_aiohttp_get_all(urls: collections.abc.Sequence[UrlType], response_attr: str = 'json', *, callback: FetchCallback[_UrlTypeT, _T], handle_exceptions: HandleExceptionType[_UrlTypeT] = raise_by_default, timeout: aiohttp.ClientTimeout | None = None) -> list[_T]

   Performs asynchronous get requests.

   Example only checking the status without awaiting content:
       result = async_aiohttp_get_all(test_urls, response_attr='status')

   Other valid response attributes are 'json' and 'text', which are awaited.

   If the callable of the exception handler function returns, it will be
   part of the returned results.