Skip to content

Lint Python code #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
DifferentialOrange opened this issue Dec 7, 2022 · 0 comments · Fixed by #289
Closed

Lint Python code #270

DifferentialOrange opened this issue Dec 7, 2022 · 0 comments · Fixed by #289
Assignees
@DifferentialOrange
Labels
code health Improve code readability, simplify maintenance and so on feature A new functionality

Comments

@DifferentialOrange
Copy link
Member

Add some linter (pylint, flake8) to CI runs.

The task itself is rather simple, yet before merging this we should resolve any conflicts. And pylint yielded a couple of hundreds of them (not counting missing docstring ones).
@DifferentialOrange DifferentialOrange added feature A new functionality code health Improve code readability, simplify maintenance and so on teamE labels Dec 7, 2022
@DifferentialOrange DifferentialOrange self-assigned this Mar 27, 2023
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: remove old ignores
e4d3f48 
Last PEP8 checkup was in 0.5.5 [1]. Many things has changed since in
both PEP8 and connector source code. To ensure that everything is
alright, this patch removes existing pylint ignores before pylint
checkup. They could be restored after thorough checkup.

1. 93b5d3d

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
test: add pylint dependency
a33d031 
See [1].

1. https://pypi.org/project/pylint/

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
make: add lint command
a3b9e87 
Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix trailing-whitespace cases
a23eaec 
Fix all cases of C0303 trailing-whitespace. Remove trailing whitespaces
from documentation as well.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix invalid-name cases
df6df52 
Fix several cases of C0103 invalid-name.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: allow some short variables
759ce2b 
`t` sounds like a reasonable variable names in tests, `ok` sounds like a
reasonable variable names in general. This patch disables C0103
invalid-name check for them.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: treat tz as a good name
c70bbee 
`tz` is a part of the Datetime public API and we don't plan to change it
now.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: allow unittest naming
ff06e42 
unittest methods use CamelCase for its asserts. We use it here for our
custom assert too.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: allow dbapi constants
de83057 
Lowercase constants are the part of dbapi, we cannot rename them.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: allow sphinx constants
23a444f 
Lowercase constants are the part of sphinx API, we cannot rename them.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix singleton-comparison cases
e52e35e 
Fix all cases of C0121 singleton-comparison.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix consider-using-f-string cases
77f529d 
Fix all cases of C0209 consider-using-f-string.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix consider-using-dict-items cases
baa704a 
Fix all cases of C0206 consider-using-dict-items.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix consider-using-enumerate cases
a003d02 
Fix all cases of C0200 consider-using-enumerate.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix consider-iterating-dictionary cases
7b54c34 
Fix all cases of C0201 consider-iterating-dictionary.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix bad-classmethod-argument cases
093fe2e 
Fix all cases of C0202 bad-classmethod-argument.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix superfluous-parens cases
a990309 
Fix all cases of C0325 superfluous-parens.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix multiple-statements cases
f2a2789 
Fix all cases of C0321 multiple-statements.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix trailing-newlines cases
9153426 
Fix all cases of C0305 trailing-newlines.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: disable too-many-lines cases
c757a6f 
Disable all current cases of C0302 too-many-lines.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix wrong-import-order cases
8b1813f 
Fix all cases of C0411 wrong-import-order.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix wrong-import-position cases
929fcdf 
Fix all cases of C0413 wrong-import-position.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix import-outside-toplevel case
8decb50 
Fix the only case of C0415 import-outside-toplevel.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: disable import-outside-toplevel case
e109787 
Disable a case of C0415 import-outside-toplevel: we allow to run
commands like `python setup.py test` without setuptools_scm.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix missing-module-docstring cases
5193608 
Fix all cases of C0114 missing-module-docstring.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix unspecified-encoding cases
2ee10b3 
Fix all cases of W1514 unspecified-encoding.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
setup: migrate from distutils
3090a48 
distutils is starting to get removed from the standard library since
2020 and has been phased out since 2014 (or earlier). Distutils has
been exposed only recently, so relatively old Python (like 3.8)
setuptools doesn't have them yet.

