Skip to content

util

Utility functions for cridlib.

get_session(retries=5, backoff_factor=0.1)

Get a requests session with retry/backoff.

retries: How often to retry.
backoff_factor: A backoff factor to apply between attempts after the
    second try (most errors are resolved immediately by a second try
    without a delay). urllib3 will sleep for::
        {backoff factor} * (2 ** ({number of total retries} - 1))
    seconds. If the backoff_factor is 0.1, then :func:`Retry.sleep`
    will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. It will
    never be longer than `backoff_max`.
    By default, backoff is set to 0.1.
Source code in cridlib/util.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
def get_session(
    retries: int = 5,
    backoff_factor: float = 0.1,
) -> Session:
    """Get a requests session with retry/backoff.

    Args:
    ----
        retries: How often to retry.
        backoff_factor: A backoff factor to apply between attempts after the
            second try (most errors are resolved immediately by a second try
            without a delay). urllib3 will sleep for::
                {backoff factor} * (2 ** ({number of total retries} - 1))
            seconds. If the backoff_factor is 0.1, then :func:`Retry.sleep`
            will sleep for [0.0s, 0.2s, 0.4s, ...] between retries. It will
            never be longer than `backoff_max`.
            By default, backoff is set to 0.1.

    """
    session = Session()
    session.mount(
        "https://",
        HTTPAdapter(
            max_retries=Retry(
                total=retries,
                backoff_factor=backoff_factor,
            ),
        ),
    )
    return session