Pylint raises half a million errors when ran on every directory

[CaedenPH]

What would you like to share?

Running pylint **/*.py lints every file in the whole project and raises a lot of errors and overall rates the code 8.20/10
Lets aim to make this 10/10

Additional information

Example outputs

************* Module arithmetic_analysis.bisection
arithmetic_analysis\bisection.py:1:0: C0114: Missing module docstring (missing-module-docstring)
arithmetic_analysis\bisection.py:4:50: C0103: Argument name "a" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\bisection.py:4:60: C0103: Argument name "b" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\bisection.py:24:4: R1705: Unnecessary "elif" after "return", remove the leading "el" from "elif" (no-else-return)
arithmetic_analysis\bisection.py:36:12: R1705: Unnecessary "elif" after "return", remove the leading "el" from "elif" (no-else-return)
arithmetic_analysis\bisection.py:46:0: C0116: Missing function or method docstring (missing-function-docstring)
arithmetic_analysis\bisection.py:46:0: C0103: Function name "f" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\bisection.py:46:6: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
************* Module arithmetic_analysis.gaussian_elimination
arithmetic_analysis\gaussian_elimination.py:34:4: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\gaussian_elimination.py:79:4: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
************* Module arithmetic_analysis.intersection
arithmetic_analysis\intersection.py:1:0: C0114: Missing module docstring (missing-module-docstring)
arithmetic_analysis\intersection.py:5:53: C0103: Argument name "x0" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\intersection.py:5:64: C0103: Argument name "x1" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\intersection.py:44:0: C0116: Missing function or method docstring (missing-function-docstring)
arithmetic_analysis\intersection.py:44:0: C0103: Function name "f" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\intersection.py:44:6: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
************* Module arithmetic_analysis.in_static_equilibrium
arithmetic_analysis\in_static_equilibrium.py:34:4: W0621: Redefining name 'forces' from outer scope (line 60) (redefined-outer-name)
arithmetic_analysis\in_static_equilibrium.py:34:30: W0621: Redefining name 'location' from outer scope (line 68) (redefined-outer-name)
************* Module arithmetic_analysis.jacobi_iteration_method
arithmetic_analysis\jacobi_iteration_method.py:12:0: R0914: Too many local variables (18/15) (too-many-locals)
arithmetic_analysis\jacobi_iteration_method.py:158:12: R1724: Unnecessary "else" after "continue", remove the "else" and de-indent the code inside it (no-else-continue)
************* Module arithmetic_analysis.newton_forward_interpolation
arithmetic_analysis\newton_forward_interpolation.py:1:0: C0114: Missing module docstring (missing-module-docstring)
arithmetic_analysis\newton_forward_interpolation.py:8:9: C0103: Argument name "u" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_forward_interpolation.py:8:19: C0103: Argument name "p" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_forward_interpolation.py:23:0: C0116: Missing function or method docstring (missing-function-docstring)
arithmetic_analysis\newton_forward_interpolation.py:24:4: C0103: Variable name "n" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_forward_interpolation.py:25:4: C0103: Variable name "y" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_forward_interpolation.py:34:4: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_forward_interpolation.py:41:4: C0103: Variable name "u" doesn't conform to snake_case naming style (invalid-name)
************* Module arithmetic_analysis.newton_method
arithmetic_analysis\newton_method.py:45:0: C0116: Missing function or method docstring (missing-function-docstring)
arithmetic_analysis\newton_method.py:45:0: C0103: Function name "f" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_method.py:45:6: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_method.py:49:0: C0116: Missing function or method docstring (missing-function-docstring)
arithmetic_analysis\newton_method.py:49:0: C0103: Function name "f1" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_method.py:49:7: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
************* Module arithmetic_analysis.newton_raphson
arithmetic_analysis\newton_raphson.py:1:0: C0114: Missing module docstring (missing-module-docstring)
arithmetic_analysis\newton_raphson.py:8:0: W0622: Redefining built-in 'pow' (redefined-builtin)
arithmetic_analysis\newton_raphson.py:8:0: W0401: Wildcard import math (wildcard-import)
arithmetic_analysis\newton_raphson.py:14:15: C0103: Argument name "a" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_raphson.py:26:4: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_raphson.py:28:8: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
arithmetic_analysis\newton_raphson.py:28:34: W0123: Use of eval (eval-used)
arithmetic_analysis\newton_raphson.py:28:56: W0123: Use of eval (eval-used)

[Smit-Parmar]

@CaedenPH For me it's showing 5.21/10 . How we are going to proceed on this I think this will require so many changes in each file.

[CaedenPH]

@CaedenPH For me it's showing 5.21/10 . How we are going to proceed on this I think this will require so many changes in each file.

@cyborg7898
Perhaps I make a pull request that is a work in progress for a long time and people can contribute to my pull request - I don't think lots of small pull requests would be efficient

Can you show me your version of pylint, what you ran and other context? Curious why you're 5.21

[Smit-Parmar]

@CaedenPH
I ran pylint **/*.py in root folder /python.
Note: I ran command into repo which I forked .

