configure vscode pycodestyle linter

[DavidAyotte]

The goal of this ticket is to configure the vscode pycodestyle linter to check against Sage's minimal style conventions:

• E111: indentation is not a multiple of four
• E306: expected 1 blank line before a nested definition, found 0
• E401: multiple imports on one line
• E701: multiple statements on one line (colon)
• E702: multiple statements on one line (semicolon)
• E703: statement ends with a semicolon
• E711: comparison to None should be ‘if cond is None:’
• E712: comparison to True should be ‘if cond is True:’ or ‘if cond:’
• E713: test for membership should be 'not in'
• E721: do not compare types, use isinstance()
• E722: do not use bare except, specify exception instead
• W605: invalid escape sequence ‘x’

See https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes

Depends on #34352

CC: @fchapoton @tobiasdiez

Component: misc

Keywords: vscode pycodestyle pep8

Author: David Ayotte

Branch/Commit: 14b7780

Reviewer: Matthias Koeppe

Issue created by migration from https://trac.sagemath.org/ticket/34425

[DavidAyotte]

Dependencies: 34352

[DavidAyotte]

Changed dependencies from 34352 to #34352

[mkoeppe]

comment:4

Also see src/doc/en/developer/tools.rst

[DavidAyotte]

Branch: u/gh-DavidAyotte/configure_vscode_pycodestyle_linter

[DavidAyotte]

Commit: c5755d8

[DavidAyotte]

comment:6

The linter now only check against the style listed above.

---

New commits:

3a58015	settings.json: add missing comma
c5755d8	.vscode/settings.json: add pycodestyle arguments

[mkoeppe]

comment:7

Could you add comments to the files that developers should keep this in sync

And also update src/doc/en/developer/tools.rst regarding this config file

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

0938385	.vscode/settings.json: add comment
77a761a	src/doc/en/developer/tools.rst: update info on vscode pycodestyle linter

[sagetrac-git]

Changed commit from c5755d8 to 77a761a

[mkoeppe]

comment:9

Also add a comment to src/tox.ini please

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

ec65ffe

src/tox.ini: add general comment

[sagetrac-git]

Changed commit from 77a761a to ec65ffe

[mkoeppe]

comment:11

I meant a cross-reference from the section testenv:pycodestyle-minimal to the .vscode/settings.json

[sagetrac-git]

Changed commit from ec65ffe to 2be1535

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

2be1535

.vscode/settings.json, src/tox.ini: add comments cross-referencing the two files

[DavidAyotte]

comment:13

I think I finally got want you wanted, I hope it's okay! Don't hesitate to tell me if it is not.

[mkoeppe]

comment:14

Thanks! Looking great

But ./sage -docbuild en/developer html gives

OSError: /Users/mkoeppe/s/sage/sage-rebasing/src/doc/en/developer/tools.rst:205: WARNING: Bullet list ends without a blank line; unexpected unindent.

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

14b7780

src/doc/en/developer/tools.rst: add missing blank line

[sagetrac-git]

Changed commit from 2be1535 to 14b7780

[mkoeppe]

Reviewer: Matthias Koeppe

[mkoeppe]

comment:16

Perfect.

[vbraun]

Changed branch from u/gh-DavidAyotte/configure_vscode_pycodestyle_linter to 14b7780