Skip to content

Auth

Handles authentication and creates requests session.

Source code in akapy/auth.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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class Auth:
    """Handles authentication and creates requests session."""

    def __init__(
        self,
        EDGERC_PATH: str = "~/.edgerc",
        SECTION: str = "default",
        RETRY_ITERATION: int = 5,
        RETRY_BACKOFF: int = 1,
    ) -> None:
        """
        Initialize authentication and create requests session.

        Args:
            EDGERC_PATH: Path to .edgerc file
            SECTION: Section in .edgerc file
            RETRY_ITERATION: Number of retries
            RETRY_BACKOFF: Backoff factor between retries
        """

        self.SECTION = SECTION
        self.EDGERC = EdgeRc(EDGERC_PATH)
        self.HOSTURL = f"https://{self.EDGERC.get(self.SECTION, 'host')}"
        self.SESSION = requests.Session()

        self.RETRY_STRATEGY = Retry(
            total=RETRY_ITERATION,
            backoff_factor=RETRY_BACKOFF,
            status_forcelist=tuple(range(500, 600)),
            allowed_methods=frozenset(["DELETE", "GET", "POST", "PUT"]),
        )

        self.ADAPTER = HTTPAdapter(max_retries=self.RETRY_STRATEGY)
        self.SESSION.mount("http://", self.ADAPTER)
        self.SESSION.mount("https://", self.ADAPTER)

        self.SESSION.auth = EdgeGridAuth.from_edgerc(self.EDGERC, self.SECTION)

    def get_session(self):
        """Returns the requests session."""
        return self.SESSION

    @property
    def host_url(self):
        """Returns the base API host URL."""
        return self.HOSTURL

host_url property

Returns the base API host URL.

__init__(EDGERC_PATH='~/.edgerc', SECTION='default', RETRY_ITERATION=5, RETRY_BACKOFF=1)

Initialize authentication and create requests session.

Parameters:

Name Type Description Default
EDGERC_PATH str

Path to .edgerc file

 '~/.edgerc'
SECTION str

Section in .edgerc file

 'default'
RETRY_ITERATION int

Number of retries

 5
RETRY_BACKOFF int

Backoff factor between retries

 1
Source code in akapy/auth.py 
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
37
38
39
40
41
42
43
def __init__(
    self,
    EDGERC_PATH: str = "~/.edgerc",
    SECTION: str = "default",
    RETRY_ITERATION: int = 5,
    RETRY_BACKOFF: int = 1,
) -> None:
    """
    Initialize authentication and create requests session.

    Args:
        EDGERC_PATH: Path to .edgerc file
        SECTION: Section in .edgerc file
        RETRY_ITERATION: Number of retries
        RETRY_BACKOFF: Backoff factor between retries
    """

    self.SECTION = SECTION
    self.EDGERC = EdgeRc(EDGERC_PATH)
    self.HOSTURL = f"https://{self.EDGERC.get(self.SECTION, 'host')}"
    self.SESSION = requests.Session()

    self.RETRY_STRATEGY = Retry(
        total=RETRY_ITERATION,
        backoff_factor=RETRY_BACKOFF,
        status_forcelist=tuple(range(500, 600)),
        allowed_methods=frozenset(["DELETE", "GET", "POST", "PUT"]),
    )

    self.ADAPTER = HTTPAdapter(max_retries=self.RETRY_STRATEGY)
    self.SESSION.mount("http://", self.ADAPTER)
    self.SESSION.mount("https://", self.ADAPTER)

    self.SESSION.auth = EdgeGridAuth.from_edgerc(self.EDGERC, self.SECTION)

get_session()

Returns the requests session.

Source code in akapy/auth.py 
45
46
47
def get_session(self):
    """Returns the requests session."""
    return self.SESSION