Framework for Python

Git

git_hooks_disable()

Turn off one hook check. The hook is removed when no check is left.

"ai_sync" is accepted so older settings can be cleaned up: it is set to false.

Usage

git_hooks_disable(
    hook_name: str,
    settings_file: str | Path | None = None,
    *,
    verbose: bool = True,
) -> bool

Arguments

Name Type Default Description
hook_name required str

The check. One of "data_security", "check_sensitive_dirs", "check_notebook_outputs", or "ai_sync". The older name "warn_unignored_sensitive" is accepted for "check_sensitive_dirs", and turning that check off also turns off the older setting.

settings_file str | Path | None None

The project's settings file. Default: the settings.yml or config.yml found from the current directory.

verbose bool True

Print what was done.

Value

Whether the hook is still installed.

Raises

  • ValueError: When hook_name is not a known check.
  • FrameworkError: When the settings file is not found.