session

import compwa_policy.utilities.session

In-memory view of the files that check-dev-files inspects and modifies.

The Session follows the Unit of Work pattern together with its companion Identity Map: every managed file is loaded once and, on exit, written back only if it changed. Each check reports its modifications either by mutating one of the managed containers (whose own changelog is collected here) or by appending to Session.changelog directly.

Resources are discovered lazily through Session.get(); adding another file type therefore requires implementing ModifiableResource, without modifying Session.

class Session(precommit: ModifiablePrecommit | None = None, pyproject: ModifiablePyproject | None = None)

Bases: AbstractContextManager

Shared, mutable working-tree state for all check hooks.

Load the managed files with load() (or pass them in directly, e.g. in tests) and use the session as a context manager so that changed files are dumped once on exit.

changelog: Changelog

Change messages that do not belong to one of the managed containers.

classmethod load(precommit: ModifiablePrecommit | None = None) → Session

Create a lazy session, optionally with an injected pre-commit resource.

get(resource: type[R], /) → R

Return the one session-owned instance of resource, loading it lazily.

get_path(path: Path | str, /) → ModifiablePath

Return the session-owned generic resource for one working-tree path.

property precommit: ModifiablePrecommit

The managed .pre-commit-config.yaml file.

property pyproject: ModifiablePyproject | None

The managed pyproject.toml file, if the repository has one.

property pixi: ModifiablePixi

The managed pixi.toml file.

collect_changes() → list[str]

Aggregate every reported change.

Call this inside the context (before the files are dumped on exit). The order mirrors the historical flat dispatch: free-form messages first (in the order the checks ran), then the container changelogs.

flush() → list[str]

Write each changed resource at most once and return the run changelog.