1. https://peps.python.org/pep-0632
2. pypa/setuptools@974dbb0

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix unnecessary-lambda-assignment cases
cf500e0 
Fix all cases of C3001 unnecessary-lambda-assignment.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix no-member case
95fe35e 
Fix the only case of E1101 no-member.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix unnecessary-dunder-call case
b4c28ee 
Fix the only case of C2801 unnecessary-dunder-call.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: disable too-many-function-args cases in tests
f5e3446 
Disable cases of E1121 too-many-function-args in tests.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: allow long links and tables in docstrings
9ead2ed 
Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix line-too-long cases
d1d81e7 
Fix several cases of C0301 line-too-long.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: disable line-too-long cases
ba58604 
Disable remaining cases of C0301 line-too-long. Reason: they are related
to code insertion in docstrings and documentation macros.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: disable duplicate-code cases in code
141354f 
Disable all cases of R0801 duplicate-code in code. ConnectionPool,
MeshConnection, Connection and Tarantool server have similar API, thus
they have similar init arguments.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: disable duplicate-code cases in tests
ce056e5 
Disable all cases of R0801 duplicate-code in tests. it may be for the
best to remove instance setup to some common place, but for now it
doesn't seems like it's worth the effort.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: disable no-self-use cases
79cc160 
Disable all cases of R0201 no-self-use in code. We don't plan to change
API yet.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: compatibility workaround
471cefc 
Allow lint to not fail for all version from Python 3.6 latest one to
python 3.10 latest one. See also [1].

1. pylint-dev/pylint#3312

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
make: additional lint with flake8
e9898a1 
Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: ignore line too long cases
aaba232 
Ignore E501 line too long since it's already checked with pylint. It
seems impossible to transfer its rules like "skip docstring links and
tables by regexp", so we just skip it here.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: ignore rule in configuration template
2c31fe1 
Ignore all cases of E265 block comment should start with '# ' in
documentation configuration template.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: ignore outdated rule
5b8d967 
W503 is an outdated warning which contradicts modern W504 [1].

1. https://www.flake8rules.com/rules/W503.html

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: fix local variable unused cases
f9b2136 
Fix several cases of F841 local variable is assigned to but never used.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: fix style
e4740c3 
This patch includes fixes for all remaining cases of
- E101 indentation contains mixed spaces and tabs,
- E121 continuation line under-indented for hanging
indent,
- E122 continuation line missing indentation or
outdented,
- E123 closing bracket does not match indentation of
opening bracket's line,
- E124 closing bracket does not match visual
indentation,
- E126 continuation line over-indented for hanging
indent,
- E127 continuation line over-indented for visual indent,
- E128 continuation line under-indented for visual indent,
- E131 continuation line unaligned for hanging indent,
- E201 whitespace after '(',
- E202 whitespace before '(',
- E203 Whitespace before ':',
- E221 multiple spaces before operator,
- E225 missing whitespace around operator,
- E226 missing whitespace around arithmetic operator,
- E227 missing whitespace around bitwise or shift,
operator,
- E231 missing whitespace after ',', ';', or ':',
- E241 multiple spaces after ',',
- E251 unexpected spaces around keyword / parameter
equals,
- E252 missing whitespace around parameter equals,
- E261 at least two spaces before inline comment,
- E275 missing whitespace after keyword,
- E301 expected 1 blank line,
- E302 expected 2 blank lines,
- E303 too many blank lines,
- E305 expected 2 blank lines after class or function definition,
- E306 expected 1 blank line before a nested definition,
- E502 the backslash is redundant between brackets,
- W191 indentation contains tabs,
- W293 blank line contains whitespace,
- W504 line break after binary operator.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: disable import unused in dbapi
e3eb6d0 
tarantool.error values import are the part of the DBAPI requirements, so
they cannot be omitted. The same rule is used in pylint.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: fix unused import cases
aa65f67 
Fir all remaining cases of F401 unused import.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
make: additional lint with codespell
584959a 
Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
codespell: resolve spell issues
3be674c 
Skip autogenerated timezones since there are too many abbreviations that
confuse codespell.

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix remaining compatibility issues
3fc917d 
See [1] about global bad-option-value fail to work.

1. pylint-dev/pylint#3312

Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
flake8: fix compatibility issues
1006384 
Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
codespell: fix compatibility issues
85bd410 
Part of #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
make: run lint before tests
b29c29c 
Closes #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
test: fix lint reworks
555391d 
Follows #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
setup: fix lint reworks
24aa8de 
Follows #270
DifferentialOrange added a commit that referenced this issue Mar 30, 2023
@DifferentialOrange
pylint: fix Windows compatibility
4bdbdda 
Follows #270
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DifferentialOrange DifferentialOrange

Labels
code health Improve code readability, simplify maintenance and so on feature A new functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Introduce lint tarantool/tarantool-python
1 participant
@DifferentialOrange