pre-commit: "Expected one of commit, commit-msg, manual, ..." since 23.11.0 #4065

martin-thoma · 2023-11-21T13:19:34Z

Describe the bug

When the pre-commit hook is installed and I commit, I get:

An error has occurred: InvalidManifestError: 
==> File /home/martin/.cache/pre-commit/repolc31_gpb/.pre-commit-hooks.yaml
==> At Hook(id='black')
==> At key: stages
==> At index 0
=====> Expected one of commit, commit-msg, manual, merge-commit, post-checkout, post-commit, post-merge, post-rewrite, prepare-commit-msg, push but got: 'pre-commit'

To Reproduce

$ python --version
3.11.1

$ python -m venv venv
$ source venv/bin/activate

$ vim .pre-commit-config.yaml
# Add this:
-   repo: https://github.com/psf/black
    rev: 23.11.0
    hooks:
    -   id: black  

$ echo "a = 'b'" > c.py

$ git init
$ git add .pre-commit-config.yaml c.py
$ pip install pre-commit
$ pre-commit install

$ pre-commit --version
pre-commit 3.5.0

$ git commit -m "Example"

The resulting error is:

An error has occurred: InvalidManifestError: 
==> File /home/martin/.cache/pre-commit/repolc31_gpb/.pre-commit-hooks.yaml
==> At Hook(id='black')
==> At key: stages
==> At index 0
=====> Expected one of commit, commit-msg, manual, merge-commit, post-checkout, post-commit, post-merge, post-rewrite, prepare-commit-msg, push but got: 'pre-commit'

Expected behavior

A pre-commit fixes c.py

Environment

Black's version: 23.11.0
OS and Python version: Linux / Python 3.11.1

Additional context

#3940

The text was updated successfully, but these errors were encountered:

martin-thoma · 2023-11-21T13:32:41Z

According to https://github.com/pre-commit/pre-commit/blob/main/CHANGELOG.md#320---2023-03-17 the "pre-commit" value should be allowed since 3.2.0, but I think I have 3.5.0 installed.

Looking in site-packages/pre_commit/clientlib.py, I see:

HOOK_TYPES = (
    'commit-msg',
    'post-checkout',
    'post-commit',
    'post-merge',
    'post-rewrite',
    'pre-commit',
    'pre-merge-commit',
    'pre-push',
    'pre-rebase',
    'prepare-commit-msg',
)

That looks correct

martin-thoma · 2023-11-21T13:35:44Z

The minimum_pre_commit_version should get updated to 3.2.0 at least.

davidculley · 2023-11-21T14:19:48Z

Does executing pre-commit clean fix the issue?

martin-thoma · 2023-11-21T14:45:52Z

Does executing pre-commit clean fix the issue?

Yes, it does :-) Interesting. I need to check what happens there.

Is the update of minimum_pre_commit_version required or was I wrong there?

davidculley · 2023-11-21T16:39:51Z

@Wolfcast: Your error message says Expected […] commit which hints at a version of pre-commit older than version 3.2.0 — since version 3.2.0, it's pre-commit instead of just commit — and your error message continues with but got: 'pre-commit' because black 23.11.0 now requires a version of pre-commit that is newer than 3.2.0.

Try updating pre-commit:

python3 -m pip install --upgrade pre-commit

Wolfcast · 2023-11-21T16:42:32Z

@davidculley Yeah I deleted my comment before your reply :) The global pre-commit was up to date but not the one in my venv. pip install --upgrade pre-commit in the venv fixed it for me. My bad! Thanks!

andrewmwilson · 2023-11-22T00:22:18Z

IMO this solution is preferable #4041

The current version of Debian uses pre-commit 3.0.4, so it would be nice for it to work on that.

https://packages.debian.org/bookworm/pre-commit

marcindulak · 2023-12-14T19:31:14Z

Ubuntu 22.04 LTS (jammy) has pre-commit 2.17.0 https://packages.ubuntu.com/jammy/pre-commit

davidculley · 2023-12-14T19:45:46Z

What am I missing @andrewmwilson @marcindulak, why can't Debian/Ubuntu users not execute pip install --user pre-commit to get a current version of pre-commit?

marcindulak · 2023-12-15T07:24:36Z

