pycodestyle VS pre-commit

PEP8 (pycodestyle): Named after Python’s PEP 8 style guide, this tool checks your Python code against some of the style conventions in PEP 8.

pycodestyle linter (used in Flake8 under the hood by default) already has E501 and W505 rules to validate the line length. flake8-length provides an alternative check that is smarter and more forgiving.

[flake8] max-line-length = 88 ignore = # False positive whitespace before ':' on list slice. # See https://github.com/PyCQA/pycodestyle/issues/373 for details E203

Linters analyze code to detect various categories of issues like logistical issue and stylistic issues. Some popular linters are Pylint, pycodestyle, Flake8 and Pylama.

Regarding item 4), sorry to make a relatively minor correction to your very helpful post, but you linked to a four-year-old version of a tool that has received many updates since. Here is the current version (note that the project has been renamed). In addition, it is decidedly not an official tool; making its unofficial status clear was the reason for the name change.

Link. When I write Python I usually have pycodestyle as my linter, and this got me thinking: If I already have a linter configuration for a project, why not just use the linter configuration as my editor configuration as well? The linter configuration is useful to others even if they use a different editor and I don't have to duplicate it in a local vimrc or editorconfig file. I can just use what I already have.

setuptools provides an easy way to do this via entry_points. Here's the relevant part of setup.py in pycodestyle

Today we are going to look at how to setup Black (a python code formatter) and pre-commit (a package for handling git hooks in python) to automatically format you code on commit.

# See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v3.2.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - id: check-toml - id: check-added-large-files - repo: local hooks: - id: tox lint name: tox-validation entry: pdm run tox -e test,lint language: system files: ^src\/.+py$|pyproject.toml|^tests\/.+py$ types_or: [python, toml] pass_filenames: false - id: tox docs name: tox-docs language: system entry: pdm run tox -e docs types_or: [python, rst, toml] files: ^src\/.+py$|pyproject.toml|^docs\/ pass_filenames: false - repo: https://github.com/pdm-project/pdm rev: 2.10.4 # a PDM release exposing the hook hooks: - id: pdm-lock-check - repo: https://github.com/jumanjihouse/pre-commit-hooks rev: 3.0.0 hooks: - id: markdownlint

Pre-commit hooks act as the first line of defense in maintaining code quality, seamlessly integrating with linters and code formatters. They automatically execute these tools each time a developer tries to commit code to the repository, ensuring the code adheres to the project's standards. If the hooks detect issues, the commit is paused until the issues are resolved, guaranteeing that only code meeting quality standards makes it into the repository.

Pre-commit Hooks: Pre-commit is a tool that can be set up to enforce coding rules and standards before you commit your changes to your code repository. This ensures that you can't even check in (commit) code that doesn't meet your standards. This allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.

Ah, fair enough!

On my team we use pre-commit[0] a lot. I guess I would define the history to be something like "has this commit ever been run through our pre-commit hooks?". If you rewrite history, you'll (usually) produce commits that have not been through pre-commit (and they've therefore dodged a lot of static checks that might catch code that wasn't working, at that point in time). That gives some manner of objectivity to the "history", although it does depend on each user having their pre-commit hooks activated in their local workspace.

[0]: https://pre-commit.com/

Pre-commit is a framework for managing and maintaining multi-language pre-commit hooks. It supports hooks for various programming languages. Using this framework, you only have to specify a list of hooks you want to run before every commit, and pre-commit handles the installation and execution of those hooks despite your project’s primary language.

You can learn more here: pre-commit.com

Note this includes support for pre-commit.

As a nice next step, you could also add mypy to check your type hints are consistent, and automate running all this via pre-commit hooks set up with… pre-commit.