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.3.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.
Currently, the following checks are implemented:
- variable defined but unused
- variable imported but unused
- comma after base type definition (e.g.
cdef ndarray, arr) - pycodestyle checks, except these that aren't in general applicable to Cython code:
- E121 continuation line under-indented for hanging indent
- E123 closing bracket does not match indentation of opening bracket’s line
- E126 continuation line over-indented for hanging indent
- E133 closing bracket is missing indentation
- E203 whitespace before ‘,’, ‘;’, or ‘:’
- E211 whitespace before '('
- E225 missing whitespace around operator
- E226 missing whitespace around arithmetic operator
- E227 missing whitespace around bitwise or shift operator
- E241 multiple spaces after ‘,’
- E242 tab after ‘,’
- E271 multiple spaces after keyword
- E272 multiple spaces before keyword
- E275 missing whitespace after keyword
- E4 imports (
isortsupports Cython code, best to just use that) - E704 multiple statements on one line (def)
- E9 runtime
- W5 line break warning
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.3.0.tar.gz
(7.4 kB
view details)
Built Distribution
File details
Details for the file cython_lint-0.3.0.tar.gz.
File metadata
- Download URL: cython_lint-0.3.0.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | abaefebf4ed2fe28f47e9cc2bab0eb260028a2f3eeb45545a4afffb29b39a0fe |
|
| MD5 | 14ac9921209cf42058df355612205fdd |
|
| BLAKE2b-256 | 80b4de55d828b477465517a65a3189ca93baa5d2c91f9dcfdc4422460a5e856e |
Provenance
File details
Details for the file cython_lint-0.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: cython_lint-0.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.5 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 | c3c0bee2a1451aaf99880c49012760c1ae7d3d9e8777070d894cab08c3f40539 |
|
| MD5 | 6f2bc0a6a4f5fb7a429f3209efd548b5 |
|
| BLAKE2b-256 | 1d42bcc190cf3facc0eeadf2a3a1830693132820648d541bb9536ad0a2adbcce |
