Skip to content

climate_ref.cli._git_utils #

Git utilities for CLI commands.

FileInfo #

Bases: TypedDict

Information about a file in the regression directory.

Source code in packages/climate-ref/src/climate_ref/cli/_git_utils.py 
29
30
31
32
33
34
35
class FileInfo(TypedDict):
    """Information about a file in the regression directory."""

    rel_path: str
    size: int
    is_large: bool
    git_status: str

collect_regression_file_info(regression_dir, repo, size_threshold_bytes) #

Collect file information from a regression directory.

Parameters:

Name Type Description Default
regression_dir Path

Path to the regression data directory

 required
repo Repo | None

Git repository object, or None if not in a repo

 required
size_threshold_bytes int

Files larger than this will be flagged as large

 required

Returns:

Type Description
list[FileInfo]

List of dicts with keys: rel_path, size, is_large, git_status
Source code in packages/climate-ref/src/climate_ref/cli/_git_utils.py 
 38
 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
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def collect_regression_file_info(
    regression_dir: Path,
    repo: Repo | None,
    size_threshold_bytes: int,
) -> list[FileInfo]:
    """
    Collect file information from a regression directory.

    Parameters
    ----------
    regression_dir
        Path to the regression data directory
    repo
        Git repository object, or None if not in a repo
    size_threshold_bytes
        Files larger than this will be flagged as large

    Returns
    -------
    :
        List of dicts with keys: rel_path, size, is_large, git_status
    """
    files = sorted(regression_dir.rglob("*"))
    files = [f for f in files if f.is_file()]

    file_info: list[FileInfo] = []
    for file_path in files:
        size = file_path.stat().st_size
        rel_path = str(file_path.relative_to(regression_dir))
        file_info.append(
            {
                "rel_path": rel_path,
                "size": size,
                "is_large": size > size_threshold_bytes,
                "git_status": "unknown",
            }
        )
    if not repo or repo.working_dir != str(regression_dir):
        return file_info

    # Read the current status of the repository just once.
    untracked_files = set(repo.untracked_files)
    staged_files = {item.a_path for item in repo.index.diff("HEAD")}
    unstaged_files = {item.a_path for item in repo.index.diff(None)}

    # Update the git status of each file.
    for item in file_info:
        rel_path = item["rel_path"]

        # Check if untracked
        if rel_path in untracked_files:
            item["git_status"] = "new"
            continue

        # Check staged changes (index vs HEAD)
        if rel_path in staged_files:
            item["git_status"] = "staged"
            continue

        # Check unstaged changes (working tree vs index)
        if rel_path in unstaged_files:
            item["git_status"] = "modified"
            continue

        # Check if file is tracked
        try:
            repo.git.ls_files("--error-unmatch", rel_path)
            item["git_status"] = "tracked"
        except Exception:
            item["git_status"] = "untracked"

    return file_info

get_repo_for_path(path) #

Get the git repository containing the given path.

Parameters:

Name Type Description Default
path Path

Path to a file or directory

 required

Returns:

Type Description
Repo | None

The Repo object if path is within a git repository, None otherwise
Source code in packages/climate-ref/src/climate_ref/cli/_git_utils.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def get_repo_for_path(path: Path) -> Repo | None:
    """
    Get the git repository containing the given path.

    Parameters
    ----------
    path
        Path to a file or directory

    Returns
    -------
    :
        The Repo object if path is within a git repository, None otherwise
    """
    try:
        return Repo(path, search_parent_directories=True)
    except InvalidGitRepositoryError:
        return None