Skip to main content

A linter for Cython files

Project description

Build Status Coverage pre-commit.ci status

cython-lint

Everything flake8 used to do (by accident), plus much more.

A tool and pre-commit hook to lint Cython files.

Used by

Here's some major projects using cython-lint - is yours missing? Feel free to open a pull request!

In addition:

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

  • assert statement with tuple condition (always true...)
  • comma after base type definition (e.g. cdef ndarray, arr)
  • comparison between constants
  • dangerous default value
  • dict key repeated
  • dict key variable repeated
  • f-string without placeholders
  • if-statement with tuple condition (always true...)
  • late-binding closures https://docs.python-guide.org/writing/gotchas/#late-binding-closures
  • pointless string statement
  • pycodestyle nitpicks (which you can turn off with --no-pycodestyle)
  • repeated element in set
  • .strip, .rstrip, or .lstrip used with repeated characters
  • unnecessary list index lookup
  • unnecessary import alias
  • variable defined but unused
  • variable imported but unused

In addition, the following automated fixers are implemented:

  • double-quote-cython-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.12.1.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

cython_lint-0.12.1-py2.py3-none-any.whl (17.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for cython_lint-0.12.1.tar.gz
Algorithm Hash digest
SHA256 40e9690598666044e7d30e695d2f163a4af6a7d40ba59d02cd8c403b6d7afa34
MD5 dd35353e3ce7824fa9123204650cde7a
BLAKE2b-256 0c62be3c398edf6ff7dfc434867925e06e3da7ab6e88c3c222e4ca157de6e823

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cython_lint-0.12.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 50957893e61e26863777cccb8e375decb7b35b433703395cfe2e2f2853f9cda1
MD5 853bc36c2ce351d04c444632cb343862
BLAKE2b-256 54613cb6d85ae64d5178b446e7aab099d15c8dacbabbdff29f900e6a4396d963

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