Skip to content

utils.py

cpas_toolbox.utils

This module provides miscellaneous utility functions.

str_to_object 

str_to_object(name: str) -> Any

Try to find object with a given name.

First scope of calling function is checked for the name, then current environment (in which case name has to be a fully qualified name). In the second case, the object is imported if found.

PARAMETER DESCRIPTION
name

Name of the object to resolve.

TYPE: str

RETURNS DESCRIPTION
Any

The object which the provided name refers to. None if no object was found.
Source code in cpas_toolbox/utils.py 
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 str_to_object(name: str) -> Any:
    """Try to find object with a given name.

    First scope of calling function is checked for the name, then current environment
    (in which case name has to be a fully qualified name). In the second case, the
    object is imported if found.

    Args:
        name: Name of the object to resolve.

    Returns:
        The object which the provided name refers to. None if no object was found.
    """
    # check callers local variables
    caller_locals = inspect.currentframe().f_back.f_locals
    if name in caller_locals:
        return caller_locals[name]

    # check callers global variables (i.e., imported modules etc.)
    caller_globals = inspect.currentframe().f_back.f_globals
    if name in caller_globals:
        return caller_globals[name]

    # check environment
    return locate(name)

resolve_path 

resolve_path(path: str, search_paths: Optional[List[str]] = None) -> str

Resolves a path to a full absolute path based on search_paths.

This function considers paths of 5 different cases /... -> absolute path, nothing todo ~/... -> home dir, expand user ./... -> relative to current directory ../... -> relative to current parent directory ... -> relative to search paths

Current directory is not implicitly included in search paths and has to be added with "." if desired. Search paths are handled in first to last order and considered correct if file or directory exists.

Returns original path, if file does not exist.

PARAMETER DESCRIPTION
path

The path to resolve.

TYPE: str

search_paths

List of search paths to prepend relative paths which are not explicitly relative to current directory. If None, no search paths are assumed.

TYPE: Optional[List[str]] DEFAULT: None

Source code in cpas_toolbox/utils.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def resolve_path(path: str, search_paths: Optional[List[str]] = None) -> str:
    """Resolves a path to a full absolute path based on search_paths.

    This function considers paths of 5 different cases
        /... -> absolute path, nothing todo
        ~/... -> home dir, expand user
        ./... -> relative to current directory
        ../... -> relative to current parent directory
        ... -> relative to search paths

    Current directory is not implicitly included in search paths and has to be added
    with "." if desired. Search paths are handled in first to last order and considered
    correct if file or directory exists.

    Returns original path, if file does not exist.

    Args:
        path: The path to resolve.
        search_paths:
            List of search paths to prepend relative paths which are not explicitly
            relative to current directory.
            If None, no search paths are assumed.
    """
    if search_paths is None:
        search_paths = []

    if os.path.isabs(path):
        return path

    parts = path.split(os.sep)

    if parts[0] in [".", ".."]:
        return os.path.abspath(path)
    elif parts[0] == "~":
        return os.path.expanduser(path)

    for search_path in search_paths:
        resolved_path = os.path.expanduser(os.path.join(search_path, path))
        if os.path.exists(resolved_path):
            return os.path.abspath(resolved_path)

    return path

download 

download(url: str, download_path: str) -> str

Download file from URL to a specified path.

Source code in cpas_toolbox/utils.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def download(url: str, download_path: str) -> str:
    """Download file from URL to a specified path."""
    block_size = 100
    if "drive.google.com" in url:
        gdown.download(url, download_path)
    else:
        # adapted from https://stackoverflow.com/a/37573701
        response = requests.get(url, stream=True)
        total_size_in_bytes = int(response.headers.get("content-length", 0))
        progress_bar = tqdm(total=total_size_in_bytes, unit="iB", unit_scale=True)
        with open(download_path, "wb") as file:
            for data in response.iter_content(block_size):
                progress_bar.update(len(data))
                file.write(data)
        progress_bar.close()
        if total_size_in_bytes != 0 and progress_bar.n != total_size_in_bytes:
            print("ERROR, download failed")
            exit()