A linter for Cython files
Project description
cython-lint
Everything flake8 used to do (by accident), plus much more.
A tool and pre-commit hook to lint Cython files.
Used by
Here's some major projects using cython-lint - is yours missing? Feel free to open a pull request!
- arrow
- open library
- pandas
- pylibssh
- pymatgen
- RAPIDS cuspatial
- RAPIDS cudf
- RAPIDS Memory Manager
- scikit-image
- scipy
- yt
In addition:
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.14.2
hooks:
- id: cython-lint
- id: double-quote-cython-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 (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
Configuration
The following configuration options are available:
- exclude lines by including a
# no-cython-lintcomment (analogous to# noqainflake8);
as well as the following command-line arguments:
--max-line-lengthto control the maximum line length used by pycodestyle;--no-pycodestyleif you don't want the pycodestyle checks;--ignoreif you want to ignore some specific pycodestyle checks;--filesto pass a Regex pattern with which to match files to include;--excludeto pass a Regex pattern with which to match files to exclude.
Which checks are implemented?
- assert statement with tuple condition (always true...)
- comma after base type definition (e.g.
cdef ndarray, arr) - comparison between constants
- dangerous default value
- dict key repeated
- dict key variable repeated
- f-string without placeholders
- if-statement with tuple condition (always true...)
- late-binding closures https://docs.python-guide.org/writing/gotchas/#late-binding-closures
- pointless string statement
pycodestylenitpicks (which you can turn off with--no-pycodestyle)- repeated element in set
.strip,.rstrip, or.lstripused with repeated characters- unnecessary list index lookup
- unnecessary import alias
- variable defined but unused
- variable imported but unused
In addition, the following automated fixers are implemented:
- double-quote-cython-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.14.2.tar.gz
(40.2 kB
view details)
Built Distribution
File details
Details for the file cython_lint-0.14.2.tar.gz.
File metadata
- Download URL: cython_lint-0.14.2.tar.gz
- Upload date:
- Size: 40.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7e9b0d5ca91a443eca22302380f38c4cb745c5e62216dd9f387d646ae78b2170 |
|
| MD5 | d724a69f8d709330f27c8cb7c5071e85 |
|
| BLAKE2b-256 | 1d56c464ae9d54f5a49ef414e7b9bd313f3fd5c08d7598ac7b850abaca9a2dcc |
Provenance
File details
Details for the file cython_lint-0.14.2-py2.py3-none-any.whl.
File metadata
- Download URL: cython_lint-0.14.2-py2.py3-none-any.whl
- Upload date:
- Size: 17.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 72d4dd1626ccb4e7a440c0bba392c83fe39d8aca054a71c49469ee8e723a8fef |
|
| MD5 | 6dc4e436fb358d3f9d757efcb929f542 |
|
| BLAKE2b-256 | 115485bec00952b5966c093fcb2dca8a95a96f36595e7dcc856dc997927dfa42 |
