Implement copyright notice detection

[Ryang20718]

Summary

Add copyright notice detection to enforce the presence of copyright headers in Python files.

Configurable settings include: the relevant regular expression, the author name, and the minimum file size, similar to flake8-copyright.

Closes #3579

[Ryang20718]

Could also do dep injection here and pass regexp as an arg. However, that would essentially put all the logic in physical_lines.rs. Let me know which you would prefer

[github-actions]

PR Check Results

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     15.2±0.09ms     2.7 MB/sec    1.01     15.3±0.06ms     2.7 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      3.7±0.01ms     4.5 MB/sec    1.10      4.0±0.01ms     4.1 MB/sec
linter/all-rules/numpy/globals.py          1.00    377.8±1.41µs     7.8 MB/sec    1.90    717.4±4.90µs     4.1 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.3±0.01ms     4.0 MB/sec    1.04      6.6±0.01ms     3.9 MB/sec
linter/default-rules/large/dataset.py      1.01      7.5±0.03ms     5.4 MB/sec    1.00      7.5±0.05ms     5.5 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.04  1613.6±11.13µs    10.3 MB/sec    1.00   1549.2±5.07µs    10.7 MB/sec
linter/default-rules/numpy/globals.py      1.06    176.7±0.58µs    16.7 MB/sec    1.00    167.0±0.14µs    17.7 MB/sec
linter/default-rules/pydantic/types.py     1.03      3.4±0.00ms     7.5 MB/sec    1.00      3.3±0.04ms     7.7 MB/sec
parser/large/dataset.py                    1.00      5.7±0.00ms     7.1 MB/sec    1.03      5.9±0.00ms     6.9 MB/sec
parser/numpy/ctypeslib.py                  1.00   1127.4±0.78µs    14.8 MB/sec    1.03   1161.5±4.55µs    14.3 MB/sec
parser/numpy/globals.py                    1.00    115.2±0.39µs    25.6 MB/sec    1.04    119.8±0.36µs    24.6 MB/sec
parser/pydantic/types.py                   1.00      2.5±0.00ms    10.3 MB/sec    1.02      2.5±0.00ms    10.1 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     16.8±0.22ms     2.4 MB/sec    1.03     17.4±0.44ms     2.3 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.4±0.09ms     3.8 MB/sec    1.08      4.7±0.03ms     3.5 MB/sec
linter/all-rules/numpy/globals.py          1.00    465.6±8.56µs     6.3 MB/sec    1.85   859.3±15.41µs     3.4 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.2±0.06ms     3.5 MB/sec    1.06      7.6±0.13ms     3.3 MB/sec
linter/default-rules/large/dataset.py      1.00      8.6±0.20ms     4.7 MB/sec    1.01      8.7±0.12ms     4.7 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.01  1822.8±38.48µs     9.1 MB/sec    1.00  1811.9±32.52µs     9.2 MB/sec
linter/default-rules/numpy/globals.py      1.02    197.2±1.57µs    15.0 MB/sec    1.00    194.2±7.07µs    15.2 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.9±0.03ms     6.6 MB/sec    1.00      3.9±0.05ms     6.6 MB/sec
parser/large/dataset.py                    1.00      6.7±0.04ms     6.1 MB/sec    1.04      7.0±0.03ms     5.8 MB/sec
parser/numpy/ctypeslib.py                  1.00  1279.3±10.69µs    13.0 MB/sec    1.04  1330.2±14.93µs    12.5 MB/sec
parser/numpy/globals.py                    1.00    131.4±1.49µs    22.4 MB/sec    1.06    139.6±2.17µs    21.1 MB/sec
parser/pydantic/types.py                   1.00      2.9±0.04ms     8.9 MB/sec    1.04      3.0±0.02ms     8.6 MB/sec

[Ryang20718]

Hi, I made a first stab at implementing #4701 flake8-copyright

However, it seems like the "pre-commit" check in CI is failing due to a lack of copyright headers on some python files in the scripts directory https://github.com/charliermarsh/ruff/actions/runs/5115146921/jobs/9196121487?pr=4701
Wondering if it would be preferable to add the copyright header, disable the check or add noqa C801?

When I tried adding noqa, when emulating CI and running the command locally, it would overwrite my changes.

[Ryang20718]

Sorry if this was documented somewhere/asked again, but wondering if there's a group of people to assign as reviewers for PR's?

[Ryang20718]

Addressed comments.

This PR should be good for re-review. However, the CI problem still lingers. I tried adding # noqa: CPY801 to the python files, but autofix removes the line. I could add a line to these scripts such as # Copyright (c) 2023 ruff or is there a way we can disable this check when running ruff on this repo for that particular github action?

[charliermarsh]

Sorry, missed that question -- can we add CPY to the ignore in scripts/pyproject.toml?

[Ryang20718]

TIL nested pyproject.toml. Neat!

[Ryang20718]

addressed all comments. Wondering if @charliermarsh or @MichaReiser could re-review please?

[gertvdijk]

Hi! Cool to see a another new rule has landed.

Two comments - as seen in 0.0.237:

1. The listing of linters appears inconsistent:

   $ ruff linter
   [...]
    COM flake8-commas
    CPY Copyright-related rules
     C4 flake8-comprehensions
   [...]
   

   That line should have been CPY flake8-copyright, I think.

2. The docs say ...

   This rule is part of the nursery, a collection of newer lints that are still under development. As such, it must be enabled by explicitly selecting CPY001.

   ... but it's enabled already using CPY (broader). Could it be an accidental copy/paste from some E-rules?

[charliermarsh]

Thanks for this. I had intentionally renamed to "Copyright-related rules" but perhaps that was a mistake.

(I think it's probably a bug that --select CPY works... but it's not a big deal in this case since the category only has the one rule, so I might not even bother to fix 😂)