So I tried pylint in two different ways.

1. Install using sudo apt install pylint
   pylint 2.4.4
   which gives 5.21/10
2. Install using pip
   pylint 2.17.4
   which gives 6.80/10

Python 3.8.10 (default, Mar 13 2023, 10:26:41)

Also can you share PR details? I would love to help. Thanks.

[CaedenPH]

@cyborg7898

Pylint version 2.17.4
Python version 3.11.3

Your python version is 3.8.10 and the repo uses 3.10 syntax typing so I assume that is the reason your score is so low - It must think these are syntax errors

[Smit-Parmar]

@CaedenPH I matched the version details you provided
pylint 2.17.4
astroid 2.15.5
Python 3.11.3 (main, May 30 2023, 17:52:54) [GCC 9.4.0]

Now score is 7.69/10. How can I start work on this?

[CaedenPH]

@cyborg7898

I made a branch
https://github.com/CaedenPH/Python/tree/fix-pylance-errors along with a pull request #8790 which you can contribute to

It's a draft because it will take a long time to the errors

[Smit-Parmar]

@CaedenPH
I'm getting pylint output like

************* Module arithmetic_analysis.bisection
bisection.py:1:0: C0114: Missing module docstring (missing-module-docstring)
bisection.py:4:50: C0103: Argument name "a" doesn't conform to snake_case naming style (invalid-name)
bisection.py:4:60: C0103: Argument name "b" doesn't conform to snake_case naming style (invalid-name)
bisection.py:47:0: C0116: Missing function or method docstring (missing-function-docstring)

Are you having the same output? If yes are we going to ignore it or replace it with snake_case

[CaedenPH]

@CaedenPH I'm getting pylint output like

