Proposed Flake8 3.0 - [merged]

[asottile]

In GitLab by @sigmavirus24 on Mar 15, 2016, 15:15

Merges proposed/3.0 -> master

Description of changes

• Rewrite flake8's internals to be independent of pep8
• Rework flake8's handling of options parsed from config files in a unified way that's better tested than pep8's handling was
• Add proper logging to flake8 to allow more informative verbose information to be shown to the user
• Internalize some of pep8's check handling and token generation

Related to:

• 117

• 111

• 106

• 105

• 100

• 90

• Option 2 from #89

• 84

• 74

• 69

• 66

• 54

• 21

• 14

And more that I'll update this with later

---

Note that this is a merge in from https://gitlab.com/pycqa/flake8-engine which still has some open issues which will be fixed in this branch.

[asottile]

In GitLab by @sigmavirus24 on Jun 8, 2016, 10:27

Added 1 commit:

• 107f595d - Add flake8.api and docs for it

[asottile]

In GitLab by @sigmavirus24 on Jun 13, 2016, 05:30

Added 3 commits:

• b10aa91b - Use function for pep8 plugins
• 9c47fe3c - Convert flake8.api to a submodule
• 8b9b9bbe - Make a first pass at a git pre-commit hook

[asottile]

In GitLab by @sigmavirus24 on Jun 13, 2016, 18:38

Added 4 commits:

• 6f08d9d4 - Move git integration into flake8.main
• de587a9c - Correct usage of tempfile
• 53438fca - Refactor parts of flake8.main.cli into separate modules
• 6dca1d6f - Start fleshing out mercurial hook

[asottile]

In GitLab by @sigmavirus24 on Jun 14, 2016, 06:06

Added 4 commits:

• dc8fc005 - Configure bandit to ignore subprocess warnings
• 3cd8ef7d - Add docstrings and a new-line for pydocstyle
• 84456866 - Fix integration tests
• deb59817 - Use the same interface for vcs installation

[asottile]

In GitLab by @sigmavirus24 on Jun 14, 2016, 18:44

Added 5 commits:

• 70652082 - Fix documentation build
• 472e7c95 - Add release notes portion of documentation
• 18d6e626 - Revert silliness around setting choices for --format
• 8a18cfa4 - Add documentation around specifying a format string
• 8bb30487 - Add documentation for --install-hook

[asottile]

In GitLab by @sigmavirus24 on Jun 14, 2016, 18:49

Added 3 commits:

• e2ef07fe - Copied one too many lines from template
• 29419b0a - Start a changelog entry for 3.0.0
• 3af48aba - Remove CHANGES.rst

[asottile]

In GitLab by @sigmavirus24 on Jun 16, 2016, 06:29

Added 9 commits:

• 25502f6a - Add note about # noqa: <errors>
• b1f039a4 - Add information about new --verbose behaviour
• a4b0793b - Use correct stat module constant
• 27eb9754 - Properly unpack stdout and stdin
• 07101231 - Ensure that the directories exist
• 29896e64 - Use a template for git pre-commit hook
• eff77e2b - Set a lower-limit on flake8-docstrings
• 023de21f - Find filenames for mercurial hook
• 1de71fbe - Set a default value for --select

[asottile]

In GitLab by @sigmavirus24 on Jun 16, 2016, 19:00

Added 2 commits:

• 9a9bcdfb - Add setuptools integration
• 3f434f7d - Add broken config file to test error handling

[asottile]

In GitLab by @sigmavirus24 on Jun 17, 2016, 08:27

Added 1 commit:

• 8bc76f79 - Configure flake8-import-order to use Google Style

[asottile]

In GitLab by @sigmavirus24 on Jun 17, 2016, 09:10

Added 1 commit:

• fd5c7d00 - Update Travis to run the linters individually

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:05

Examples with real errors beneath this format would also be helpful. What does an 'error' mean? It'd help newer folks to see a real example.

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:05

Same - a full example

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:06

Installation is part of quick start - maybe:

Quickstart

• Installation
• Use Flake8

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:07

Difference between Plugin developer and Developer guides is unclear. Maybe 'Plugin Developer' and 'Flake8 Core developer"

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:10

Navigation, maybe?

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:11

This page is useless in the generated nav, just kill it. There's a perma-search on the left anyway.

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:11

This needs a better link name in the generated pages, do something shiny to make it clearer. What's 'module documentation' - not immediately obvious.

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:12

