Skip to content

default_paths

darts_utils.default_paths

Default Path management for all DARTS modules.

Unused prototype.

DEFAULT_DARTS_DIR module-attribute 

DEFAULT_DARTS_DIR = darts_utils.default_paths._parse_path(
    os.environ.get("DARTS_DIR")
) or pathlib.Path(".")

DEFAULT_FAST_DIR module-attribute 

DEFAULT_FAST_DIR = (
    darts_utils.default_paths._parse_path(
        os.environ.get("DARTS_FAST_DIR")
    )
    or darts_utils.default_paths.DEFAULT_DARTS_DIR
)

DEFAULT_VAST_DIR module-attribute 

DEFAULT_VAST_DIR = (
    darts_utils.default_paths._parse_path(
        os.environ.get("DARTS_VAST_DIR")
    )
    or darts_utils.default_paths.DEFAULT_DARTS_DIR
)

_parse_path 

_parse_path(
    p: pathlib.Path | str | None,
) -> pathlib.Path | None
Source code in darts-utils/src/darts_utils/default_paths.py 
10
11
12
13
def _parse_path(p: Path | str | None) -> Path | None:
    if isinstance(p, str):
        p = Path(p)
    return p

set_default_paths 

set_default_paths(
    *,
    fast_dir: pathlib.Path | str | None,
    vast_dir: pathlib.Path | str | None,
    darts_dir: pathlib.Path
    | str = darts_utils.default_paths.DEFAULT_DARTS_DIR,
) -> None

Set the default directories for DARTS.

Parameters:

Source code in darts-utils/src/darts_utils/default_paths.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def set_default_paths(
    *,
    fast_dir: Path | str | None,
    vast_dir: Path | str | None,
    darts_dir: Path | str = DEFAULT_DARTS_DIR,
) -> None:
    """Set the default directories for DARTS.

    Args:
        fast_dir (Path | str | None): The directory for fast data.
        vast_dir (Path | str | None): The directory for vast data.
        darts_dir (Path | str, optional): The directory for DARTS data. Defaults to ".".

    """
    global DEFAULT_DARTS_DIR, DEFAULT_FAST_DIR, DEFAULT_VAST_DIR
    DEFAULT_DARTS_DIR = Path(darts_dir) if isinstance(darts_dir, str) else darts_dir

    DEFAULT_FAST_DIR = _parse_path(fast_dir) or DEFAULT_FAST_DIR or DEFAULT_DARTS_DIR
    DEFAULT_VAST_DIR = _parse_path(vast_dir) or DEFAULT_VAST_DIR or DEFAULT_DARTS_DIR
    DEFAULT_FAST_DIR = DEFAULT_FAST_DIR.resolve()
    DEFAULT_VAST_DIR = DEFAULT_VAST_DIR.resolve()