What am I missing @andrewmwilson @marcindulak, why can't Debian/Ubuntu users not execute pip install --user pre-commit to get a current version of pre-commit?

In hobby projects it's possible to pull packages from the internet, but in enterprises someone with required permissions would need to modify CI systems and developer machine images to include that change.

Additionally, a custom installation of pre-commit brings additional packages (see example below), and those would create a liability by extending the need of scanning them for vulnerabilities and patching, while those tasks are normally delegated to the operating system vendor

python3 -m venv venv
. venv/bin/activate
python3 -m pip install pre-commit
...
Successfully installed cfgv-3.4.0 distlib-0.3.8 filelock-3.13.1 identify-2.5.33 nodeenv-1.8.0
platformdirs-4.1.0 pre-commit-3.5.0 pyyaml-6.0.1 virtualenv-20.25.0

Seluj78 · 2023-12-22T14:34:29Z

Still getting the error after a pre-commit clean and a pip install --upgrade pre-commit.

wiseaidev · 2023-12-22T18:04:00Z

For poetry bros, remove it first:

$ poetry remove pre-commit
Updating dependencies
Resolving dependencies... (0.5s)

Package operations: 0 installs, 0 updates, 6 removals

  • Removing cfgv (3.4.0)
  • Removing identify (2.5.33)
  • Removing nodeenv (1.8.0)
  • Removing pre-commit (2.21.0)
  • Removing pyyaml (6.0.1)
  • Removing setuptools (69.0.2)

Writing lock file

Then add it:

$ poetry add pre-commit --group dev
Using version ^3.6.0 for pre-commit

Updating dependencies
Resolving dependencies... (0.8s)

Package operations: 6 installs, 0 updates, 0 removals

  • Installing setuptools (69.0.2)
  • Installing cfgv (3.4.0)
  • Installing identify (2.5.33)
  • Installing nodeenv (1.8.0)
  • Installing pyyaml (6.0.1)
  • Installing pre-commit (3.6.0)

Writing lock file

hauntsaninja · 2023-12-29T09:16:48Z

Note for anyone currently broken by this, you can try using psf/black-pre-commit-mirror instead. This never received the change in #3940, so should still work with older versions of pre-commit. It'll also make black like 2x faster :-)

davidculley · 2024-01-06T06:29:16Z

In hobby projects it's possible to pull packages from the internet, but in enterprises someone with required permissions would need to modify CI systems and developer machine images to include that change.

Additionally, a custom installation of pre-commit brings additional packages (see example below), and those would create a liability by extending the need of scanning them for vulnerabilities and patching, while those tasks are normally delegated to the operating system vendor

Thanks for the explanation @marcindulak and sorry for the late answer.

I haven't thus far found myself in such a situation, therefore I wasn't aware of the issues you describe. Now I can better put myself in your shoes, thank you.

This fixes the issue described in this bug report in black: psf/black#4065

Recent commit 0bd340d ("pre-commit autoupdate") bumped the isort version to 6.0.0. Subsequently, I started running into: ... $ SKIP=flake8,isort pre-commit run An error has occurred: InvalidManifestError: ==> File /home/vries/.cache/pre-commit/repommstqefj/.pre-commit-hooks.yaml ==> At Hook(id='isort') ==> At key: stages ==> At index 0 =====> Expected one of commit, commit-msg, manual, merge-commit, \ post-checkout, post-commit, post-merge, post-rewrite, prepare-commit-msg, \ push but got: 'pre-commit' Check the log at /home/vries/.cache/pre-commit/pre-commit.log ... I found a similar PR [1], that explains that using pre-commit as a stage (as isort 6.0.0 does) is supported starting pre-commit 3.2.0. Add minimum_pre_commit_version 3.2.0 in .pre-commit-config.yaml, as suggested in the PR. After adding this, I get a more helpful message: ... $ SKIP=flake8,isort pre-commit run An error has occurred: InvalidConfigError: ==> File .pre-commit-config.yaml ==> At Config() ==> At key: minimum_pre_commit_version =====> pre-commit version 3.2.0 is required but version 2.17.0 is installed. \ Perhaps run `pip install --upgrade pre-commit`. Check the log at /home/vries/.cache/pre-commit/pre-commit.log ... and after doing so which upgrades pre-commit to version 4.1.0, as well as re-installing pre-commit using: ... $ pre-commit uninstall $ pre-commit install ... I have a functional setup again. Interestingly, since pre-commit 4.1.0 runs in a python 3.11 environment, I no longer need to skip flake8 and isort, as I needed to previously when the system python 3.6 was used. Approved-By: Simon Marchi <[email protected]> [1] psf/black#4065

