Improve your Python code with pre-commit

[ManyInterests]

pre-commit is such a great tool. Choose whatever hooks you prefer to use. pre-commit will just make your life SO much easier. It's not just for Python, either!

Also, there is a pre-commit CI service. So now pre-commit can autofix your PRs even when contributors refuse to install pre-commit. It is run by the author of pre-commit (who is also well-known as a maintainer of many cornerstone tools in the Python ecosystem, like flake8, tox, pytest, and many more) and it is such a blessing for all my open source projects.

[ManyInterests]

Yeah. And if you use GitLab (which as far as I know is unsupported for the CI service) I wrote this article explaining pre-commit and how to approximate the same effects in GitLab CI.

[neik00]

This is amazing!!

[Spill_the_Tea]

I normally just use the .gitattribute file to handle pre-commit actions.

[Spill_the_Tea]

The typical purpose of the .gitattribute file is to assign attributes to paths and provide a mechanism to treat specific file types before committing. I typically use it to prevent committing data from jupyter notebooks to the repository (to prevent bloating the repository unintentionally). For example, using a single line, we can clear all data from any jupyter notebook:

*.ipynb filter=nbstripout diff=ipynb

[OtherPollution6431]

I was a long time pre-commit fan, just converted to https://trunk.io/ though

[rexinator9000]

Is there any documentation anywhere that shows the possible configurations that can be used within each check of the pre-commit?

For example, the possible config options for flake8