How to have a single source of truth for poetry and pre-commit package version?

Question

I'm looking into this Python project template. They use poetry to define dev dependencies

[tool.poetry.dev-dependencies]
black = {version = "*", allow-prereleases = true}
flake8 = "*"
isort = "^5.6"
mypy = ">0.900,<1"
...

They use also pre-commit to check housekeeping things (e.g., formatting, linting, issorting, ...), both for git and for CI workflows:

minimum_pre_commit_version: 2.8.0
default_stages: [commit, push, manual]
repos:
  - repo: https://github.com/psf/black
    rev: 21.11b1
    hooks:
      - id: black
  - repo: https://github.com/pycqa/flake8
    rev: 4.0.1
    hooks:
      - id: flake8
        args: [--max-line-length=88]
  - repo: https://github.com/pycqa/isort
    rev: 5.10.1
    hooks:
      - id: isort
        args: [--filter-files]
  - ...

In my case, I definitely want a local version of dev packages managed by poetry for my IDE, and I'd like also to harness the pre-commit framework "as is", without switching to language: system. Working this way, I need to manage each package version in two different places.

Is there a non-manual way to keep dev packages versions (i.e,. black, flake8, isort, mypy, ...) aligned to a single source of truth? A Coockiecutter template could be an option, but it looks overkilling.

at some point you'll need the information in two places -- the template has versions also in `poetry.lock` so you'd need some code to synchronize the two — anthony sottile, Nov 27 '21 at 15:27
Yep, true. An option could be using e metatemplate to sync them all. Thanks. — floatingpurr, Nov 27 '21 at 15:31
Finally, I created a pre-commit hook to do the job. See my answer here below — floatingpurr, Dec 10 '21 at 16:40

floatingpurr · Accepted Answer · 2022-07-25T15:24:49.953

Finally, I created a pre-commit hook to do the job: https://github.com/floatingpurr/sync_with_poetry

Edit: If you use PDM, you can refer to this one: https://github.com/floatingpurr/sync_with_pdm

This hook just keeps in sync the repos rev in .pre-commit-config.yaml with the packages version locked into poetry.lock.

If you use:

Poetry for dependency management
local dev packages for your IDE (via Poetry)
pre-commit hooks

this meta-hook can be useful to (un-)bump repos rev for you.

score 7 · Answer 2 · answered Nov 27 '21 at 16:17

7

I would recommend keeping the linter stuff only in the config of pre-commit.

pre-commit doesn't necessarily run as a pre-commit hook. You can run the checks every time by pre-commit run --all-files or if you want to run it only on given files with pre-commit run --files path/to/file.

You can even say which which check should run, e.g. pre-commit run black --all-files

answered Nov 27 '21 at 16:17

finswimmer

10,896
3
34
44

1

I see, but I need another copy of them for live interaction provided by the IDE (e.g., VS Code) – floatingpurr Nov 27 '21 at 21:38
1

Not sure how it works in VS Code. Because you can run a specific pre-commit check on a specific file (`pre-commit run --files `) it is no problem in PyCharm to run it as in "External Tool". I guess VS Code has something similar. – finswimmer Nov 28 '21 at 08:20
*Edited comment*: thanx for your suggestion. Your guess is right. VS Code needs to point at each linter / formatter path that is then passed to the the specified python interpreter. E.g., `"python.formatting.blackPath":"black"`. I've not found a way to pass in the config `pre-commit run black --files `. This seems something that does not play nicely with the way VS Code works. – floatingpurr Dec 10 '21 at 18:05
Thanks for the suggestion @finswimmer! – floatingpurr Dec 10 '21 at 18:38

How to have a single source of truth for poetry and pre-commit package version?

2 Answers2