martin-thoma added the T: bug Something isn't working label Nov 21, 2023

davidculley added a commit to davidculley/black that referenced this issue Nov 21, 2023

fix(pre-commit): raise minimum_pre_commit_version (psf#4065)

6372c5a

martin-thoma mentioned this issue Nov 21, 2023

fix(pre-commit): raise minimum_pre_commit_version (#4065) #4067

Closed

3 tasks

This was referenced Dec 29, 2023

Installation and update of black over a docker container #4136

Closed

Revert "confine pre-commit to stages (#3940)" #4137

Merged

JelleZijlstra closed this as completed in #4137 Jan 2, 2024

michele-milesi mentioned this issue Jan 5, 2024

feat: new release + update dev dependencies Eclectic-Sheep/sheeprl#182

Merged

4 tasks

This was referenced Jan 18, 2024

Current pre-commit version no longer works with latest hooks neurobagel/api#258

Closed

Current pre-commit version no longer works with latest hooks neurobagel/bagel-cli#272

Closed

Flimm added a commit to jazzband/django-invitations that referenced this issue Jun 12, 2024

Upgrade version of "pre-commit" package

3583738

This fixes the issue described in this bug report in black: psf/black#4065

HenryRLee mentioned this issue Oct 18, 2024

Refactor _evaluate_omaha_cards function for simplicity HenryRLee/PokerHandEvaluator#92

Closed

SigureMo mentioned this issue Nov 16, 2024

[Typos] Add Typos to pre-commit PaddlePaddle/Paddle#69434

Merged

kiinami mentioned this issue Dec 15, 2024

Pre-commit no funciona espeto-hub/uvlhub#56

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pre-commit: "Expected one of commit, commit-msg, manual, ..." since 23.11.0 #4065

pre-commit: "Expected one of commit, commit-msg, manual, ..." since 23.11.0 #4065

martin-thoma commented Nov 21, 2023 •

edited

Loading

martin-thoma commented Nov 21, 2023

martin-thoma commented Nov 21, 2023

davidculley commented Nov 21, 2023

martin-thoma commented Nov 21, 2023

davidculley commented Nov 21, 2023 •

edited

Loading

Wolfcast commented Nov 21, 2023 •

edited

Loading

andrewmwilson commented Nov 22, 2023

marcindulak commented Dec 14, 2023

davidculley commented Dec 14, 2023

marcindulak commented Dec 15, 2023

Seluj78 commented Dec 22, 2023

wiseaidev commented Dec 22, 2023

hauntsaninja commented Dec 29, 2023

davidculley commented Jan 6, 2024

pre-commit: "Expected one of commit, commit-msg, manual, ..." since 23.11.0 #4065

pre-commit: "Expected one of commit, commit-msg, manual, ..." since 23.11.0 #4065

Comments

martin-thoma commented Nov 21, 2023 • edited Loading

martin-thoma commented Nov 21, 2023

martin-thoma commented Nov 21, 2023

davidculley commented Nov 21, 2023

martin-thoma commented Nov 21, 2023

davidculley commented Nov 21, 2023 • edited Loading

Wolfcast commented Nov 21, 2023 • edited Loading

andrewmwilson commented Nov 22, 2023

marcindulak commented Dec 14, 2023

davidculley commented Dec 14, 2023

marcindulak commented Dec 15, 2023

Seluj78 commented Dec 22, 2023

wiseaidev commented Dec 22, 2023

hauntsaninja commented Dec 29, 2023

davidculley commented Jan 6, 2024

martin-thoma commented Nov 21, 2023 •

edited

Loading

davidculley commented Nov 21, 2023 •

edited

Loading

Wolfcast commented Nov 21, 2023 •

edited

Loading