https://github.com/pre-commit/pygrep-hooks

A collection of fast, cheap, regex based pre-commit hooks.
https://github.com/pre-commit/pygrep-hooks

pre-commit

Last synced: about 2 months ago
JSON representation

A collection of fast, cheap, regex based pre-commit hooks.

• Host: GitHub
• URL: https://github.com/pre-commit/pygrep-hooks
• Owner: pre-commit
• License: mit
• Created: 2018-07-29T00:50:16.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T15:20:05.000Z (5 months ago)
• Last Synced: 2024-04-13T21:48:31.983Z (5 months ago)
• Topics: pre-commit
• Language: Python
• Size: 203 KB
• Stars: 195
• Watchers: 8
• Forks: 33
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/pre-commit/pygrep-hooks/main.svg)](https://results.pre-commit.ci/latest/github/pre-commit/pygrep-hooks/main)

pygrep-hooks

============

A collection of fast, cheap, regex based pre-commit hooks.

### Adding to your `.pre-commit-config.yaml`

```yaml

-   repo: https://github.com/pre-commit/pygrep-hooks

    rev: v1.10.0  # Use the ref you want to point at

    hooks:

    -   id: python-use-type-annotations

    # ...

```

### Naming conventions

Where possible, these hooks will be prefixed with the file types they target.

For example, a hook which targets python will be called `python-...`.

### Provided hooks

[generated]: # (generated)

- **`python-check-blanket-noqa`**: Enforce that `noqa` annotations always occur with specific codes. Sample annotations: `# noqa: F401`, `# noqa: F401,W203`

- **`python-check-blanket-type-ignore`**: Enforce that `# type: ignore` annotations always occur with specific codes. Sample annotations: `# type: ignore[attr-defined]`, `# type: ignore[attr-defined, name-defined]`

- **`python-check-mock-methods`**: Prevent common mistakes of `assert mck.not_called()`, `assert mck.called_once_with(...)` and `mck.assert_called`.

- **`python-no-eval`**: A quick check for the `eval()` built-in function

- **`python-no-log-warn`**: A quick check for the deprecated `.warn()` method of python loggers

- **`python-use-type-annotations`**: Enforce that python3.6+ type annotations are used instead of type comments

- **`rst-backticks`**: Detect common mistake of using single backticks when writing rst

- **`rst-directive-colons`**: Detect mistake of rst directive not ending with double colon or space before the double colon

- **`rst-inline-touching-normal`**: Detect mistake of inline code touching normal text in rst

- **`text-unicode-replacement-char`**: Forbid files which have a UTF-8 Unicode replacement character