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.2.1
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
- 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.2.1.tar.gz
(6.8 kB
view details)
Built Distribution
File details
Details for the file cython_lint-0.2.1.tar.gz.
File metadata
- Download URL: cython_lint-0.2.1.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f106b0934954936025f94148a496270d3eafa44791632b488c957c60e8da1911 |
|
| MD5 | a89db64436b8798c8cc6c2e7d5e3f807 |
|
| BLAKE2b-256 | 05eb093f0e10d7910901fe891b57f04dec2c0e52f4178934fa81b21592dcc4a0 |
Provenance
File details
Details for the file cython_lint-0.2.1-py2.py3-none-any.whl.
File metadata
- Download URL: cython_lint-0.2.1-py2.py3-none-any.whl
- Upload date:
- Size: 7.0 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 | 649bc243177c25c1bbeb38c5eee8677ff9c5bb9784a6cc48ed494d201bc92e62 |
|
| MD5 | 621f7333f9c5fccd999b6d798d2c0722 |
|
| BLAKE2b-256 | bb0587425bd3ed5445884c516e50696042e2a3e006fd52258629cf39207ac3f5 |
