Update dependency pylint to v3 #66
Reference in New Issue
Block a user
No description provided.
Delete Branch "renovate/pylint-3.x"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
^2.17.4->^3.0.0==2.17.7->==3.0.1Release Notes
pylint-dev/pylint (pylint)
v3.0.1False Positives Fixed
Fixed false positive for
inherit-non-classfor generic Protocols.Closes #9106
Other Changes
Fix a crash when an enum class which is also decorated with a
dataclasses.dataclassdecorator is defined.Closes #9100
v3.0.0Pylint now support python 3.12 officially.
This long anticipated major version also provides some important usability and performance improvements, along with enacting necessary breaking changes and long-announced deprecations. The documentation of each message with an example is very close too.
The required astroid version is now 3.0.0. See the astroid changelog for additional fixes, features, and performance improvements applicable to pylint.
Our code is now fully typed. The invalid-name message no longer checks for a minimum length of 3 characters by default. Dependencies like wrapt or setuptools were removed.
A new json2 reporter has been added. It features an enriched output that is easier to parse and provides more info, here's a sample output.
Breaking Changes
Enabling or disabling individual messages will now take effect even if an
--enable=allordisable=allfollows in the same configuration file(or on the command line).
This means for the following example,
fixmemessages will now be emitted:To regain the prior behavior, remove the superfluous earlier option.
Closes #3696
Remove support for launching pylint with Python 3.7.
Code that supports Python 3.7 can still be linted with the
--py-version=3.7setting.Refs #6306
Disables placed in a
tryblock now apply to theexceptblock.Previously, they only happened to do so in the presence of an
elseclause.Refs #7767
pyreversenow uses a new default color palette that is more colorblind friendly.The color scheme is taken from
Paul Tol's Notes <https://personal.sron.nl/~pault/>_.If you prefer other colors, you can use the
--color-paletteoption to specify custom colors.Closes #8251
Everything related to the
__implements__construct was removed. It was based on PEP245that was proposed in 2001 and rejected in 2006.
The capability from pyreverse to take
__implements__into account when generating diagramswas also removed.
Refs #8404
pyreverse: Support for the.vcgoutput format (Visualization of Compiler Graphs) has been dropped.Closes #8416
The warning when the now useless old pylint cache directory (pylint.d) was
found was removed. The cache dir is documented in
the FAQ <https://pylint.readthedocs.io/en/latest/faq.html#where-is-the-persistent-data-stored-to-compare-between-successive-runs>_.Refs #8462
Following a deprecation period,
pylint.config.PYLINTRCwas removed.Use the
pylint.config.find_default_config_filesgenerator instead.Closes #8862
Changes requiring user actions
The
invalid-namemessage no longer checks for a minimum length of 3 characters by default.(This was an unadvertised commingling of concerns between casing
and name length, and users regularly reported this to be surprising.)
If checking for a minimum length is still desired, it can be regained in two ways:
If you are content with a
disallowed-namemessage (instead ofinvalid-name), then simply add the optionbad-names-rgxs="^..?$",which will fail 1-2 character-long names. (Ensure you enable
disallowed-name.)If you would prefer an
invalid-namemessage to be emitted, or wouldprefer finer-grained control over the circumstances in which messages are
emitted (classes vs. methods, etc.), then avail yourself of the regex
options described
here <https://pylint.readthedocs.io/en/stable/user_guide/configuration/all-options.html#main-checker>.(In particular, take note of the commented out options in the "example
configuration" given at the bottom of the section.) The prior regexes can
be found in the
pull request <https://github.com/pylint-dev/pylint/pull/8813>that removed the length requirements.
Closes #2018
The compare to empty string checker (
pylint.extensions.emptystring) and the compare tozero checker (
pylint.extensions.compare-to-zero) have been removed and their checks arenow part of the implicit booleaness checker:
compare-to-zerowas renameduse-implicit-booleaness-not-comparison-to-zeroandcompare-to-empty-stringwas renameduse-implicit-booleaness-not-comparison-to-stringand they now need to be enabled explicitly.
The
pylint.extensions.emptystringandpylint.extensions.compare-to-zeroextensionsno longer exist and need to be removed from the
load-pluginsoption.Messages related to implicit booleaness were made more explicit and actionable.
This permits to make their likeness explicit and will provide better performance as they
share most of their conditions to be raised.
Closes #6871
epylint was removed. It now lives at: https://github.com/emacsorphanage/pylint.
Refs #7737
The
overgeneral-exceptionsoption now only takes fully qualified namesinto account (
builtins.ExceptionnotException). If you overrodethis option, you need to use the fully qualified name now.
There's still a warning, but it will be removed in 3.1.0.
Refs #8411
Following a deprecation period, it's no longer possible to use
MASTERor
masteras configuration section insetup.cfgortox.ini. It's bad practiceto not start a section title with the tool name. Please use
pylint.maininstead.Refs #8465
Package stats are now printed when running Pyreverse and a
--verboseflag was added to get the original output with parsed modules. You might need to activate the verbose option if you want to keep the old output.Closes #8973
New Features
A new
json2reporter has been added. It features a more enriched output that iseasier to parse and provides more info.
Compared to
jsonthe only changes are that messages are now under the"messages"key and that
"message-id"now follows the camelCase convention and is renamed to"messageId".The new reporter also reports the "score" of the modules you linted as defined by the
evaluationoption and provides statistics about the modules you linted.We encourage users to use the new reporter as the
jsonreporter will no longerbe maintained.
Closes #4741
In Pyreverse package dependency diagrams, show when a module imports another only for type-checking.
Closes #8112
Add new option (
--show-stdlib,-L) topyreverse.This is similar to the behavior of
--show-builtinin that standard librarymodules are now not included by default, and this option will include them.
Closes #8181
Add Pyreverse option to exclude standalone nodes from diagrams with
--no-standalone.Closes #8476
New Checks
Added
DataclassCheckermodule andinvalid-field-callchecker to check for invalid dataclasses.field() usage.Refs #5159
Add
return-in-finallyto emit a message if a return statement was found in a finally clause.Closes #8260
Add a new checker
kwarg-superseded-by-positional-argto warn when a function is called with a keyword argument which shares a name with a positional-only parameter and the function contains a keyword variadic parameter dictionary. It may be surprising behaviour when the keyword argument is added to the keyword variadic parameter dictionary.Closes #8558
Extensions
Add new
prefer-typing-namedtuplemessage to theCodeStyleCheckerto suggestrewriting calls to
collections.namedtupleas classes inheriting fromtyping.NamedTupleon Python 3.6+.
Requires
load-plugins=pylint.extensions.code_styleandenable=prefer-typing-namedtupleto be raised.Closes #8660
False Positives Fixed
Extend concept of "function ambiguity" in
safe_infer()fromdiffering number of function arguments to differing set of argument names.
Solves false positives in
tensorflow.Closes #3613
Fix
unused-argumentfalse positive when__new__does not use all the arguments of__init__.Closes #3670
Fix a false positive for
invalid-namewhen a type-annotated class variable in anenum.Enumclass has no assigned value.Refs #7402
Fix
unused-importfalse positive for usage ofsix.with_metaclass.Closes #7506
Fix false negatives and false positives for
too-many-try-statements,too-complex, andtoo-many-branchesby correctly counting statementsunder a
try.Refs #7767
When checking for unbalanced dict unpacking in for-loops, Pylint will now test whether the length of each value to be
unpacked matches the number of unpacking targets. Previously, Pylint would test the number of values for the loop
iteration, which would produce a false unbalanced-dict-unpacking warning.
Closes #8156
Fix false positive for
used-before-assignmentwhen usage and assignmentare guarded by the same test in different statements.
Closes #8167
Adds
asyncSetUpto the defaultdefining-attr-methodslist to silenceattribute-defined-outside-initwarning when usingunittest.IsolatedAsyncioTestCase.Refs #8403
logging-not-lazyis not longer emitted for explicitly concatenated string arguments.Closes #8410
Fix false positive for isinstance-second-argument-not-valid-type when union types contains None.
Closes #8424
invalid-namenow allows for integers intypealiasnames:Good2Name,GoodName2._1BadName.Closes #8485
No longer consider
Unionas type annotation as type alias for naming checks.Closes #8487
unnecessary-lambdano longer warns on lambdas which use its parameters intheir body (other than the final arguments), e.g.
lambda foo: (bar if foo else baz)(foo).Closes #8496
Fixed
unused-importso that it observes thedummy-variables-rgxoption.Closes #8500
Uniontyped variables without assignment are no longer treated asTypeAlias.Closes #8540
Allow parenthesized implicitly concatenated strings when
check-str-concat-over-line-jumpsis enabled.Closes #8552.
Fix false positive for
positional-only-arguments-expectedwhen a function contains both a positional-only parameter that has a default value, and**kwargs.Closes #8555
Fix false positive for
keyword-arg-before-varargwhen a positional-only parameter with a default value precedes*args.Closes #8570
Fix false positive for
arguments-differwhen overriding__init_subclass__.Closes #8919
Fix a false positive for
no-value-for-parameterwhen a staticmethod is called in a class body.Closes #9036
False Negatives Fixed
Emit
used-before-assignmentwhen calling module-level functions before definition.Closes #1144
Apply
infer_kwarg_from_call()to more checksThese mostly solve false negatives for various checks,
save for one false positive for
use-maxsplit-arg.Closes #7761
TypeAliasvariables defined in functions are now checked forinvalid-nameerrors.Closes #8536
Fix false negative for
no-value-for-parameterwhen a function, whose signature contains both a positional-only parameternameand also*kwargs, is called with a keyword-argument forname.Closes #8559
Fix a false negative for
too-many-argumentsby considering positional-only and keyword-only parameters.Closes #8667
Emit
assignment-from-no-returnfor calls to builtin methods likedict.update().Calls to
list.sort()now raiseassignment-from-no-returnrather than
assignment-from-nonefor consistency.Closes #8714
Closes #8810
consider-using-augmented-assignis now applied to dicts and lists as well.Closes #8959
Other Bug Fixes
Support
duplicate-codemessage when parallelizing with--jobs.Closes #374
Support
cyclic-importmessage when parallelizing with--jobs.Closes #4171
--jobscan now be used with--load-plugins.This had regressed in astroid 2.5.0.
Closes #4874
docparams extension considers type comments as type documentation.
Closes #6287
When parsing comma-separated lists of regular expressions in the config, ignore
commas that are inside braces since those indicate quantifiers, not delineation
between expressions.
Closes #7229
The
ignored-modulesoption will now be correctly taken into account forno-name-in-module.Closes #7578
sys.argvis now always correctly considered as impossible to infer (instead ofusing the actual values given to pylint).
Closes #7710
Avoid duplicative warnings for unqualified exception names in the
overgeneral-exceptionssetting when running with
--jobs.Closes #7774
Don't show class fields more than once in Pyreverse diagrams.
Closes #8189
Fix
used-before-assignmentfalse negative when TYPE_CHECKING importsare used in multiple scopes.
Closes #8198
--clear-cache-post-runnow also clears LRU caches for pylint utilitiesholding references to AST nodes.
Closes #8361
Fix a crash when
TYPE_CHECKINGis used without importing it.Closes #8434
Fix a
used-before-assignmentfalse positive when importsare made under the
TYPE_CHECKINGelse if branch.Closes #8437
Fix a regression of
preferred-moduleswhere a partial match was used instead of the required full match.Closes #8453
Fix a crash in pyreverse when "/" characters are used in the output filename e.g pyreverse -o png -p name/ path/to/project.
Closes #8504
Don't show arrows more than once in Pyreverse diagrams.
Closes #8522
Improve output of
consider-using-generatormessage formin()calls withdefaultkeyword.Closes #8563
Fixed a crash when generating a configuration file:
tomlkit.exceptions.TOMLKitError: Can't add a table to a dotted keycaused by tomlkit
v0.11.8.Closes #8632
Fix a line break error in Pyreverse dot output.
Closes #8671
Fix a false positive for
method-hiddenwhen usingcached_propertydecorator.Closes #8753
Dunder methods defined in lambda do not trigger
unnecessary-dunder-callanymore, if they cannot be replaced by the non-dunder call.Closes #8769
Don't show duplicate type annotations in Pyreverse diagrams.
Closes #8888
Fixing inconsistent hashing issue in
BaseCheckercausing some reports not being exported.Closes #9001
Don't add
Optionalto|annotations withNonein Pyreverse diagrams.Closes #9014
Pyreverse doesn't show multiple class association arrows anymore, but only the strongest one.
Refs #9045
Prevented data loss in the linter stats for messages relating
to the linter itself (e.g.
unknown-option-value), fixingproblems with score, fail-on, etc.
Closes #9059
Fix crash in refactoring checker when unary operand used with variable in for loop.
Closes #9074
Other Changes
Pylint now exposes its type annotations.
Closes #5488 and #2079
Search for
pyproject.tomlrecursively in parent directories up to a project or file system root.Refs #7163, Closes #3289
All code related to the optparse config parsing has been removed.
Refs #8405
Pylint now supports python 3.12.
Refs #8718
Add a CITATION.cff file to the root of the repository containing the necessary metadata to cite Pylint.
Closes #8760
Renamed the "unneeded-not" error into "unnecessary_negation" to be clearer.
Closes #8789
Internal Changes
get_message_definitionwas removed from the base checker API. You can accessmessage definitions through the
MessageStore.Refs #8401
Everything related to the
__implements__construct was removed. It was based on PEP245that was proposed in 2001 and rejected in 2006.
All the classes inheriting
Interfaceinpylint.interfaceswere removed.Checkershould only inheritBaseCheckeror any of the other checker typesfrom
pylint.checkers.Reportershould only inheritBaseReporter.Refs #8404
modnameandmsg_storeare now required to be given inFileState.collect_block_lineshas also been removed.Pylinter.current_namecannot be null anymore.
Refs #8407
Reporter.set_outputwas removed in favor ofreporter.out = stream.Refs #8408
A number of old utility functions and classes have been removed:
MapReduceMixin: To make a checker reduce map data simply implementget_map_dataandreduce_map_data.is_inside_lambda: Useutils.get_node_first_ancestor_of_type(x, nodes.Lambda)check_messages: Useutils.only_required_for_messagesis_class_subscriptable_pep585_with_postponed_evaluation_enabled: Useis_postponed_evaluation_enabled(node)andis_node_in_type_annotation_context(node)get_python_path: assumption that there's always an init.py is not true sincepython 3.3 and is causing problems, particularly with PEP 420. Use
discover_package_pathand pass source root(s).
fix_import_path: Useaugmented_sys_pathand pass additionalsys.pathentries as an argument obtained from
discover_package_path.get_global_option: Usechecker.linter.configto get all global options.Related private objects have been removed as well.
Refs #8409
colorize_ansinow only accepts aMessageStyleobject.Refs #8412
Following a deprecation period,
Pylinter.checknow only works with sequences of strings, not strings.Refs #8463
Following a deprecation period,
ColorizedTextReporteronly acceptsColorMappingDict.Refs #8464
Following a deprecation period,
MessageTest'send_lineandend_col_offsetmust be accurate in functional tests (for python 3.8 or above on cpython, and for
python 3.9 or superior on pypy).
Refs #8466
Following a deprecation period, the
do_exitargument of theRunclass (and of the_Runclass in testutils) were removed.
Refs #8472
Following a deprecation period, the
py_versionargument of theMessageDefinition.may_be_emittedfunction is now required. The most likely solutionis to use 'linter.config.py_version' if you need to keep using this
function, or to use 'MessageDefinition.is_message_enabled' instead.
Refs #8473
Following a deprecation period, the
OutputLineclass now requiresthe right number of argument all the time. The functional output can be
regenerated automatically to achieve that easily.
Refs #8474
Following a deprecation period,
is_typing_guard,is_node_in_typing_guarded_import_blockandis_node_in_guarded_import_blockfrompylint.utilswere removed: use a combination ofis_sys_guardandin_type_checking_blockinstead.Refs #8475
Following a deprecation period, the
locationargument of theMessageclass must now be aMessageLocationTuple.Refs #8477
Following a deprecation period, the
check_single_filefunction of thePylinteris replaced byPylinter.check_single_file_item.Refs #8478
Performance Improvements
pylintruns (at least) ~5% faster after improvements toastroidthat make better use of the inference cache.
Refs pylint-dev/astroid#529
is_trailing_comma().class_is_abstract().Refs #1954
Exit immediately if all messages are disabled.
Closes #8715
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR has been generated by Mend Renovate. View repository job log here.
Kudos, SonarCloud Quality Gate passed!