Tokens

load_token(path: Path = TOKEN_PATH, encoding: str = DEFAULT_ENCODING, errors: str = DEFAULT_ERRORS) -> str

Loads the token from the given path.

Parameters:

Name	Type	Description	Default
path	Path	The path to the token file.	TOKEN_PATH
encoding	str	The encoding to use.	DEFAULT_ENCODING
errors	str	The error handling of the encoding to use.	DEFAULT_ERRORS

Returns:

Type	Description
str	The loaded token.

Raises:

Type	Description
TokenNotFound	OSError occured.

Source code in aoc/tokens.py

def load_token(
    path: Path = TOKEN_PATH, encoding: str = DEFAULT_ENCODING, errors: str = DEFAULT_ERRORS
) -> str:
    """Loads the token from the given `path`.

    Arguments:
        path: The path to the token file.
        encoding: The encoding to use.
        errors: The error handling of the encoding to use.

    Returns:
        The loaded token.

    Raises:
        TokenNotFound: [`OSError`][OSError] occured."""
    try:
        return path.read_text(encoding, errors).strip()

    except OSError as origin:
        raise TokenNotFound(path) from origin

dump_token(token: str, path: Path = TOKEN_PATH, encoding: str = DEFAULT_ENCODING, errors: str = DEFAULT_ERRORS) -> None

Dumps the token to the given path.

Parameters:

Name	Type	Description	Default
token	str	The token to dump.	required
path	Path	The path to the token file.	TOKEN_PATH
encoding	str	The encoding to use.	DEFAULT_ENCODING
errors	str	The error handling of the encoding to use.	DEFAULT_ERRORS

Source code in aoc/tokens.py

def dump_token(
    token: str,
    path: Path = TOKEN_PATH,
    encoding: str = DEFAULT_ENCODING,
    errors: str = DEFAULT_ERRORS,
) -> None:
    """Dumps the `token` to the given `path`.

    Arguments:
        token: The token to dump.
        path: The path to the token file.
        encoding: The encoding to use.
        errors: The error handling of the encoding to use.
    """
    path.write_text(token + NEW_LINE, encoding, errors)

remove_token(path: Path = TOKEN_PATH) -> None

Removes the token at the given path.

This function does nothing if the path does not exist.

Parameters:

Name	Type	Description	Default
path	Path	The path to the token file.	TOKEN_PATH

Source code in aoc/tokens.py

def remove_token(path: Path = TOKEN_PATH) -> None:
    """Removes the token at the given `path`.

    This function does nothing if the `path` does not exist.

    Arguments:
        path: The path to the token file.
    """
    path.unlink(missing_ok=True)