linting: configure strict PEP8 and pyflakes linter using flake8
ClosedPublic
Actions

Authored by kparal on Jun 18 2015, 8:52 AM.

Details

Reviewers

tflink
mkrizek
jskladan

Commits

rLTRNdda06df54ad5: linting: configure strict PEP8 and pyflakes linter using flake8

Summary

This configuration should ensure that all PEP8 errors are displayed in
Phabricator for modified lines and all pyflakes errors are displayed
always. Maximum line length has been set to 99 chars.

Test Plan

I tested it manually by editing the code and running arc lint, it seems to work properly :-)

Diff Detail

Repository

rLTRN libtaskotron

Lint

Automatic diff as part of commit; lint not applicable.

Unit

Automatic diff as part of commit; unit tests not applicable.

kparal retitled this revision from to linting: configure strict PEP8 and pyflakes linter using flake8.Jun 18 2015, 8:52 AM

kparal updated this object.

kparal edited the test plan for this revision. (Show Details)

kparal added reviewers: tflink, jskladan, mkrizek.

Herald added a subscriber: tflink. · View Herald TranscriptJun 18 2015, 8:52 AM

jskladan accepted this revision.Jun 18 2015, 9:02 AM

This revision is now accepted and ready to land.Jun 18 2015, 9:02 AM

mention how to ignore specific lines with flake8

mkrizek accepted this revision.Jun 18 2015, 6:18 PM

I wonder if we might want to change the pep8 stuff to Error once we get all the lint issues out. I suppose it isn't a huge issue if we don't let the warnings by, it just seems a bit odd to me that we'd keep them as warnings long term (I do understand why it's set that way for now).

LGTM, though.

Yes, I set it as a warning temporarily just because we don't want to completely reformat every file we slightly touch. In the future we can easily adjust the configuration to error.

Closed by commit rLTRNdda06df54ad5: linting: configure strict PEP8 and pyflakes linter using flake8 (authored by kparal). · Explain WhyJun 19 2015, 7:46 AM

This revision was automatically updated to reflect the committed changes.

Revision Contents

		Path
M		.arclint (27 lines)
M		arclint.readme (43 lines)
A	M	tox.ini (9 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	1058	91bff8b		Jun 18 2015, 8:52 AM	★	★
Diff 2	1065	91bff8b	- mention how to ignore specific lines with flake8	Jun 18 2015, 12:17 PM	★	★
Diff 3	1066	91bff8b	Commit rLTRNdda06df54ad501e73a94d15bf53738f011608ee1	Jun 19 2015, 7:41 AM	★	★

Commit	Tree	Parents	Author	Summary	Date
bd07cfa52c64	ba9042a24d21	0626cb6cda06	Kamil Páral	mention how to ignore specific lines with flake8	Jun 18 2015, 12:16 PM
0626cb6cda06	89f3cb6e0bc2	91bff8b117cc	Kamil Páral	linting: configure strict PEP8 and pyflakes linter using flake8 (Show More…)	Jun 18 2015, 8:24 AM

Diff 1066

View Options

.arclint

1	{	1	{
2	"linters": {	2	"linters": {
3	"flake8": {	3	"flake8": {
4	"type": "flake8",	4	"type": "flake8",
5	"include": "(\\.py$)",	5	"include": "(\\.py$)",
6	"severity": {	6	"severity.rules": {
7	"E302": "disabled",	7	"(^E)": "warning",
8	"E303": "disabled",	8	"(^F)": "error"
9	"E501": "disabled",
10	"W391": "disabled",
11
12	"E122": "advice",
13	"E124": "advice",
14	"E126": "advice",
15	"E127": "advice",
16	"E128": "advice",
17
18	"E111": "warning",
19	"E113": "warning",
20	"E129": "warning",
21	"E201": "warning",
22	"E221": "warning",
23	"E231": "warning",
24	"E251": "warning",
25	"E261": "warning",
26	"E265": "warning",
27	"E502": "warning",
28	"E711": "warning",
29	"E713": "warning"
30	}	9	}
31	}	10	}
32	}	11	}
33	}	12	}

View Options

arclint.readme

1	The linter's behaviour is configured in the .arclint file.	1	The linter's behaviour is configured in the .arclint file.
2		2
3	As the .arclint file parser does not support YAML comments, here is	3	As the .arclint file parser does not support YAML comments, some documentation
4	the explanation of the error codes.	4	can be put here if needed. Generic arcanist linter documentation is here:
5		5	https://secure.phabricator.com/book/phabricator/article/arcanist_lint/
6	"E302": "disabled", # expected 2 blank lines, found 1
7	"E303": "disabled", # too many blank lines (2)
8	"E501": "disabled", # line too long # Try and keep it down by 120, though
9	"W391": "disabled", # blank line at end of file
10
11	"E122": "advice", # continuation line missing indentation or outdented
12	"E124": "advice", # closing bracket does not match visual indentation
13	"E126": "advice", # continuation line over-indented for hanging indent
14	"E127": "advice", # continuation line over-indented for visual indent
15	"E128": "advice", # continuation line under-indented for visual indent
16
17	"E111": "warning", # indentation is not a multiple of four
18	"E113": "warning", # unexpected indentation
19	"E129": "warning", # visually indented line with same indent as next logical line
20	"E201": "warning", # whitespace after '{'
21	"E221": "warning", # multiple spaces before operator
22	"E231": "warning", # missing whitespace after ','
23	"E251": "warning", # unexpected spaces around keyword / parameter equals
24	"E261": "warning", # at least two spaces before inline comment
25	"E265": "warning", # block comment should start with '# '
26	"E502": "warning", # the backslash is redundant between brackets
27	"E711": "warning", # comparison to None should be 'if cond is None:'
28	"E713": "warning" # test for membership should be 'not in'
29		6
		7	Flake8
		8	======
		9	All PEP8 error codes (E* codes) are considered warnings in Phabricator, so that
		10	only changes to the modified lines are displayed by default (unlike errors,
		11	which are always displayed regardless of which lines were modified).
		12
		13	All PyFlakes error codes (F* codes) are considered errors, because they are
		14	often introduced when modifying other lines than the one in question, and we
		15	want to be notified of those.
		16
		17	Additional Flake8 configuration is stored in tox.ini - it contains configuration
		18	which is not possible to do in .arclint file.
		19
		20	If you want to ignore a specific source code line, use '# noqa' comment. If you
		21	want to ignore the whole file, add '# flake8: noqa' comment. Read more
		22	documentation about flake8 at:
		23	https://flake8.readthedocs.org/
30		24
31	To get more information about the severity levels (error, disabled,
32	warning, advice), see the "Adjusting Message Severities" section at
33	https://secure.phabricator.com/book/phabricator/article/arcanist_lint/

View Options

tox.ini

This file was added.

		1		# This file is present just to be able to configure flake8.
		2
		3		[flake8]
		4		# .arclint does not support flake8 configuratin, see ticket
		5		# https://secure.phabricator.com/D10512
		6		# So we need to use tox.ini to configure it, flake8 automatically
		7		# reads this file on start and looks for this section. See
		8		# `flake8 --help`.
		9		max-line-length=99

linting: configure strict PEP8 and pyflakes linter using flake8ClosedPublicActions

Details

Diff Detail

Revision Contents

Diff 1066

.arclint

arclint.readme

tox.ini

linting: configure strict PEP8 and pyflakes linter using flake8
ClosedPublic
Actions