Bump Pylint to 2.17 and flake8 to 6.0 #359

dciborow · 2023-03-10T18:17:19Z

Fixes: #377 Update dependencies to become compatible with Python 3.11

This updates the previous start to this fix here - #351

Pylint and flake8 are bumped together, see #359 (comment)

setup.py

azdev/operations/testtool/tests/test_profile_context.py

azdev/operations/pypi.py

.pylintrc

azdev/operations/help/__init__.py

azdev/operations/extensions/util.py

azdev/config/ext_pylintrc

azdev/operations/help/__init__.py

setup.py

jiasli · 2023-07-11T07:36:36Z

azdev/config/cli.flake8

+    # line too long, it is covered by pylint
+    E501,


Any reason for reformatting?

Because flake8 upgrade to 6.0. Flake8 6.0 does not support inline comments for any of the keys, so comments should be put in newline.
Use this to prevent ValueError: Error code '#' supplied to 'ignore' option does not match '^[A-Z]{1,3}[0-9]{0,3}$'

Related issue: PyCQA/flake8#1750 Azure/azure-cli#25370

When pylint==2.11.1, it installs mccabe 0.6.1. flake8 also requires mccabe, and only 4.0.1 meet the version constraint.

- pylint [required: ==2.11.1, installed: 2.11.1] - astroid [required: >=2.8.0,<2.9, installed: 2.8.6] - lazy-object-proxy [required: >=1.4.0, installed: 1.9.0] - setuptools [required: >=20.0, installed: 63.2.0] - wrapt [required: >=1.11,<1.14, installed: 1.13.3] - isort [required: >=4.2.5,<6, installed: 5.12.0] - mccabe [required: >=0.6,<0.7, installed: 0.6.1] - platformdirs [required: >=2.2.0, installed: 2.6.2] - toml [required: >=0.7.1, installed: 0.10.2] - flake8 [required: Any, installed: 4.0.1] - mccabe [required: >=0.6.0,<0.7.0, installed: 0.6.1] - pycodestyle [required: >=2.8.0,<2.9.0, installed: 2.8.0] - pyflakes [required: >=2.4.0,<2.5.0, installed: 2.4.0]

After upgrading PyLint 2.7, mccabe becomes [required: >=0.6,<0.8, installed: 0.7.0], and flake8 becomes 6.0.0.

Does this issue still exist in pylint 2.17.4? https://pypi.org/project/pylint/

When run azdev style, it uses pylintrc and .flake8 in CLI/Extension repo folder. If the files do not exist, it use cli.xxxx or ext.xxx in azdev config folder.
CLI's .flake8 is updated in Azure/azure-cli#25370.

jiasli · 2023-07-11T07:38:05Z

.pylintrc

@@ -10,7 +10,11 @@ disable=
    too-few-public-methods,
    too-many-arguments,
    consider-using-f-string,
-    unspecified-encoding
+    unspecified-encoding,
+    # These rules were added in Pylint >= 2.12 and are disabled to avoid making retroactively required


This sentence is not grammatically correct and hard to understand.

jiasli · 2023-07-11T07:38:18Z

azdev/config/cli_pylintrc

+module-naming-style=snake_case
+const-naming-style=UPPER_CASE
+class-naming-style=PascalCase
+class-attribute-naming-style=snake_case
+attr-naming-style=snake_case
+method-naming-style=snake_case
+function-naming-style=snake_case
+argument-naming-style=snake_case
+variable-naming-style=snake_case
+inlinevar-naming-style=snake_case


Any reason for the name change?

I think this is a incompatibility introduced by pylint 2.14

Several occurrences of E0015: Unrecognized option found on the config file:
function-name-hint, variable-name-hint, const-name-hint, attr-name-hint, argument-name-hint, class-attribute-name-hint, inlinevar-name-hint, class-name-hint, module-name-hint, method-name-hint - This is where the incompatibility is: The old option names are rejected by pylint 2.14, and the new option names are rejected by older pylint versions.

Ref: pylint-dev/pylint#6931

I saw the document has been moved to https://pylint.pycqa.org/en/v2.17.4/user_guide/messages/convention/invalid-name.html#predefined-naming-styles

After further investigation, these naming-style config can be removed.

They are nearly the same as default value.

invalid-name rule is disabled, these configurations make no sense.

cli_pylintrc hardly take effect as CLI has its own pylintrc.

