Skip to main content

A linter for Cython files

Project description

Build Status Coverage pre-commit.ci status

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.7.2
    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
  • late-binding closures https://docs.python-guide.org/writing/gotchas/#late-binding-closures
  • pycodestyle nitpicks, which you can turn off with --no-pycodestyle

More to come! Requests welcome!

Project details


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.7.2.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

cython_lint-0.7.2-py2.py3-none-any.whl (8.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file cython_lint-0.7.2.tar.gz.

File metadata

  • Download URL: cython_lint-0.7.2.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.15

File hashes

Hashes for cython_lint-0.7.2.tar.gz
Algorithm Hash digest
SHA256 b554ebfcf58231daed51c651f320d5e77e694e94672edd6072fb651e21fa00a0
MD5 f07c4351e7990030e583f0434a9db023
BLAKE2b-256 9fe49fac7276f4bdd713065dbbc825763959c72e5fc3f93760b851c197f35406

See more details on using hashes here.

Provenance

File details

Details for the file cython_lint-0.7.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for cython_lint-0.7.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ff37416c8f2bdf9eb10e7e8a2452f0edc3c5f2cae5f85bf2684614006b684ab4
MD5 853313d5d62c3e0db8bb30997c31929c
BLAKE2b-256 c409b82728d3f122a3b112c12d9c6e85fabeacc4f7b828333298df8ef39eec0d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page