cython-lint 0.6.0

A linter for Cython files

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-lint comment (analogous to # noqa in flake8);
• use the command-line argument --max-line-length to control the maximum line length used by pycodestyle;
• use the command-line argument --no-pycodestyle if 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
• pycodestyle nitpicks, which you can turn off with --no-pycodestyle

More to come! Requests welcome!