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.6.0
hooks:
- id: cython-lint
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
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
pycodestylenitpicks, which you can turn off with--no-pycodestyle
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.6.0.tar.gz
(8.0 kB
view details)
Built Distribution
File details
Details for the file cython_lint-0.6.0.tar.gz.
File metadata
- Download URL: cython_lint-0.6.0.tar.gz
- Upload date:
- Size: 8.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2cfed551a9c01eed4a7d95e08b009b4004c3ed2282eec9c2b9ac111c5bf638b3 |
|
| MD5 | 901150f0abdc4a9bdf583faefc21fdfe |
|
| BLAKE2b-256 | 6a4d1fd9840061d1d4998febcf983ac225443dcf0e461b2b7f3d829c5f2e0dc7 |
Provenance
File details
Details for the file cython_lint-0.6.0-py2.py3-none-any.whl.
File metadata
- Download URL: cython_lint-0.6.0-py2.py3-none-any.whl
- Upload date:
- Size: 8.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | becff6cea32e43ae6eb0734009948b72e999a791ac9ee5f1ab30d26afdc42d08 |
|
| MD5 | bfc33c39d60d8a0174ae55b9c8320bdf |
|
| BLAKE2b-256 | e431b75513bfb90c3ee7ad50dd25c4818e9f5e9e13fbd0e5d18b473f76eeafdd |
