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.9.0
    hooks:
    -   id: cython-lint
    -   id: double-quote-strings

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
my_file_3.pyx:4:9: dangerous default value!
my_file_3.pyx:5:9: comma after base type in definition

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
  • repeated element in set
  • .strip, .rstrip, or .lstrip used with repeated characters
  • comparison between constants
  • late-binding closures https://docs.python-guide.org/writing/gotchas/#late-binding-closures
  • pycodestyle nitpicks, which you can turn off with --no-pycodestyle

In addition, the following automated fixers are implemented:

  • double-quote-strings (replace single quotes with double quotes, like the black formatter does)

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.9.0.tar.gz (3.1 kB view hashes)

Uploaded Source

Built Distribution

cython_lint-0.9.0-py2.py3-none-any.whl (9.0 kB view hashes)

Uploaded Python 2 Python 3

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