Skip to content

nightly_util

get_apphub_source_dir_path

Get the absolute path to the apphub folder containing the files to be tested by the working_file.

Parameters:

Name Type Description Default
working_file str

The absolute path to a test file.

 required

Returns:

Type Description
str

The absolute path to the corresponding apphub directory.
Source code in fastestimator/fastestimator/test/nightly_util.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
def get_apphub_source_dir_path(working_file: str) -> str:
    """Get the absolute path to the apphub folder containing the files to be tested by the `working_file`.

    Args:
        working_file: The absolute path to a test file.

    Returns:
        The absolute path to the corresponding apphub directory.
    """
    apphub_path = get_uncle_path("apphub", working_file)
    relative_dir_path = get_relative_path("apphub_scripts", working_file)
    source_dir_path = os.path.join(apphub_path, relative_dir_path)
    return source_dir_path

get_relative_path

Convert an absolute path into a relative path within the parent folder.

Parameters:

Name Type Description Default
parent_dir str

A parent folder

 required
working_file str

The absolute path to a test file.

 required

Returns:

Type Description
str

The relative path to the test file within the parent_dir folder.

Raises:

Type Description
OSError

If the working_file is not located within the parent_dir folder.
Source code in fastestimator/fastestimator/test/nightly_util.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
def get_relative_path(parent_dir: str, working_file: str) -> str:
    """Convert an absolute path into a relative path within the parent folder.

    Args:
        parent_dir: A parent folder
        working_file: The absolute path to a test file.

    Returns:
        The relative path to the test file within the parent_dir folder.

    Raises:
        OSError: If the `working_file` is not located within the parent_dir folder.
    """
    current_dir = os.path.abspath(os.path.join(working_file, ".."))
    split = current_dir.split("{}/".format(parent_dir))
    if len(split) == 1:
        raise OSError("This file need to be put inside {} directory".format(parent_dir))
    return split[-1]

get_uncle_path

Find the path to the uncle folder of working_file.

Parameters:

Name Type Description Default
uncle_dir str

A target uncle folder

 required
working_file str

A file within the same FastEstimator repository as apphub examples.

 required

Returns:

Type Description
str

The root path to the apphub folder.

Raises:

Type Description
OSError

If the working_file does not correspond to any of the uncle paths.
Source code in fastestimator/fastestimator/test/nightly_util.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def get_uncle_path(uncle_dir: str, working_file: str) -> str:
    """Find the path to the uncle folder of `working_file`.

    Args:
        uncle_dir: A target uncle folder
        working_file: A file within the same FastEstimator repository as apphub examples.

    Returns:
        The root path to the apphub folder.

    Raises:
        OSError: If the `working_file` does not correspond to any of the uncle paths.
    """
    uncle_path = None
    current_dir = os.path.abspath(os.path.join(working_file, ".."))
    while current_dir != "/":
        current_dir = os.path.abspath(os.path.join(current_dir, ".."))
        if uncle_dir in os.listdir(current_dir):
            uncle_path = os.path.abspath(os.path.join(current_dir, uncle_dir))
            break
    if uncle_path is None:
        raise OSError("Could not find the {} directory".format(uncle_dir))
    return uncle_path