Skip to content

Path operators

commons.path_operators

Functions:

Name Description
get_project_root_dir

Returns the root dir of the current project.
get_git_root_dir

Return the root directory of the git project.

get_project_root_dir 

get_project_root_dir() -> Path

Returns the root dir of the current project.

This root dir is usually used to search for settings, local data, etc..

If the current project is a Git repository, the root of the Git repository will be returned. Otherwise the current working directory will be returned.

Source code in src/commons/path_operators.py 
 7
 8
 9
10
11
12
13
14
15
16
def get_project_root_dir() -> Path:
    """
    Returns the root dir of the current project.

    This root dir is usually used to search for settings, local data, etc..

    If the current project is a Git repository, the root of the Git repository will be returned. Otherwise the current working directory will be returned.
    """

    return get_git_root_dir() or Path.cwd()

get_git_root_dir 

get_git_root_dir() -> Optional[Path]

Return the root directory of the git project.

Source code in src/commons/path_operators.py 
19
20
21
22
23
24
25
26
27
28
def get_git_root_dir() -> Optional[Path]:
    """Return the root directory of the git project."""

    try:
        result = subprocess.run(["git", "rev-parse", "--show-toplevel"], capture_output=True, text=True, check=True)
        return Path(result.stdout.strip())
    except (subprocess.CalledProcessError, FileNotFoundError):
        # CalledProcessError → not a git repo
        # FileNotFoundError → git not installed
        return None