A linter for Cython files
Project description
cython-lint
A tool and pre-commit hook to lint Cython files.
Installation
$ pip install cython-lint
Usage as a pre-commit hook
See pre-commit for instructions
Sample .pre-commit-config.yaml:
- repo: https://github.com/MarcoGorelli/cython-lint
rev: v0.9.0
hooks:
- id: cython-lint
- id: double-quote-strings
Command-line example
$ 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
my_file_3.pyx:4:9: dangerous default value!
my_file_3.pyx:5:9: comma after base type in definition
Configuration
The following configuration options are available:
- exclude lines by including a
# no-cython-lintcomment (analogous to# noqainflake8); - use the command-line argument
--max-line-lengthto control the maximum line length used by pycodestyle; - use the command-line argument
--no-pycodestyleif you don't want the pycodestyle checks.
Which checks are implemented?
- variable defined but unused
- variable imported but unused
- comma after base type definition (e.g.
cdef ndarray, arr) - f-string without placeholders
- dict key repeated
- dict key variable repeated
- if-statement with tuple condition (always true...)
- assert statement with tuple condition (always true...)
- dangerous default value
- repeated element in set
.strip,.rstrip, or.lstripused with repeated characters- comparison between constants
- late-binding closures https://docs.python-guide.org/writing/gotchas/#late-binding-closures
pycodestylenitpicks, which you can turn off with--no-pycodestyle
In addition, the following automated fixers are implemented:
- double-quote-strings (replace single quotes with double quotes, like the
blackformatter does)
More to come! Requests welcome!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cython_lint-0.9.0.tar.gz
(3.1 kB
view details)
Built Distribution
File details
Details for the file cython_lint-0.9.0.tar.gz.
File metadata
- Download URL: cython_lint-0.9.0.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d82e42d7503e08f220f1800c0967a9eb965c05a3f363d258bc5bac17a40e7716 |
|
| MD5 | a0fa1d230db5c6638f57713de13488ff |
|
| BLAKE2b-256 | 294cbe39dc3601bf055258180529db1d55def18a36c9a7fa543c69f9ea35837a |
Provenance
File details
Details for the file cython_lint-0.9.0-py2.py3-none-any.whl.
File metadata
- Download URL: cython_lint-0.9.0-py2.py3-none-any.whl
- Upload date:
- Size: 9.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9e52b5e6acc0f3239315a90dc421c6f9e61721349c48e2e3b05dfa83b5b4bf45 |
|
| MD5 | 5c73acf3a5668992c6ffb0e4e6bb2dfa |
|
| BLAKE2b-256 | 8a3bcadd301c0aad1ad307fc51f574036872f3f1e4a5a8930a676a41f5c23be0 |
