Skip to content

_toml

rhiza_hooks._toml

Shared lenient TOML loader.

Every hook that reads a TOML file — pyproject.toml, Cargo.toml, rust-toolchain.toml, .bumpversion.toml — treats a missing, malformed or unreadable file as "unspecified": a broken manifest is somebody else's error to report, not a reason to crash the commit. That stance used to be implemented separately in five modules, whose except tuples drifted apart until two of them crashed on invalid UTF-8 (#396). This module is now the only place that calls :func:tomllib.load.

load_toml(path)

Parse a TOML file, treating unreadable or malformed input as absent.

Parameters:

Name Type Description Default
path Path

File to parse.

 required

Returns:

Type Description
dict[str, Any] | None

The parsed mapping, or None if the file is missing, malformed, not valid
dict[str, Any] | None

UTF-8, or cannot be opened (for example, the path is a directory).
Source code in rhiza_hooks/_toml.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def load_toml(path: Path) -> dict[str, Any] | None:
    """Parse a TOML file, treating unreadable or malformed input as absent.

    Args:
        path: File to parse.

    Returns:
        The parsed mapping, or None if the file is missing, malformed, not valid
        UTF-8, or cannot be opened (for example, the path is a directory).
    """
    if not path.exists():
        return None
    try:
        with path.open("rb") as handle:
            return tomllib.load(handle)
    except (tomllib.TOMLDecodeError, OSError, UnicodeDecodeError):
        # tomllib decodes the stream itself, so invalid UTF-8 surfaces as
        # UnicodeDecodeError rather than a TOML error. Anything else (e.g. a
        # genuine bug) is left to surface.
        return None