Everything flake8
used to do (by accident), plus much more.
A tool and pre-commit hook to lint Cython files.
Here's some major projects using cython-lint
- is yours missing? Feel free to open a pull request!
$ pip install cython-lint
See pre-commit for instructions
Sample .pre-commit-config.yaml
:
- repo: https://github.com/MarcoGorelli/cython-lint
rev: v0.16.2
hooks:
- id: cython-lint
- id: double-quote-cython-strings
$ cython-lint my_file_1.pyx my_file_2.pyx
my_file_1.pyx:54:5: 'get_conversion_factor' imported but unused
my_file_2.pyx:1112:38: 'mod' defined but unused (try prefixing with underscore?)
my_file_3.pyx:4:9: dangerous default value!
my_file_3.pyx:5:9: comma after base type in definition
The following configuration options are available:
# no-cython-lint
comment (analogous to # noqa
in flake8
);as well as the following command-line arguments:
--max-line-length
to control the maximum line length used by pycodestyle;--no-pycodestyle
if you don't want the pycodestyle checks;--ignore
if you want to ignore some specific pycodestyle checks;--files
to pass a Regex pattern with which to match files to include;--exclude
to pass a Regex pattern with which to match files to exclude.Configuration can be set project-wise in a pyproject.toml
file at the root of the project.
Here's an example pyproject.toml
:
[tool.cython-lint]
max-line-length = 88
ignore = ['E503', 'E504']
exclude = 'my_project/excluded_cython_file.pyx'
cdef ndarray, arr
)pycodestyle
nitpicks (which you can turn off with --no-pycodestyle
).strip
, .rstrip
, or .lstrip
used with repeated charactersIn addition, the following automated fixers are implemented:
black
formatter does)More to come! Requests welcome!