explicitly note that arbitrary strings are supported by flake8 - [closed]

[asottile]

In GitLab by @keisheiled on Nov 27, 2019, 03:13

Merges patch-1 -> master

[asottile]

In GitLab by @keisheiled on Nov 27, 2019, 03:15

restored source branch patch-1

[asottile]

In GitLab by @codecov on Nov 27, 2019, 03:16

Codecov Report

Merging #385 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #385   +/-   ##
=======================================
  Coverage   82.74%   82.74%           
=======================================
  Files          24       24           
  Lines        2416     2416           
  Branches      378      378           
=======================================
  Hits         1999     1999           
  Misses        355      355           
  Partials       62       62

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e571167...da6d162. Read the comment docs.

[asottile]

In GitLab by @keisheiled on Nov 27, 2019, 03:19

Context: flake8-implicit-str-concat/flake8-implicit-str-concat#3

if this MR or a similar suggestion is not merged I'd like to see [A-Z]{1,3}\d{3,} explicitly recommended as it appears to have become a defacto standard

[asottile]

In GitLab by @pjacock on Nov 27, 2019, 03:20

+1 for much stronger language recommending the ABC123 style which will work well with the wider ecosystem of editors, IDEs, lint reporting etc.

[asottile]

In GitLab by @keisheiled on Nov 27, 2019, 03:21

@pjacock which IDEs do not support all possible flake8 error codes currently?

[asottile]

In GitLab by @pjacock on Nov 27, 2019, 03:25

The example I was thinking of has since been fixed to support ABC123 style - that took over six months though: microsoft/vscode-python#4074

[asottile]

In GitLab by @hugovk on Nov 27, 2019, 03:27

Examples from flake8-implicit-str-concat/flake8-implicit-str-concat#3:

Should Flake8 plugins use error codes like ISC001 and ISC002 or are longer strings like implicit-str-concat-oneline and implicit-str-concat-continuation?

And can the Flake8 project offer guidance or requirements?

[asottile]

In GitLab by @hugovk on Nov 27, 2019, 04:27

From the docs on "Error / Violation Codes":

Flake8 and its plugins assign a code to each message that we refer to as a error code (or violation). Most plugins will list their error codes in their documentation or README.

http://flake8.pycqa.org/en/latest/user/error-codes.html

[asottile]

In GitLab by @keisheiled on Nov 27, 2019, 04:36

error code doesn't actually have a glossary definition, this would be a good place to add such a recommendation on what they should actually look like: http://flake8.pycqa.org/en/latest/glossary.html#term-error-code

[asottile]

In GitLab by @pjacock on Nov 27, 2019, 05:04

@keisheiled my reading of that page is that error, error code, and violation are interchangeable terms.

[asottile]

In GitLab by @asottile on Nov 27, 2019, 05:46

arbitrary strings are not supported, they may appear to work in some cases but the framework really should be raising errors in those cases -- could you please open an issue for that?

here is what's supported: https://gitlab.com/pycqa/flake8/blob/e571167161a42a5da052eaf247ab13ac0c56b7c6/src/flake8/defaults.py#L39

[asottile]

In GitLab by @asottile on Nov 27, 2019, 05:46

closed

[asottile]

In GitLab by @pjacock on Nov 27, 2019, 06:13

New issue opened as requested, see #597.