Eventual deprecation of flake8

[asottile]

More of a heads up than anything -- not that many will see this 😆

Now that I've added a .pre-commit-hooks.yaml to the flake8 repository, we'll eventually be deprecating the flake8 hook defined here.

The rough ordering for that:

• flake8 makes its next tagged release (probably 3.7.0) -- I'm not sure on the timeline for this yet, we have to fix some new parsing of per_file_ignores and then probably will wait until pycodestyle / pyflakes make a new release(s) and then go go go?
• the flake8 hook will be "soft" deprecated. Probably nothing more than some messaging in the README. This will probably be pre-commit-hooks==2.X where X is some minor release greater than the current release
• Further after, (pre-commit-hooks==3) flake8 will be removed as a dependency in this repository and the flake8 executable will be replaced with a stub similar to the one added when autopep8-wrapper was deprecated

The rationale for this change:

• Direct access to the flake8 git repository better funnels people to raise issues in the correct place
• It is easier to pin the exact version of flake8 you are using (and leverage pre-commit autoupdate to get to a newer version)
• pre-commit-hooks is no longer plagued by spurious VersionConflict errors

This issue is mostly a FYI / tracking issue for those events

[rpdelaney]

So I should be changing all the flake8 hooks to point, instead of at github.com/pre-commit/pre-commit, instead to gitlab.com/pycqa/flake8?

[asottile]

Eventually yes. I myself am holding off until I release a tagged version of flake8 (probably 3.7.0) so autoupdate works better.

[asottile]

flake8 has been released so now tags resolve on https://gitlab.com/pycqa/flake8

For instance:

-   repo: https://gitlab.com/pycqa/flake8
    rev: 3.7.3
    hooks:
    -   id: flake8

If you want a script which automatically migrates your repositories, I've hooked up an all-repos fixer which automatically performs this migration.

Here's the fixer: https://github.com/asottile/all-repos/blob/master/all_repos/autofix/pre_commit_flake8_migrate.py

Sample invocation:

python -m all_repos.autofix.pre_commit_flake8_migrate --repos path/to/repo

Sample PR:

https://github.com/pre-commit/pre-commit/pull/928/files

[xiaotianq]

Hi, asottile. Is there any args: configurable setting to flake8?
Like max-line-length etc

[asottile]

yeah, it's no different from how any other hook is configured.

that said, you'll often have better mileage by configurating that in setup.cfg with a [flake8] section so other invocations can use that as well

[xiaotianq]

Hi, asottile. Thanks for the reply. Where can I checkout the available args for flake8? Searched around but could not find any.
Are you saying I should add setup.cfg to my only hook repo?
Currently I am just using existing hook repo and passing in args.

[asottile]

flake8 --help or the flake8 docs can give you a full list of arguments

You'd put a setup.cfg (or tox.ini or .flake8) adjacent to your .pre-commit-config.yaml

[xiaotianq]

Hi, Anthony. Thanks for the answer. I am new to pre-commit, can not dig some answers through the docs. May there be some questions.

[asottile]

No problem, it might be easier / quicker to follow up in my twitch discord (there's a #pre-commit channel)