precommit

import compwa_policy.utilities.precommit

Helper functions for modifying .pre-commit.config.yaml.

class Precommit(document: PrecommitConfig, parser: YAML, source: IO | Path | None = None)

Bases: object

Read-only representation of a .pre-commit-config.yaml file.

property document: PrecommitConfig

property parser: YAML

property source: IO | Path | None

classmethod load(source: IO | Path | str = PosixPath('.pre-commit-config.yaml')) → Self

Load a pyproject.toml file from a file, I/O stream, or str.

dumps() → str

find_repo(search_pattern: str) → Repo | None

Find pre-commit repo definition in pre-commit config.

find_repo_with_index(search_pattern: str) → tuple[int, Repo] | None

Find pre-commit repo definition and its index in pre-commit config.

class ModifiablePrecommit(document: PrecommitConfig, parser: YAML, source: IO | Path | None = None)

Bases: Precommit, AbstractContextManager

dump(target: IO | Path | str | None = None) → None

property changelog: list[str]

remove_hook(hook_id: str, repo_url: str | None = None) → None

update_single_hook_repo(expected: Repo) → None

update_hook(repo_url: str, expected_hook: Hook) → None

Submodules and Subpackages

• getters
  • find_repo()
  • find_repo_with_index()
• setters
  • remove_precommit_hook()
  • update_single_hook_precommit_repo()
  • update_precommit_hook()
• struct
  • PrecommitConfig
    • PrecommitConfig.ci
    • PrecommitConfig.repos
    • PrecommitConfig.default_stages
    • PrecommitConfig.files
    • PrecommitConfig.exclude
    • PrecommitConfig.fail_fast
    • PrecommitConfig.minimum_pre_commit_version
  • PrecommitCi
    • PrecommitCi.autofix_commit_msg
    • PrecommitCi.autofix_prs
    • PrecommitCi.autoupdate_branch
    • PrecommitCi.autoupdate_commit_msg
    • PrecommitCi.autoupdate_schedule
    • PrecommitCi.skip
    • PrecommitCi.submodules
  • Repo
    • Repo.repo
    • Repo.rev
    • Repo.hooks
  • Hook
    • Hook.id
    • Hook.alias
    • Hook.name
    • Hook.language_version
    • Hook.files
    • Hook.exclude
    • Hook.types
    • Hook.types_or
    • Hook.exclude_types
    • Hook.args
    • Hook.stages
    • Hook.additional_dependencies
    • Hook.always_run
    • Hook.verbose
    • Hook.log_file
    • Hook.pass_filenames
  • validate()