Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-commit to prevent CI fails due to linting #42

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 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-added-large-files
- repo: https://github.com/psf/black
rev: 23.1.0
hooks:
- id: black
- repo: https://github.com/pycqa/isort
rev: 5.12.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On a besoin de spécifier une version de black dans le pre-commit en plus du poetry.lock?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ouais, la solution en commentaire plus bas n'a pas besoin de le faire, mais ça prend beaucoup plus longtemps à rouler

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ouin, j'aime pas trop que ça soit dupliqué et donc éventuellement désynchronisé, avec un pre-commit qui génère qqc qui plante avec tox -e black. L'idéal serait de rouler precommit dans tox comme t'as fait dans orion.

hooks:
- id: isort
name: isort (python)
args: ["--profile", "black", "--filter-files"]

# IDEA: Might want to look into poetry-specific hooks as well:
# https://python-poetry.org/docs/master/pre-commit-hooks/

# NOTE: Does the same thing, but doesn't require hard-coding a version (uses poetry to run the
# hook). This takes much longer (like 7 secs without pylint, and 25 seconds with pylint) vs <1 sec.
# - repo: local
# hooks:
# - id: black
# name: black
# entry: poetry
# language: system
# types: [python]
# pass_filenames: false
# args: ["run", "tox", "-e", "black_fix"]
# - id: isort
# name: isort
# entry: poetry
# language: system
# types: [python]
# pass_filenames: false
# args: ["run", "tox", "-e", "isort_fix"]
# - id: pylint
# name: pylint
# entry: poetry
# language: system
# types: [python]
# pass_filenames: false
# args: ["run", "tox", "-e", "lint"]
80 changes: 79 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ pytest-regressions = ">= 2.4.2"
tox = ">= 4.4.5"
pytest-freezegun = ">= 0.4.2"
fabric = {extras = ["testing"], version = "^3.0.0"}
pre-commit = "^3.1.1"

[tool.poetry.group.examples.dependencies]
seaborn = "^0.12.2"
Expand Down