Added poetry checks in pre-commit and actions.

.github/workflows/check.yml

@@ -46,6 +46,9 @@ jobs:
  - name: Install Dependencies
  run: |
  poetry env use 3.12
+ - name: Check Poetry
+ run: |
+ poetry check --lock
  - name: Run black
  run: |
  poetry install --only black

.pre-commit-config.yaml

@@ -1,34 +1,54 @@
 fail_fast: true
 repos:
-- repo: local
- hooks:
- - id: black
- name: black
- entry: poetry run black
- language: system
- types: [file, python]
- - id: isort
- name: isort
- entry: poetry run isort
- language: system
- types: [file, python]
- - id: ruff
- name: ruff
- entry: poetry run ruff check --fix
- language: system
- types: [file, python]
- - id: bandit
- name: bandit
- entry: poetry run bandit -c pyproject.toml -r .
- language: system
- types: [file, python]
- - id: xenon
- name: xenon
- entry: bash -c "poetry run xenon -a $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['average'])\") -b $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['block'])\") -m $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['module'])\") . "
- language: system
- types: [file, python]
- - id: mypy
- name: mypy
- entry: poetry run mypy --no-namespace-packages --exclude esgf_playground_utils/models/__init__.py
- language: system
- types: [ file, python ]
+ - repo: https://github.com/python-poetry/poetry
+ rev: '1.8.3' # add version here
+ hooks:
+ - id: poetry-check
+ - id: poetry-lock
+ - repo: local
+ hooks:
+ - id: black
+ name: black
+ entry: poetry run black
+ language: system
+ types: [ file, python ]
+ - id: isort
+ name: isort
+ entry: poetry run isort
+ language: system
+ types: [ file, python ]
+ - id: ruff linter
+ name: ruff lint
+ entry: poetry run ruff check --fix
+ language: system
+ types: [ file, python ]
+ - id: bandit
+ name: bandit
+ entry: poetry run bandit -c pyproject.toml -r .
+ language: system
+ types: [ file, python ]
+ - id: xenon
+ name: xenon
+ entry: bash -c "poetry run xenon -a $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['average'])\") -b $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['block'])\") -m $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['module'])\") . "
+ language: system
+ types: [ file, python ]
+ - id: mypy
+ name: mypy
+ entry: poetry run mypy --no-namespace-packages --exclude esgf_playground_utils/models/__init__.py
+ language: system
+ types: [ file, python ]
+ - id: bandit
+ name: bandit
+ entry: poetry run bandit -c pyproject.toml -r .
+ language: system
+ types: [ file, python ]
+ - id: xenon
+ name: xenon
+ entry: bash -c "poetry run xenon -a $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['average'])\") -b $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['block'])\") -m $(poetry run python -c \"import tomllib; f = open('pyproject.toml','rb') ; data = tomllib.load(f); f.close(); print(data['tool']['quality']['mccabe']['module'])\") . "
+ language: system
+ types: [ file, python ]
+ - id: mypy
+ name: mypy
+ entry: poetry run mypy --no-namespace-packages --exclude esgf_playground_utils/models/__init__.py
+ language: system
+ types: [ file, python ]

CONTRIBUTING.md

@@ -28,12 +28,14 @@ foo@bar:~$ poetry run install pre-commit
 
 When you commit, the following checks will be run:
 
-- black[^1] (python style formatter)
-- isort[^1] (python import order checker)
-- ruff[^1] (python linter)
-- mypy (python static type analysis)
-- bandit (pythin SAST analyis)
-- xenon (McCabe cyclomatc complexity analysis)
+- poetry-check (checks the conformity of the pyproject.toml and poetry.lock file)
+- poetry-lock[^1] (ensures an up-to-date lock file)
+- black[^1] (python style formatter)
+- isort[^1] (python import order checker)
+- ruff linter[^1] (python linter)
+- mypy (python static type analysis)
+- bandit (python SAST analyis)
+- xenon (McCabe cyclomatc complexity analysis)
 
 You can disable the `pre-commit hooks` per commit with the flag `--no-verify` however all checks will be preformed in the CI.