Skip to content

config

Configuration loading and validation.

config

Configuration loading and validation.

This module handles loading the .pre-commit-snippets-config.yaml file and validating its contents. It defines dataclasses for structured configuration and provides a minimal YAML parser with no external dependencies.

SnippetSource dataclass

Configuration for a single snippet source repository.

Attributes:

Name Type Description
repo str

URL or path to the snippet repository.
branch str

Branch or tag to clone. Empty string for default branch.
subdir str

Subdirectory within the repo containing snippets.
ext str

File extension for snippet files (e.g., ".md").
Source code in pre_commit_snippet/config.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@dataclass
class SnippetSource:
    """
    Configuration for a single snippet source repository.

    Attributes:
        repo: URL or path to the snippet repository.
        branch: Branch or tag to clone. Empty string for default branch.
        subdir: Subdirectory within the repo containing snippets.
        ext: File extension for snippet files (e.g., ".md").
    """

    repo: str
    branch: str = ""
    subdir: str = "."
    ext: str = ".md"

Config dataclass

Main configuration for the snippet hook.

Attributes:

Name Type Description
sources list[SnippetSource]

List of snippet source repositories.
target_files list[str]

List of file paths (relative to repo root) to process.
Source code in pre_commit_snippet/config.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@dataclass
class Config:
    """
    Main configuration for the snippet hook.

    Attributes:
        sources: List of snippet source repositories.
        target_files: List of file paths (relative to repo root) to process.
    """

    sources: list[SnippetSource] = field(default_factory=list)
    target_files: list[str] = field(default_factory=list)

    @property
    def primary_source(self) -> SnippetSource | None:
        """
        Get the primary (first) snippet source.

        Returns:
            The first SnippetSource, or None if no sources are configured.
        """
        return self.sources[0] if self.sources else None

primary_source property

Get the primary (first) snippet source.

Returns:

Type Description
SnippetSource | None

The first SnippetSource, or None if no sources are configured.

load_yaml(path)

Parse the very simple flat YAML used for the config.

Supports only flat key-value pairs and lists (using "- item" syntax). Does not handle nested structures, quoted strings with colons, or multiline values.

Parameters:

Name Type Description Default
path Path

Path to the YAML configuration file.

 required

Returns:

Type Description
dict[str, str | list[str]]

A dictionary mapping keys to either string values or lists of strings.
Source code in pre_commit_snippet/config.py 
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
def load_yaml(path: Path) -> dict[str, str | list[str]]:
    """
    Parse the very simple flat YAML used for the config.

    Supports only flat key-value pairs and lists (using "- item" syntax).
    Does not handle nested structures, quoted strings with colons, or multiline values.

    Args:
        path: Path to the YAML configuration file.

    Returns:
        A dictionary mapping keys to either string values or lists of strings.
    """
    data: dict[str, str | list[str]] = {}
    cur_key: str | None = None
    with path.open() as f:
        for raw in f:
            line = raw.strip()
            if not line or line.startswith("#"):
                continue
            if ":" in line and not line.startswith("-"):
                key, val = line.split(":", 1)
                key = key.strip()
                val = val.strip()
                if val == "":
                    cur_key = key
                    data[cur_key] = []
                else:
                    data[key] = val
                    cur_key = None
            elif line.startswith("-") and cur_key is not None:
                cur_list = data[cur_key]
                if isinstance(cur_list, list):
                    cur_list.append(line.lstrip("-").strip())
    return data

load_config(config_path)

Load and validate configuration from a YAML file.

Parameters:

Name Type Description Default
config_path Path

Path to the configuration file.

 required

Returns:

Type Description
Config

A validated Config object.

Raises:

Type Description
FileNotFoundError

If the config file doesn't exist.
ValueError

If required config keys are missing.
Source code in pre_commit_snippet/config.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def load_config(config_path: Path) -> Config:
    """
    Load and validate configuration from a YAML file.

    Args:
        config_path: Path to the configuration file.

    Returns:
        A validated Config object.

    Raises:
        FileNotFoundError: If the config file doesn't exist.
        ValueError: If required config keys are missing.
    """
    if not config_path.is_file():
        raise FileNotFoundError(f"Config file not found at {config_path}")

    cfg = load_yaml(config_path)

    # Build snippet sources
    sources: list[SnippetSource] = []

    # Primary source (legacy single-repo format)
    if "snippet_repo" in cfg:
        repo = cfg["snippet_repo"]
        if not isinstance(repo, str):
            raise ValueError("snippet_repo must be a string")

        branch = cfg.get("snippet_branch", "")
        if not isinstance(branch, str):
            branch = ""

        subdir = cfg.get("snippet_subdir", ".")
        if not isinstance(subdir, str):
            subdir = "."

        ext = cfg.get("snippet_ext", ".md")
        if not isinstance(ext, str):
            ext = ".md"

        sources.append(SnippetSource(repo=repo, branch=branch, subdir=subdir, ext=ext))

    if not sources:
        raise ValueError("Missing required config key: snippet_repo")

    # Target files
    target_files = cfg.get("target_files", [])
    if not isinstance(target_files, list):
        target_files = []

    return Config(sources=sources, target_files=target_files)