Module lang_main.io

Functions

def create_saving_folder(saving_path_folder: str | pathlib.Path, overwrite_existing: bool = False) ‑> None

Expand source code

def create_saving_folder(
    saving_path_folder: str | Path,
    overwrite_existing: bool = False,
) -> None:
    # check for existence of given path
    if isinstance(saving_path_folder, str):
        saving_path_folder = Path(saving_path_folder)
    if not saving_path_folder.exists():
        saving_path_folder.mkdir(parents=True)
    else:
        if overwrite_existing:
            # overwrite if desired (deletes whole path and re-creates it)
            shutil.rmtree(saving_path_folder)
            saving_path_folder.mkdir(parents=True)
        else:
            logger.info(
                (
                    'Path >>%s<< already exists and remained unchanged. If you want to '
                    'overwrite this path, use parameter >>overwrite_existing<<.',
                ),
                saving_path_folder,
            )

def decode_from_base64_str(b64_str: str, encoding: str = 'utf-8') ‑> Any

Expand source code

def decode_from_base64_str(
    b64_str: str,
    encoding: str = 'utf-8',
) -> Any:
    b64_bytes = b64_str.encode(encoding=encoding)
    decoded = base64.b64decode(b64_bytes)
    return pickle.loads(decoded)

def encode_file_to_base64_str(path: pathlib.Path, encoding: str = 'utf-8') ‑> str

Expand source code

def encode_file_to_base64_str(
    path: Path,
    encoding: str = 'utf-8',
) -> str:
    with open(path, 'rb') as file:
        b64_bytes = base64.b64encode(file.read())
    return b64_bytes.decode(encoding=encoding)

def encode_to_base64_str(obj: Any, encoding: str = 'utf-8') ‑> str

Expand source code

def encode_to_base64_str(
    obj: Any,
    encoding: str = 'utf-8',
) -> str:
    serialised = pickle.dumps(obj, protocol=PICKLE_PROTOCOL_VERSION)
    b64_bytes = base64.b64encode(serialised)
    return b64_bytes.decode(encoding=encoding)

def get_entry_point(saving_path: pathlib.Path,
filename: str,
file_ext: str = '.pkl',
check_existence: bool = True) ‑> pathlib.Path

Expand source code

def get_entry_point(
    saving_path: Path,
    filename: str,
    file_ext: str = '.pkl',
    check_existence: bool = True,
) -> Path:
    entry_point_path = (saving_path / filename).with_suffix(file_ext)
    if check_existence and not entry_point_path.exists():
        raise FileNotFoundError(
            f'Could not find provided entry data under path: >>{entry_point_path}<<'
        )

    return entry_point_path

def load_pickle(path: str | pathlib.Path) ‑> Any

Expand source code

def load_pickle(
    path: str | Path,
) -> Any:
    with open(path, 'rb') as file:
        obj = pickle.load(file)
    logger.info('Loaded file successfully.')
    return obj

def save_pickle(obj: Any, path: str | pathlib.Path) ‑> None

Expand source code

def save_pickle(
    obj: Any,
    path: str | Path,
) -> None:
    with open(path, 'wb') as file:
        pickle.dump(obj, file, protocol=PICKLE_PROTOCOL_VERSION)
    logger.info('Saved file successfully under %s', path)