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.4.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.

Currently, the following 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
  • pycodestyle checks, except these that aren't in general applicable to Cython code

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

Uploaded Source

Built Distribution

cython_lint-0.4.0-py2.py3-none-any.whl (7.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cython_lint-0.4.0.tar.gz
Algorithm Hash digest
SHA256 df4238feb3efb68e9b8fc6b4ea632340fb6293886df66171bf2f0dec158889bf
MD5 aa64e7c405eb6090271a22f5a1f0f772
BLAKE2b-256 e75bc42fb407368f70e014384d34a12e2157c2ed677a14dec6b2a748a4e408e8

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cython_lint-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dfbcfcd426a7c6246a15c9b9e74996b520bfb14f6d835480dbafecaba112ed1b
MD5 f66752bfc54ac37129ab6941a2a708fe
BLAKE2b-256 ff5b673179ac22dd5873ccff0f383466e0f51584c40399389cb56919bc21670c

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