Linting Package Replacement: Pycodestyle to Ruff

[Luca-Blight]

Proposed new feature or change:

There is a newer package that has been implemented by other major packages such as FastAPI and Llama index which has overwhelming performance gains. I would like to make the change to Numpy if that's okay?

More info:
https://docs.astral.sh/ruff/

[rgommers]

Hi @Luca-Blight, thanks for proposing to work on this. If it's a simple swap of tools, then yes please go for it - ruff is certainly an upgrade. If it requires significant code changes throughout the code base (e.g. because ruff doesn't run on the same diff as right now), then it'd be better to avoid this until after the 2.0 release, given that we have a lot more in flight than during an average release cycle.

[Luca-Blight]

@rgommers got it I will keep that in mind. Thanks for your response.

[lysnikolaou]

I did a little experiment and ran pycodestyle without the diff option and the results are not too good.

7       E101 indentation contains mixed spaces and tabs
13      E111 indentation is not a multiple of 4
9       E114 indentation is not a multiple of 4 (comment)
9       E116 unexpected indentation (comment)
11      E117 over-indented (comment)
58      E124 closing bracket does not match visual indentation
3       E129 visually indented line with same indent as next logical line
5       E131 continuation line unaligned for hanging indent
334     E201 whitespace after '['
57      E202 whitespace before ']'
301     E203 whitespace before ':'
30      E211 whitespace before '('
200     E221 multiple spaces before operator
11      E222 multiple spaces after operator
187     E225 missing whitespace around operator
2       E227 missing whitespace around bitwise or shift operator
8       E228 missing whitespace around modulo operator
1163    E231 missing whitespace after ','
90      E261 at least two spaces before inline comment
13      E262 inline comment should start with '# '
10      E271 multiple spaces after keyword
13      E272 multiple spaces before keyword
98      E301 expected 1 blank line, found 0
83      E303 too many blank lines (2)
2       E304 blank lines found after function decorator
137     E305 expected 2 blank lines after class or function definition, found 1
52      E306 expected 1 blank line before a nested definition, found 0
6       E401 multiple imports on one line
2308    E501 line too long (90 > 79 characters)
53      E502 the backslash is redundant between brackets
73      E701 multiple statements on one line (colon)
6       E702 multiple statements on one line (semicolon)
1       E703 statement ends with a semicolon
21      E711 comparison to None should be 'if cond is None:'
14      E713 test for membership should be 'not in'
1       E714 test for object identity should be 'is not'
2       E722 do not use bare 'except'
1       E743 ambiguous function definition 'I'
6       W191 indentation contains tabs
3       W292 no newline at end of file
107     W293 blank line contains whitespace (I enabled this rule, it was ignored before)

It would be a good amount of effort to solve all of these, but I think we should do it. A good plan would be to first replace pycodestyle with ruff, which includes pycodestyle rules amongst others, fix all errors/warnings (ruff can probably autofix quite a few of these), and, finally, change the CI to lint the whole code base on every run, instead of just the diff. Ruff is fast, so this shouldn't be a problem.

@Luca-Blight Are you still planning to work on this?

[lucascolley]

A good plan would be to first replace pycodestyle with ruff, which includes pycodestyle rules amongst others, fix all errors/warnings (ruff can probably autofix quite a few of these)

That's 2004 errors, with 789 "auto-fixable" (not sure how safe the F401 fixes would be). We ignore E741 in SciPy, so you can remove 82 from that. Doable? But certainly a bit of work.

> ruff check . --exclude vendored-meson --exclude numpy/typing/tests/data --exclude numpy/typing/_char_codes.py --exclude numpy/__config__.py --exclude numpy/f2py --statistics

725	F401	[*] `.._utils._inspect.formatargspec` imported but unused
348	F405	[ ] `ALLOW_THREADS` may be undefined, or defined from star imports
219	F811	[*] Redefinition of unused `Sequence` from line 1
133	F821	[ ] Undefined name `Bool`
 92	E402	[ ] Module level import not at top of file
 82	E741	[ ] Ambiguous variable name: `I`
 75	F841	[*] Local variable `A` is assigned to but never used
 73	E701	[ ] Multiple statements on one line (colon)
 54	E712	[*] Comparison to `False` should be `cond is False` or `if not cond:`
 51	E731	[*] Do not assign a `lambda` expression, use a `def`
 46	E721	[ ] Do not compare types, use `isinstance()`
 27	F403	[ ] `from ._asarray import *` used; unable to detect undefined names
 21	E711	[*] Comparison to `None` should be `cond is None`
 17	E713	[*] Test for membership should be `not in`
 14	F541	[*] f-string without any placeholders
 12	E714	[*] Test for object identity should be `is not`
  6	E702	[ ] Multiple statements on one line (semicolon)
  5	E401	[*] Multiple imports on one line
  2	E743	[ ] Ambiguous function name: `I`
  1	E703	[*] Statement ends with an unnecessary semicolon
  1	E722	[ ] Do not use bare `except`