https://github.com/pycqa/pycodestyle

Simple Python style checker in one Python file
https://github.com/pycqa/pycodestyle

flake8-plugin linter-flake8 linter-plugin pep8 python style-guide styleguide

Last synced: 7 days ago
JSON representation

Simple Python style checker in one Python file

• Host: GitHub
• URL: https://github.com/pycqa/pycodestyle
• Owner: PyCQA
• License: other
• Created: 2009-10-02T00:43:37.000Z (about 15 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T01:21:00.000Z (15 days ago)
• Last Synced: 2024-11-01T19:02:52.741Z (11 days ago)
• Topics: flake8-plugin, linter-flake8, linter-plugin, pep8, python, style-guide, styleguide
• Language: Python
• Homepage: https://pycodestyle.pycqa.org
• Size: 1.81 MB
• Stars: 5,032
• Watchers: 114
• Forks: 753
• Open Issues: 107
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
pycodestyle (formerly called pep8) - Python style guide checker

===============================================================

.. image:: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml/badge.svg

   :target: https://github.com/PyCQA/pycodestyle/actions/workflows/main.yml

   :alt: Build status

.. image:: https://readthedocs.org/projects/pycodestyle/badge/?version=latest

    :target: https://pycodestyle.pycqa.org

    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/wheel/pycodestyle.svg

   :target: https://pypi.org/project/pycodestyle/

   :alt: Wheel Status

.. image:: https://badges.gitter.im/PyCQA/pycodestyle.svg

   :alt: Join the chat at https://gitter.im/PyCQA/pycodestyle

   :target: https://gitter.im/PyCQA/pycodestyle?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

pycodestyle is a tool to check your Python code against some of the style

conventions in `PEP 8`_.

.. _PEP 8: http://www.python.org/dev/peps/pep-0008/

.. note::

    This package used to be called ``pep8`` but was renamed to ``pycodestyle``

    to reduce confusion. Further discussion can be found `in the issue where

    Guido requested this

    change `_, or in the

    lightning talk at PyCon 2016 by @IanLee1521:

    `slides `_

    `video `_.

Features

--------

* Plugin architecture: Adding new checks is easy.

* Parseable output: Jump to error location in your editor.

* Small: Just one Python file, requires only stdlib. You can use just

  the ``pycodestyle.py`` file for this purpose.

* Comes with a comprehensive test suite.

Installation

------------

You can install, upgrade, and uninstall ``pycodestyle.py`` with these commands::

  $ pip install pycodestyle

  $ pip install --upgrade pycodestyle

  $ pip uninstall pycodestyle

There's also a package for Debian/Ubuntu, but it's not always the

latest version.

Example usage and output

------------------------

::

  $ pycodestyle --first optparse.py

  optparse.py:69:11: E401 multiple imports on one line

  optparse.py:77:1: E302 expected 2 blank lines, found 1

  optparse.py:88:5: E301 expected 1 blank line, found 0

  optparse.py:347:31: E211 whitespace before '('

  optparse.py:357:17: E201 whitespace after '{'

  optparse.py:472:29: E221 multiple spaces before operator

You can also make ``pycodestyle.py`` show the source code for each error, and

even the relevant text from PEP 8::

  $ pycodestyle --show-source --show-pep8 testing/data/E40.py

  testing/data/E40.py:2:10: E401 multiple imports on one line

  import os, sys

           ^

      Imports should usually be on separate lines.

      Okay: import os\nimport sys

      E401: import sys, os

Or you can display how often each error was found::

  $ pycodestyle --statistics -qq Python-2.5/Lib

  232     E201 whitespace after '['

  599     E202 whitespace before ')'

  631     E203 whitespace before ','

  842     E211 whitespace before '('

  2531    E221 multiple spaces before operator

  4473    E301 expected 1 blank line, found 0

  4006    E302 expected 2 blank lines, found 1

  165     E303 too many blank lines (4)

  325     E401 multiple imports on one line

  3615    E501 line too long (82 characters)

Links

-----

* `Read the documentation `_

* `Fork me on GitHub `_