I've removed them in CLI.
Azure/azure-cli#26685 (comment)

jiasli · 2023-07-11T07:45:18Z

azdev/operations/help/refdoc/common/directives.py

    ])


 class CliArgumentDirective(CliBaseDirective):
    doc_field_types = copy.copy(_CLI_FIELD_TYPES)
    doc_field_types.extend([
        Field('required', label='Required', has_arg=False,
-              names=('required')),
+              names=('required',)),


This changes the semantics of the code. Better to confirm if it is required or works as expected.

names should be Tuple[unicode, ...].
https://github.com/sphinx-doc/sphinx/blob/645044d7f03c7fcb4c39a8edf40aa66f6d6c2b64/sphinx/util/docfields.py#L55-L57

Why is this type error never found?

I comfirm this is a typo, as next line it becomes a tuple:

azure-cli-dev-tools/azdev/operations/help/refdoc/common/directives.py

Lines 75 to 76 in cabbb3e

Field('values', label='Allowed values', has_arg=False,

names=('values', 'choices', 'options')),

bebound · 2023-07-11T07:52:13Z

azdev/operations/help/refdoc/common/directives.py

        return False

    def add_target_and_index(self, name, sig, signode):
        signode['ids'].append(name)

-    def get_index_text(self, modname, name):  # pylint: disable=unused-argument, no-self-use


Otherwise it raises azdev/operations/help/refdoc/common/directives.py:46:0: R0022: Useless option value for 'disable', 'no-self-use' was moved to an optional extension, see https://pylint.pycqa.org/en/latest/whatsnew/2/2.14/summary.html#removed-checkers. (useless-option-value)

Pylint apparently doesn't think no-self-use is important anymore: pylint-dev/pylint#5502

bebound · 2023-07-12T08:23:21Z

.pylintrc

+    unspecified-encoding,
+    # These rules were added in Pylint >= 2.12, disable them to avoid making retroactive change
+    broad-exception-raised,
+    deprecated-module,


deprecated-module is quite useful and there is a few errors.
I prefer to enable it by default.

jiasli · 2023-07-13T02:18:02Z

azdev/config/cli_pylintrc

@@ -50,13 +53,13 @@ min-similarity-lines=10
 # The invalid-name checker must be **enabled** for these hints to be used.
 include-naming-hint=yes

-module-name-hint=lowercase (keep short; underscores are discouraged)


I am actually curious how (keep short; underscores are discouraged) works.

This hint is shown in the invalid-name error message. For example:
demo/demo.py:19:0: C0103: Class name "aa" doesn't conform to '{invalid-classname-hint}' pattern ('[_]{0,2}[A-Z]{1}[A-Za-z0-9]{0,30}$' pattern) (invalid-name)

I've removed all xxx-hint settings. See Azure/azure-cli#26685 (comment) and #359 (comment)

bebound and others added 12 commits February 6, 2023 11:21

Update

ac7c673

Minor fix

44c36ee

Enable no_self_use

d4070e8

Minor fix

1928f29

Minor fix

c60042d

Minor fix

3a22e88

Minor fix

87cb41c

Fix flake8

2fd99af

Update setup.py

998a0bc

Update cli_pylintrc

4cd84e7

Update ext_pylintrc

7a2c4fe

Merge branch 'dev' into dciborow/pylint

a4bb458

dciborow mentioned this pull request Mar 10, 2023

Bump Pylint to 2.17 #351

Closed

dciborow added 2 commits May 23, 2023 19:33

Merge branch 'dev' into dciborow/pylint

0fa543d

Update .pylintrc

a071b95

dciborow commented May 24, 2023

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Apply suggestions from code review

1028936

dciborow commented May 24, 2023

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Update setup.py

d207de8

dciborow commented May 24, 2023

View reviewed changes

azdev/operations/testtool/tests/test_profile_context.py Outdated Show resolved Hide resolved

Update azdev/operations/testtool/tests/test_profile_context.py

23cb1db

dciborow commented May 24, 2023

View reviewed changes

azdev/operations/pypi.py Show resolved Hide resolved

dciborow commented May 24, 2023

View reviewed changes

.pylintrc Outdated Show resolved Hide resolved

dciborow commented May 24, 2023

View reviewed changes

azdev/operations/help/__init__.py Outdated Show resolved Hide resolved

dciborow commented May 24, 2023

View reviewed changes

azdev/operations/extensions/util.py Outdated Show resolved Hide resolved

Apply suggestions from code review

ec84363

dciborow changed the title ~~Dciborow/pylint~~ Bump Pylint to latest version May 24, 2023

dciborow added 3 commits May 23, 2023 22:21

Update ext_pylintrc

513539f

Update cli_pylintrc

664c6c8

Update .pylintrc

074f8aa

dciborow commented May 24, 2023

View reviewed changes

azdev/config/ext_pylintrc Outdated Show resolved Hide resolved

Apply suggestions from code review

510f0c1

bebound reviewed Jun 14, 2023

View reviewed changes

azdev/operations/help/__init__.py Outdated Show resolved Hide resolved

bebound mentioned this pull request Jun 15, 2023

{Misc.} Improve code style and prepare for pylint 2.17 Azure/azure-cli#26685

Merged

7 tasks

bebound reviewed Jun 27, 2023

View reviewed changes

setup.py Outdated Show resolved Hide resolved

bebound and others added 5 commits June 30, 2023 15:20

Update azdev/operations/help/__init__.py

f07822b

Update setup.py

a4623ce

Merge branch 'dev' into dciborow/pylint

ae28381

Ignore missing-timeout

53f9b3d

Merge branch 'dev' into dciborow/pylint

4d2e2a5

bebound changed the title ~~Bump Pylint to latest version~~ Bump Pylint to 2.17 Jul 11, 2023

bebound approved these changes Jul 11, 2023

View reviewed changes

jiasli reviewed Jul 11, 2023

View reviewed changes

bebound reviewed Jul 11, 2023

View reviewed changes

Minor fix

0e60fba

bebound mentioned this pull request Jul 12, 2023

Prepare for new azdev Azure/azure-cli-extensions#6505

Closed

wangzelin007 approved these changes Jul 12, 2023

View reviewed changes

bebound reviewed Jul 12, 2023

View reviewed changes

Enable deprecated-module

f80f150

jiasli reviewed Jul 13, 2023

View reviewed changes

bebound changed the title ~~Bump Pylint to 2.17~~ Bump Pylint to 2.17 and flake8 to 6.0 Jul 13, 2023

Remove useless config

08e6383

jiasli approved these changes Jul 13, 2023

View reviewed changes

bebound merged commit 65c5e9c into Azure:dev Jul 14, 2023

This was referenced Jul 18, 2023

Support Python 3.11 Azure/azure-cli#24494

Closed

[Packaging] Support Python 3.11 Azure/azure-cli#26923

Merged

jiasli mentioned this pull request Jul 21, 2023

Declare support for Python 3.11 and drop support for Python 3.7 microsoft/knack#275

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump Pylint to 2.17 and flake8 to 6.0 #359

Bump Pylint to 2.17 and flake8 to 6.0 #359

dciborow commented Mar 10, 2023 •

edited by bebound

Loading

jiasli Jul 11, 2023

bebound Jul 11, 2023 •

edited

Loading

bebound Jul 11, 2023

jiasli Jul 13, 2023

bebound Jul 13, 2023

jiasli Jul 11, 2023

jiasli Jul 11, 2023

bebound Jul 12, 2023

jiasli Jul 13, 2023

bebound Jul 13, 2023

jiasli Jul 11, 2023

bebound Jul 11, 2023 •

edited

Loading

bebound Jul 12, 2023

bebound Jul 11, 2023

jiasli Jul 13, 2023

bebound Jul 12, 2023

jiasli Jul 13, 2023

bebound Jul 13, 2023 •

edited

Loading

	Field('values', label='Allowed values', has_arg=False,
	names=('values', 'choices', 'options')),

Bump Pylint to 2.17 and flake8 to 6.0 #359

Bump Pylint to 2.17 and flake8 to 6.0 #359

Conversation

dciborow commented Mar 10, 2023 • edited by bebound Loading

Choose a reason for hiding this comment

bebound Jul 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bebound Jul 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bebound Jul 13, 2023 • edited Loading

Choose a reason for hiding this comment

dciborow commented Mar 10, 2023 •

edited by bebound

Loading

bebound Jul 11, 2023 •

edited

Loading

bebound Jul 11, 2023 •

edited

Loading

bebound Jul 13, 2023 •

edited

Loading