DOC: Create link from "Creating a development environment" to "pre-commit"

[Dr-Irv]

I had to recreate my pandas environment from environment.yml . Then when I updated a PR, the pre-commit was failing because autotyping was not installed. It needs to be added to environment.yml

This is a docs issue. See #48941 (comment)

[MarcoGorelli]

can you show the error please? I wouldn't expect it to fail, because it's listed in the additional dependencies

pandas/.pre-commit-config.yaml

Line 281 in 8bcc1eb

- autotyping==22.9.0

[Dr-Irv]

autotyping..............................................................................................Failed
- hook id: autotyping
- exit code: 1

Could not find autotyping in any configured modules

I had to install autotyping myself.

[MarcoGorelli]

🤔 how odd, I don't have it installed in my environment

(pandas-dev) marcogorelli@DESKTOP-U8OKFP3:~/pandas-dev$ pre-commit run autotyping -a
autotyping...............................................................Passed
(pandas-dev) marcogorelli@DESKTOP-U8OKFP3:~/pandas-dev$ pip freeze | grep autotyping

I'll take a look tomorrow, but I wouldn't think you'd need to add it to environment.yml too

[MarcoGorelli]

I tried again, with a new virtual environment, and it worked fine again:

(.venv) (base) marcogorelli@DESKTOP-U8OKFP3:~/pandas-dev$ pre-commit run autotyping -a
[INFO] Installing environment for local.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
autotyping...............................................................Passed

I've never seen Could not find autotyping in any configured modules TBH - perhaps try opening a bug in https://github.com/pre-commit/pre-commit ? The additional_dependencies should definitely provide you with all you need in a local hook

[MarcoGorelli]

Ah, got it (maybe)

The only way I can reproduce this error is by removing autotyping from

https://github.com/pandas-dev/pandas/blob/8bcc1ebb8babdfc95afe89219dabcaa98614caea/.libcst.codemod.yaml#L14l

Does

git diff upstream/main -- .libcst.codemod.yaml .pre-commit-config.yaml

show nothing?

[Dr-Irv]

Does

git diff upstream/main -- .libcst.codemod.yaml .pre-commit-config.yaml

show nothing?

Yes, it shows nothing.

[Dr-Irv]

Maybe there is something I needed to do to set up the pre-commit hook/installs?

[rhshadrach]

One needs to run pre-commit install within the project directory to setup. I often forget to do this.

[twoertwein]

Could it maybe be an issue on windows with how LibCST calls autotyping?

[Dr-Irv]

One needs to run pre-commit install within the project directory to setup. I often forget to do this.

It might be useful to have a link from https://pandas.pydata.org/pandas-docs/stable/development/contributing_environment.html to https://pandas.pydata.org/pandas-docs/stable/development/contributing_codebase.html#pre-commit so that when you are setting up a development environment, you are also told to do the pre-commit install.

I will change the title of the issue accordingly.

[MarcoGorelli]

It you don't do pre-commit install, then pre-commit wouldn't run automatically on commit - if it ran for you then you must have already done it, or triggered it manually. pre-commit install isn't necessary for running it manually

I'll try this out on Windows to see if that's the issue

[Dr-Irv]

I created a new environment, then did a commit, and had the message. Now I had done a pre-commit install on a previous pandas environment, so maybe that is the issue, because it is remembering a previous run?

[MarcoGorelli]

🤔 hmm yeah, sounds plausible. In which case, linking to the instructions suggesting pre-commit install (as you're suggesting) would be an improvement

[EdwinCXM]

Hi, I'm a first time contributor, has someone taken this yet? If not I would love to take this

[MarcoGorelli]

go ahead, thanks!

[EdwinCXM]

Thanks! Do I need to get assigned this?

[MarcoGorelli]

if you comment "take" it'll be assigned to you - no need if you've already commented though

[EdwinCXM]

take

[HatimZ]

take