Maybe explain what a check is first. Or link to where you do that.

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:24

You may wish to have another person here people can contact.

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:26

"Please only report bugs with one of Flake8's default checks unless Flake8 is somehow preventing the running of the check or is otherwise inhibiting its effectiveness."

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:27

Are they Check codes or error codes? I've seen you use both. Be consistent.

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:27

Maybe you mean here that people should check and see if those things exist before submitting the feature request?

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:28

Frobulate may confuse people - maybe feature "z" instead?

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:30

What do you mean by 'familiarize'? People more often than not can just take a look. Maybe explain that it's using reStructuredText and Sphinx, and that most of the time that won't be relevant if people follow the extant patterns, but perhaps if they run into trouble they should investigate further?

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 11:56

Link to the OpenStack code/config file so people can see the whole thing, or explain why you're not.

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 12:01

Nuances is unclear - basics, methods, what do you mean?

[asottile]

In GitLab by @ceaess on Jun 19, 2016, 12:04

Alphabetize for my sanity. And for usability.

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:34

Added 2 commits:

• 330fdb5b - Grammar and clarity improvements.
• 1f7a8081 - Merge branch '3.0-doc-wording' into 'proposed/3.0'

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:44

I had it there, but I wasn't sure if it belonged there or not. I'll move it.

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:44

Would "Plugin Developer" and "Contributor" be useful?

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:52

That's just auto-generated by Sphinx. I'm really not sure what to call them since they're really just indices that are also auto-generated. I've renamed it to "General Indices"

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:52

Done.

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:53

No one else works on the project full-time as a maintainer. Who else could be listed?

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:55

I'm following the ordering (which is consistent) of flake8 --help.

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:56

Done

[asottile]

In GitLab by @sigmavirus24 on Jun 19, 2016, 18:57

Switched to Error codes. Can't find other instances of "check code(s)" though in the docs.

[asottile]

In GitLab by @sigmavirus24 on Jun 20, 2016, 06:14

Done.

[asottile]

In GitLab by @sigmavirus24 on Jun 20, 2016, 06:30

Done.

[asottile]

In GitLab by @sigmavirus24 on Jun 20, 2016, 07:26

Added 5 commits:

• adedd6c5 - Add --benchmark and formatting for its values
• 16f58005 - Add --benchmark option documentation
• 57ac6ab6 - Add |Flake8| substitution to the epilog
• 41277ff9 - Use |Flake8| consistently throughout documentation
• 3e8bbc50 - Add documentation ... for writing documentation

[asottile]

In GitLab by @sigmavirus24 on Jun 20, 2016, 11:30

Added 1 commit:

• 3cbad557 - Remove mypy from list of tox environments

[asottile]

In GitLab by @sigmavirus24 on Jun 20, 2016, 11:49

Added 2 commits:

• 590e15cb - Trim trailing whitespace in docs
• ba5bf0c5 - Add missing docstring to Application#report_benchmarks

[asottile]

In GitLab by @sigmavirus24 on Jun 21, 2016, 05:46

Added 5 commits:

• 6ac4d165 - Switch to pycodestyle and start constraining versions again
• b67d1d63 - Add documentation about release versioning and process
• a4c1edb0 - Add FAQ
• f3cd7ee6 - Update FAQ to be a bit clearer
• 9fe82d7b - Update version string to beta

[asottile]

In GitLab by @sigmavirus24 on Jun 22, 2016, 06:41

Added 3 commits:

• 60b67f4e - Trim trailing whitespace
• 9526e061 - Add more detail about types of releases
• 6c0d900a - Write plugin cross-compatibility documentation

[asottile]

In GitLab by @sigmavirus24 on Jun 22, 2016, 06:43

Added 1 commit:

• 04bceece - Remove historical files from the repository

[asottile]

In GitLab by @sigmavirus24 on Jun 22, 2016, 08:07

Added 1 commit:

• 601696d5 - Trim whitespace from cross-compat plugin docs

[asottile]

In GitLab by @sigmavirus24 on Jun 22, 2016, 12:35

Added 1 commit:

• 88d1dd28 - Start a glossary of terms

[asottile]

In GitLab by @sigmavirus24 on Jun 22, 2016, 17:28

Added 3 commits:

• 478d5620 - Correct example register_options method
• 1de5da8a - Add more definitions to glossary
• cae943bd - Add missing - to sub-directories