Module `integer_sequences.helper.helpers`

Expand source code

# Typing
from typing import Any, Dict, List
from os import getcwd
from os.path import join
from pickle import dump, load

# Own
from exception import MissingItem


def check_item_list(item: Any, lst: List[Any]) -> None:
    """
    Raises a ``MissingItem`` if a particular ``item`` is NOT contained in a particular ``lst``.

    Parameters:
        item: The item to check for.
        lst: The list to check in.

    Raises a MissingItem exception if ``item`` not in ``lst``.
    """
    if item not in lst:
        raise MissingItem(item, lst)


def check_key_dict(key: Any, dictionary: Dict[Any, Any]) -> None:
    """
    Raises a ``MissingItem`` if a particular ``key`` is NOT contained in a particular ``dictionary``.

    Parameters:
        key: The key to check for.
        dictionary: The dictionary to check in.

    Raises a MissingItem exception if ``key`` not in ``dictionary.keys()``
    """
    if key not in dictionary.keys():
        raise MissingItem(key, dictionary)


def assert_equal(expected: Any, result: Any) -> None:
    """
    Asserts that expected is equal to result. To be called from tests.

    Parameters:
        expected: The expected outcome of some function call.
        result: The resulted outcome of some function call.

    Raises an AssertionError when equality fails.
    """
    assert expected == result


def dumps(filename: str, data: Any) -> bool:
    """
    Dumps data to a file using pickle.

    Returns true on success.
    Returns false on failure.
    """
    try:
        with open(f"{filename}.pkl", "wb") as file:
            dump(data, file)
        return True
    except OSError:
        return False


def loads(filename: str) -> Any:
    """
    Loads data from a file using pickle.
    """
    with open(f"{filename}.pkl", "rb") as pickle:
        return load(pickle)


# Paths
ROOTPATH = getcwd()
DATAPATH = join(ROOTPATH, "input_data")
LOGPATH = join(ROOTPATH, "generated_logs")
TESTPATH = join(ROOTPATH, "test")

Functions

def assert_equal(expected: Any, result: Any) ‑> NoneType

Asserts that expected is equal to result. To be called from tests.

Parameters

expected: The expected outcome of some function call. result: The resulted outcome of some function call.

Raises an AssertionError when equality fails.

Expand source code

def assert_equal(expected: Any, result: Any) -> None:
    """
    Asserts that expected is equal to result. To be called from tests.

    Parameters:
        expected: The expected outcome of some function call.
        result: The resulted outcome of some function call.

    Raises an AssertionError when equality fails.
    """
    assert expected == result

def check_item_list(item: Any, lst: List[Any]) ‑> NoneType

Raises a MissingItem if a particular item is NOT contained in a particular lst.

Parameters

item: The item to check for. lst: The list to check in.

Raises a MissingItem exception if item not in lst.

Expand source code

def check_item_list(item: Any, lst: List[Any]) -> None:
    """
    Raises a ``MissingItem`` if a particular ``item`` is NOT contained in a particular ``lst``.

    Parameters:
        item: The item to check for.
        lst: The list to check in.

    Raises a MissingItem exception if ``item`` not in ``lst``.
    """
    if item not in lst:
        raise MissingItem(item, lst)

def check_key_dict(key: Any, dictionary: Dict[Any, Any]) ‑> NoneType

Raises a MissingItem if a particular key is NOT contained in a particular dictionary.

Parameters

key: The key to check for. dictionary: The dictionary to check in.

Raises a MissingItem exception if key not in dictionary.keys()

Expand source code

def check_key_dict(key: Any, dictionary: Dict[Any, Any]) -> None:
    """
    Raises a ``MissingItem`` if a particular ``key`` is NOT contained in a particular ``dictionary``.

    Parameters:
        key: The key to check for.
        dictionary: The dictionary to check in.

    Raises a MissingItem exception if ``key`` not in ``dictionary.keys()``
    """
    if key not in dictionary.keys():
        raise MissingItem(key, dictionary)

def dumps(filename: str, data: Any) ‑> bool

Dumps data to a file using pickle.

Returns true on success. Returns false on failure.

Expand source code

def dumps(filename: str, data: Any) -> bool:
    """
    Dumps data to a file using pickle.

    Returns true on success.
    Returns false on failure.
    """
    try:
        with open(f"{filename}.pkl", "wb") as file:
            dump(data, file)
        return True
    except OSError:
        return False

def loads(filename: str) ‑> Any

Loads data from a file using pickle.

Expand source code

def loads(filename: str) -> Any:
    """
    Loads data from a file using pickle.
    """
    with open(f"{filename}.pkl", "rb") as pickle:
        return load(pickle)