Add D400 pydocstyle check

[vincbeck]

Enable D400 pydocstyle check. Part of #10742.

---

^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

[ashb]

Not every instance of the change is correct

[uranusjr]

I wonder if it’d be a good idea to make Pydocstyle skip the migrations directory altogether, since the docstring auto-generated by alembic by default does not follow D400. Or maybe we need to configure alembic to emit a different migration file template.

[uranusjr]

Would it be possible to split migrations and providers into another PR, or does everything must be fixed once? This is really a lot.

[vincbeck]

Would it be possible to split migrations and providers into another PR, or does everything must be fixed once? This is really a lot.

I can split. Let me do that. That'll definitely help the review

[vincbeck]

Hold on. No, that wont work. Static checks will fail unless we specify we want to run the D400 check only on specific files/folders. I am not sure it is possible

[vincbeck]

Or one solution would be to make the modifications without enabling the check. Let me know, what you think

[uranusjr]

Static checks will fail unless we specify we want to run the D400 check only on specific files/folders.

Yeah that’s what I suspected as well 😞

make the modifications without enabling the check

This sounds like a workable alternative. I think we did that when we enabled some other checks previously. Make the changes gradually, and enable the check only after all (or most of) the changes are made. IIRC @Bowrna worked on some of the changes back then and may be able to share some experience.

[Bowrna]

yes let me check the changes i have done and tell you. for testing purpose, i remember i enabled it to run for specific files alone before enabling it for all the files.

[vincbeck]

yes let me check the changes i have done and tell you. for testing purpose, i remember i enabled it to run for specific files alone before enabling it for all the files.

Oh if that's possible, that would be lovely!

[vincbeck]

@Bowrna Did you find it? Otherwise, no big deal, I'll split this PR without enabling the check at first

[Bowrna]

hi @vincbeck sorry for not updating here quickly. When I made a change for the pydocstyle I had a file named .pre-commit-config.yaml where I can pass the parameter in exclude to ignore running the pydocstyle. I couldn't find something alike in your commit and therefore I didn't update. please check the screenshot and see if it was useful for you. this one allows to exclude but not run on specific ones.

Reference PR: https://github.com/apache/airflow/pull/24221/files#

[vincbeck]

Thanks for the answer! I see, this is actually what I was planning to do. Thanks :)

[vincbeck]

I created a PR to address only Airflow core: #31297. Other PRs will come along later

[vincbeck]

I converted this PR in draft since we do not want to merge it but I'll keep it open to track the overall work on D400 check