bisection.py:1:0: C0114: Missing module docstring (missing-module-docstring)
bisection.py:4:50: C0103: Argument name "a" doesn't conform to snake_case naming style (invalid-name)
bisection.py:4:60: C0103: Argument name "b" doesn't conform to snake_case naming style (invalid-name)
bisection.py:47:0: C0116: Missing function or method docstring (missing-function-docstring)```

Are you having the same output? If yes are we going to ignore it or replace it with snake_case

@cyborg7898 These are the errors that pylint is raising - We need to systemaically fix these errors however I'm not entirely sure which should be ignored - there are hundreds of a, b, n, x0, x1 variables that raise this error

@cclauss What is your overall opinion?

[cclauss]

We do not lint with pylint... We use ruff instead. If you look at the ruff section of pyproject.toml, you can see the PLxxx rules that are borrowed from pylint. https://beta.ruff.rs/docs/rules/#pylint-pl

Python/pyproject.toml

Lines 19 to 133 in c93659d

	[tool.ruff]
	ignore = [ # `ruff rule S101` for a description of that rule
	"ARG001", # Unused function argument `amount` -- FIX ME?
	"B904", # Within an `except` clause, raise exceptions with `raise ... from err` -- FIX ME
	"B905", # `zip()` without an explicit `strict=` parameter -- FIX ME
	"DTZ001", # The use of `datetime.datetime()` without `tzinfo` argument is not allowed -- FIX ME
	"DTZ005", # The use of `datetime.datetime.now()` without `tzinfo` argument is not allowed -- FIX ME
	"E741", # Ambiguous variable name 'l' -- FIX ME
	"EM101", # Exception must not use a string literal, assign to variable first
	"EXE001", # Shebang is present but file is not executable" -- FIX ME
	"G004", # Logging statement uses f-string
	"ICN001", # `matplotlib.pyplot` should be imported as `plt` -- FIX ME
	"INP001", # File `x/y/z.py` is part of an implicit namespace package. Add an `__init__.py`. -- FIX ME
	"N999", # Invalid module name -- FIX ME
	"NPY002", # Replace legacy `np.random.choice` call with `np.random.Generator` -- FIX ME
	"PGH003", # Use specific rule codes when ignoring type issues -- FIX ME
	"PLC1901", # `{}` can be simplified to `{}` as an empty string is falsey
	"PLR5501", # Consider using `elif` instead of `else` -- FIX ME
	"PLW0120", # `else` clause on loop without a `break` statement -- FIX ME
	"PLW060", # Using global for `{name}` but no assignment is done -- DO NOT FIX
	"PLW2901", # PLW2901: Redefined loop variable -- FIX ME
	"RUF00", # Ambiguous unicode character and other rules
	"RUF100", # Unused `noqa` directive -- FIX ME
	"S101", # Use of `assert` detected -- DO NOT FIX
	"S105", # Possible hardcoded password: 'password'
	"S113", # Probable use of requests call without timeout -- FIX ME
	"S311", # Standard pseudo-random generators are not suitable for cryptographic purposes -- FIX ME
	"SIM102", # Use a single `if` statement instead of nested `if` statements -- FIX ME
	"SLF001", # Private member accessed: `_Iterator` -- FIX ME
	"UP038", # Use `X | Y` in `{}` call instead of `(X, Y)` -- DO NOT FIX
	]
	select = [ # https://beta.ruff.rs/docs/rules
	"A", # flake8-builtins
	"ARG", # flake8-unused-arguments
	"ASYNC", # flake8-async
	"B", # flake8-bugbear
	"BLE", # flake8-blind-except
	"C4", # flake8-comprehensions
	"C90", # McCabe cyclomatic complexity
	"DTZ", # flake8-datetimez
	"E", # pycodestyle
	"EM", # flake8-errmsg
	"EXE", # flake8-executable
	"F", # Pyflakes
	"FA", # flake8-future-annotations
	"FLY", # flynt
	"G", # flake8-logging-format
	"I", # isort
	"ICN", # flake8-import-conventions
	"INP", # flake8-no-pep420
	"INT", # flake8-gettext
	"N", # pep8-naming
	"NPY", # NumPy-specific rules
	"PGH", # pygrep-hooks
	"PIE", # flake8-pie
	"PL", # Pylint
	"PYI", # flake8-pyi
	"RSE", # flake8-raise
	"RUF", # Ruff-specific rules
	"S", # flake8-bandit
	"SIM", # flake8-simplify
	"SLF", # flake8-self
	"T10", # flake8-debugger
	"TD", # flake8-todos
	"TID", # flake8-tidy-imports
	"UP", # pyupgrade
	"W", # pycodestyle
	"YTT", # flake8-2020
	# "ANN", # flake8-annotations # FIX ME?
	# "COM", # flake8-commas
	# "D", # pydocstyle -- FIX ME?
	# "DJ", # flake8-django
	# "ERA", # eradicate -- DO NOT FIX
	# "FBT", # flake8-boolean-trap # FIX ME
	# "ISC", # flake8-implicit-str-concat # FIX ME
	# "PD", # pandas-vet
	# "PT", # flake8-pytest-style
	# "PTH", # flake8-use-pathlib # FIX ME
	# "Q", # flake8-quotes
	# "RET", # flake8-return # FIX ME?
	# "T20", # flake8-print
	# "TCH", # flake8-type-checking
	# "TRY", # tryceratops
	]
	show-source = true
	target-version = "py311"
	[tool.ruff.mccabe] # DO NOT INCREASE THIS VALUE
	max-complexity = 17 # default: 10
	[tool.ruff.per-file-ignores]
	"arithmetic_analysis/newton_raphson.py" = ["PGH001"]
	"audio_filters/show_response.py" = ["ARG002"]
	"data_structures/binary_tree/binary_search_tree_recursive.py" = ["BLE001"]
	"data_structures/binary_tree/treap.py" = ["SIM114"]
	"data_structures/hashing/hash_table.py" = ["ARG002"]
	"data_structures/hashing/quadratic_probing.py" = ["ARG002"]
	"data_structures/hashing/tests/test_hash_map.py" = ["BLE001"]
	"data_structures/heap/max_heap.py" = ["SIM114"]
	"graphs/minimum_spanning_tree_prims.py" = ["SIM114"]
	"hashes/enigma_machine.py" = ["BLE001"]
	"machine_learning/decision_tree.py" = ["SIM114"]
	"machine_learning/linear_discriminant_analysis.py" = ["ARG005"]
	"machine_learning/sequential_minimum_optimization.py" = ["SIM115"]
	"matrix/sherman_morrison.py" = ["SIM103", "SIM114"]
	"physics/newtons_second_law_of_motion.py" = ["BLE001"]
	"project_euler/problem_099/sol1.py" = ["SIM115"]
	"sorts/external_sort.py" = ["SIM115"]
	[tool.ruff.pylint] # DO NOT INCREASE THESE VALUES
	allow-magic-value-types = ["float", "int", "str"]
	max-args = 10 # default: 5
	max-branches = 20 # default: 12
	max-returns = 8 # default: 6
	max-statements = 88 # default: 50

If contributors want to tighten up the ruff rules then we will review their pull requests. Please do not implement more than one or two new ruff rules in a single PR.