As a result of the refactor there are a lot of internal deprecations. If you're a library
maintainer that depends on pylint, please verify that you're ready for pylint 3.0
by activating deprecation warnings.
Added new checkercomparison-of-constants.
Closes#6076
Added new checkertypevar-name-mismatch: TypeVar must be assigned to a variable with the same name as its name argument.
Closes#5224
invalid-enum-extension: Used when a class tries to extend an inherited Enum class.
Closes#5501
Added new checkertypevar-double-variance: The "covariant" and "contravariant" keyword arguments
cannot both be set to "True" in a TypeVar.
Closes#5895
Add new checkunnecessary-dunder-call for unnecessary dunder method calls.
Closes#5936
unnecessary-lambda-assignment: Lambda expression assigned to a variable.
Define a function using the "def" keyword instead.
unnecessary-direct-lambda-call: Lambda expression called directly.
Execute the expression inline instead.
Closes#5976
potential-index-error: Emitted when the index of a list or tuple exceeds its length.
This checker is currently quite conservative to avoid false positives. We welcome
suggestions for improvements.
Closes#578
Added new checkerunnecessary-list-index-lookup for indexing into a list while
iterating overenumerate().
Closes#4525
Added new message calledduplicate-value which identifies duplicate values inside sets.
Closes#5880
Added thesuper-without-brackets checker, raised when a super call is missing its brackets.
Closes#4008
Started ignoring underscore as a local variable fortoo-many-locals.
Closes#6488
Pylint can now be installed with an extra-require calledspelling (pip install pylint[spelling]).
This will addpyenchant to pylint's dependencies. You will still need to install the
requirements forpyenchant (theenchant library and any dictionaries) yourself. You will also
need to set thespelling-dict option.
Refs#6462
Improved wording of the message ofdeprecated-module
Closes#6169
Pylint now requires Python 3.7.2 or newer to run.
Closes#4301
We made a greater effort to reraise failures stemming from theastroid
library asAstroidError, with the effect that pylint emitsastroid-error
rather than merelyfatal. Regardless, please report any such issues you encounter!
We have improved our recognition of inline disable and enable comments. It is
now possible to disablebad-option-value inline (as long as you disable it before
the bad option value is raised, i.e.disable=bad-option-value,bad-message notdisable=bad-message,bad-option-value ) as well as certain other
previously unsupported messages.
Closes#3312
The main checker name is nowmain instead ofmaster. The configuration does not need to be updated as sections' name are optional.
Closes#5467
Updateinvalid-slots-object message to show bad object rather than its inferred value.
Closes#6101
Fixed a crash in thenot-an-iterable checker involving multiple starred expressions
inside a call.
Closes#6372
Fixed a crash in theunused-private-member checker involving chained private attributes.
Closes#6709
Disable spellchecking of mypy rule names in ignore directives.
Closes#5929
implicit-str-concat will now be raised on calls likeopen("myfile.txt" "a+b") too.
Closes#6441
Fix a failure to respect inline disables forfixme occurring on the last line
of a module when pylint is launched with--enable=fixme.
Removed the brokengenerate-man option.
Closes#5283
Closes#1887
Fixed failure to enabledeprecated-module after adisable=all
by makingImportsChecker solely responsible for emittingdeprecated-module instead
of sharing responsibility withStdlibChecker. (This could have led to double messages.)
Added thegenerate-toml-config option.
Refs#5462
bad-option-value will be emitted whenever a configuration value or command line invocation
includes an unknown message.
Closes#4324
Added theunrecognized-option message. Raised if we encounter any unrecognized options.
Closes#5259
Fix false negative forbad-string-format-type if the value to be formatted is passed in
as a variable holding a constant.
The concept of checker priority has been removed.
Thecache-max-size-none checker has been renamed tomethod-cache-max-size-none.
Closes#5670
Themethod-cache-max-size-none checker will now also checkfunctools.cache.
Closes#5670
BaseChecker classes now require thelinter argument to be passed.
Theset_config_directly decorator has been removed.
Don't reportuseless-super-delegation for the__hash__ method in classes that also override the__eq__ method.
Closes#3934
Fix falsely issuinguseless-suppression on thewrong-import-position checker.
Closes#5219
Fixed false positiveno-member for Enums with self-defined members.
Closes#5138
Fix false negative forno-member when attempting to assign an instance
attribute to itself without any prior assignment.
Closes#1555
Changed message type fromredefined-outer-name toredefined-loop-name
(optional extension) for redefinitions of outer loop variables by inner loops.
Closes#5608
By default the similarity checker will now ignore imports and ignore function signatures when computing
duplication. If you want to keep the previous behaviour setignore-imports andignore-signatures toFalse.
Pylint now expands the user path (i.e.~ tohome/yusef/) and expands environment variables (i.e.home/$USER/$project
tohome/yusef/pylint forUSER=yusef andproject=pylint) for pyreverse'soutput-directory,
import-graph,ext-import-graph,int-import-graph options, and the spell checker'sspelling-private-dict-file
option.
Refs#6493
Don't emitunsubscriptable-object for string annotations.
Pylint doesn't check if class is only generic in type stubs only.
Closes#4369 and#6523
Fix pyreverse crashRuntimeError: dictionary changed size during iteration
Refs#6612
Fix syntax for return type annotations in MermaidJS diagrams produced withpyreverse.
Closes#6467
Fix type annotations of class and instance attributes using the alternative union syntax inpyreverse diagrams.
Fix bug where it writes a plain text error message to stdout, invalidating output formats.
Closes#6597
The refactoring checker now also raises 'consider-using-a-generator' messages for
max(),min() andsum().
Refs#6595
Update ranges forusing-constant-test andmissing-parentheses-for-call-in-test
error messages.
Don't emitno-member inside type annotations with
from __future__ import annotations.
Closes#6594
Fixunexpected-special-method-signature false positive for__init_subclass__ methods with one or more arguments.
Closes#6644
Theignore-mixin-members option has been deprecated. You should now use the new
ignored-checks-for-mixins option.
Closes#5205
interfaces.implements has been deprecated and will be removed in 3.0. Please use standard inheritance
patterns instead of__implements__.
Refs#2287
AllInterface classes inpylint.interfaces have been deprecated. You can subclass
the respective normal classes to get the same behaviour. The__implements__ functionality
was based on a rejected PEP from 2001:
https://peps.python.org/pep-0245/
Closes#2287
MapReduceMixin has been deprecated.BaseChecker now implementsget_map_data and
reduce_map_data. If a checker actually needs to reduce data it should defineget_map_data
as returning something different thanNone and let itsreduce_map_data handle a list
of the types returned byget_map_data.
An example can be seen by looking atpylint/checkers/similar.py.
Theconfig attribute ofBaseChecker has been deprecated. You can usechecker.linter.config
to access the global configuration object instead of a checker-specific object.
Refs#5392
Thelevel attribute ofBaseChecker has been deprecated: everything is now
displayed in--help, all the time.
Refs#5392
Theset_option method ofBaseChecker has been deprecated. You can usechecker.linter.set_option
to set an option on the global configuration object instead of a checker-specific object.
Refs#5392
Theoptions_providers attribute ofArgumentsManager has been deprecated.
Refs#5392
Fix saving of persistent data files in environments where the user's cache
directory and the linted file are on a different drive.
Closes#6394
Themethod-cache-max-size-none checker will now also checkfunctools.cache.
Theconfig attribute ofPyLinter is now of theargparse.Namespace type instead of
optparse.Values.
Refs#5392
UnsupportedAction has been deprecated.
Refs#5392
OptionsManagerMixIn has been deprecated.
Refs#5392
OptionParser has been deprecated.
Refs#5392
Option has been deprecated.
Refs#5392
OptionsProviderMixIn has been deprecated.
Refs#5392
ConfigurationMixIn has been deprecated.
Theoption_groups attribute ofPyLinter has been deprecated.
Refs#5392
get_global_config has been deprecated. You can now access all global options from
checker.linter.config.
Refs#5392
OptionsManagerMixIn has been replaced withArgumentsManager.ArgumentsManager is considered
private API and most methods that were public onOptionsManagerMixIn have now been deprecated and will
be removed in a future release.
Refs#5392
OptionsProviderMixIn has been replaced withArgumentsProvider.ArgumentsProvider is considered
private API and most methods that were public onOptionsProviderMixIn have now been deprecated and will
be removed in a future release.
Refs#5392
pylint.pyreverse.ASTWalker has been removed, as it was only used internally by a single child class.
Refs#6712
pyreverse: Resolving and displaying implemented interfaces that are defined by the__implements__
attribute has been deprecated and will be removed in 3.0.
Refs#6713
is_class_subscriptable_pep585_with_postponed_evaluation_enabled has been deprecated.
Useis_postponed_evaluation_enabled(node) and is_node_in_type_annotation_context(node)
instead.
Refs#6536
Uh oh!
There was an error while loading.Please reload this page.
This PR contains the following updates:
==2.13.9->==2.14.3Release Notes
PyCQA/pylint
v2.14.3Compare Source
Fixed two false positives for
bad-super-callfor calls that refer to a non-direct parent.Closes#4922, Closes#2903
Fixed a false positive for
useless-super-delegationfor subclasses that specify the number ofof parameters against a parent that uses a variadic argument.
Closes#2270
Allow suppressing
undefined-loop-variableandundefined-variablewithout raisinguseless-suppression.Fixed false positive for
undefined-variablefor__class__in inner methods.Closes#4032
v2.14.2Compare Source
Fixed a false positive for
unused-variablewhen a function returns anargparse.Namespaceobject.Closes#6895
Avoided raising an identical
undefined-loop-variablemessage twice on the same line.Don't crash if
lint.run._query_cpu()is run within a Kubernetes Pod, that has onlya fraction of a cpu core assigned. Just go with one process then.
Closes#6902
Fixed a false positive in
consider-using-f-stringif the left side of a%is not a string.Closes#6689
Fixed a false positive in
unnecessary-list-index-lookupandunnecessary-dict-index-lookupwhen the subscript is updated in the body of a nested loop.
Closes#6818
Fixed an issue with multi-line
init-hookoptions which did not record the line endings.Closes#6888
Fixed a false positive for
used-before-assignmentwhen a try block returnsbut an except handler defines a name via type annotation.
--errors-onlyno longer enables previously disabled messages. It was acting as"emitall and only error messages" without being clearly documented that way.
Closes#6811
v2.14.1Compare Source
Avoid reporting
unnecessary-dict-index-lookuporunnecessary-list-index-lookupwhen the index lookup is part of a destructuring assignment.
Closes#6788
Fixed parsing of unrelated options in
tox.ini.Closes#6800
Fixed a crash when linting
__new__()methods that return a call expression.Closes#6805
Don't crash if we can't find the user's home directory.
Closes#6802
Fixed false positives for
unused-importwhen aliasingtypinge.g. astand guarding imports under
t.TYPE_CHECKING.Closes#3846
Fixed a false positive regression in 2.13 for
used-before-assignmentwhere it is safe to relyon a name defined only in an
exceptblock because theelseblock returned.Closes#6790
Fixed the use of abbreviations for some special options on the command line.
Closes#6810
Fix a crash in the optional
pylint.extensions.private_importextension.Closes#6624
bad-option-value(E0012) is now a warningunknown-option-value(W0012). Deleted messages that do not existanymore in pylint now raise
useless-option-value(R0022) instead ofbad-option-value. This allows todistinguish between genuine typos and configuration that could be cleaned up. Existing message disables for
bad-option-valuewill still work on both new messages.Refs#6794
v2.14.0Compare Source
Summary -- Release highlights
With 2.14
pylintonly supports Python version 3.7.2 and above.We introduced several new checks among which
duplicate-valuefor sets,comparison-of-constants, and checks related to lambdas. We removedno-initandmade
no-self-useoptional as they were too opinionated. We also added an optionto generate a toml configuration:
--generate-toml-config.We migrated to
argparsefromoptparseand refactored the configuration handlingthanks to Daniël van Noord. On the user side it should change the output of the
--helpcommand, and some inconsistencies and bugs should disappear. The behaviorbetween options set in a config file versus on the command line will be more consistent. For us,
it will permit to maintain this part of the code easily in the future and anticipate
optparse's removal in Python 3.12.As a result of the refactor there are a lot of internal deprecations. If you're a library
maintainer that depends on pylint, please verify that you're ready for pylint 3.0
by activating deprecation warnings.
We continued the integration of
pylint-errorand are now at 33%!. We still welcomeany community effort to help review, integrate, and add good/bad examples in#5953.
This should be doable without any
pylintorastroidknowledge, so this is the perfectentrypoint if you want to contribute to
pylintor open source without any experiencewith our code!
New checkers
Added new checker
comparison-of-constants.Closes#6076
Added new checker
typevar-name-mismatch: TypeVar must be assigned to a variable with the same name as its name argument.Closes#5224
invalid-enum-extension: Used when a class tries to extend an inherited Enum class.Closes#5501
Added new checker
typevar-double-variance: The "covariant" and "contravariant" keyword argumentscannot both be set to "True" in a TypeVar.
Closes#5895
Add new check
unnecessary-dunder-callfor unnecessary dunder method calls.Closes#5936
unnecessary-lambda-assignment: Lambda expression assigned to a variable.Define a function using the "def" keyword instead.
unnecessary-direct-lambda-call: Lambda expression called directly.Execute the expression inline instead.
Closes#5976
potential-index-error: Emitted when the index of a list or tuple exceeds its length.This checker is currently quite conservative to avoid false positives. We welcome
suggestions for improvements.
Closes#578
Added new checker
unnecessary-list-index-lookupfor indexing into a list whileiterating over
enumerate().Closes#4525
Added new message called
duplicate-valuewhich identifies duplicate values inside sets.Closes#5880
Added the
super-without-bracketschecker, raised when a super call is missing its brackets.Closes#4008
Removed checkers
The
no-init(W0232) warning has been removed. It's ok to not have an__init__in a class.Closes#2409
Removed the
assign-to-new-keywordmessage as there are no new keywords in the supported Pythonversions any longer.
Closes#4683
Moved
no-self-usecheck to optional extension.You now need to explicitly enable this check using
load-plugins=pylint.extensions.no_self_use.Closes#5502
Extensions
RedefinedLoopNameCheckerredefined-loop-nameto emit messages when a loop variableis redefined in the loop body.
Closes#5072
DocStringStyleCheckerbad-docstring-quotesfor Python <= 3.7.Closes#6087
NoSelfUseCheckerno-self-usecheck, previously enabled by default.Closes#5502
Other Changes
Started ignoring underscore as a local variable for
too-many-locals.Closes#6488
Pylint can now be installed with an extra-require called
spelling(pip install pylint[spelling]).This will add
pyenchantto pylint's dependencies. You will still need to install therequirements for
pyenchant(theenchantlibrary and any dictionaries) yourself. You will alsoneed to set the
spelling-dictoption.Refs#6462
Improved wording of the message of
deprecated-moduleCloses#6169
Pylintnow requires Python 3.7.2 or newer to run.Closes#4301
We made a greater effort to reraise failures stemming from the
astroidlibrary as
AstroidError, with the effect that pylint emitsastroid-errorrather than merely
fatal. Regardless, please report any such issues you encounter!We have improved our recognition of inline disable and enable comments. It is
now possible to disable
bad-option-valueinline (as long as you disable it beforethe bad option value is raised, i.e.
disable=bad-option-value,bad-messagenotdisable=bad-message,bad-option-value) as well as certain otherpreviously unsupported messages.
Closes#3312
The main checker name is now
maininstead ofmaster. The configuration does not need to be updated as sections' name are optional.Closes#5467
Update
invalid-slots-objectmessage to show bad object rather than its inferred value.Closes#6101
Fixed a crash in the
not-an-iterablechecker involving multiple starred expressionsinside a call.
Closes#6372
Fixed a crash in the
unused-private-memberchecker involving chained private attributes.Closes#6709
Disable spellchecking of mypy rule names in ignore directives.
Closes#5929
implicit-str-concatwill now be raised on calls likeopen("myfile.txt" "a+b")too.Closes#6441
Fix a failure to respect inline disables for
fixmeoccurring on the last lineof a module when pylint is launched with
--enable=fixme.Removed the broken
generate-manoption.Closes#5283
Closes#1887
Fixed failure to enable
deprecated-moduleafter adisable=allby making
ImportsCheckersolely responsible for emittingdeprecated-moduleinsteadof sharing responsibility with
StdlibChecker. (This could have led to double messages.)Added the
generate-toml-configoption.Refs#5462
bad-option-valuewill be emitted whenever a configuration value or command line invocationincludes an unknown message.
Closes#4324
Added the
unrecognized-optionmessage. Raised if we encounter any unrecognized options.Closes#5259
Fix false negative for
bad-string-format-typeif the value to be formatted is passed inas a variable holding a constant.
The concept of checker priority has been removed.
The
cache-max-size-nonechecker has been renamed tomethod-cache-max-size-none.Closes#5670
The
method-cache-max-size-nonechecker will now also checkfunctools.cache.Closes#5670
BaseCheckerclasses now require thelinterargument to be passed.The
set_config_directlydecorator has been removed.Don't report
useless-super-delegationfor the__hash__method in classes that also override the__eq__method.Closes#3934
Fix falsely issuing
useless-suppressionon thewrong-import-positionchecker.Closes#5219
Fixed false positive
no-memberfor Enums with self-defined members.Closes#5138
Fix false negative for
no-memberwhen attempting to assign an instanceattribute to itself without any prior assignment.
Closes#1555
Changed message type from
redefined-outer-nametoredefined-loop-name(optional extension) for redefinitions of outer loop variables by inner loops.
Closes#5608
By default the similarity checker will now ignore imports and ignore function signatures when computing
duplication. If you want to keep the previous behaviour set
ignore-importsandignore-signaturestoFalse.Pylint now expands the user path (i.e.
~tohome/yusef/) and expands environment variables (i.e.home/$USER/$projectto
home/yusef/pylintforUSER=yusefandproject=pylint) for pyreverse'soutput-directory,import-graph,ext-import-graph,int-import-graphoptions, and the spell checker'sspelling-private-dict-fileoption.
Refs#6493
Don't emit
unsubscriptable-objectfor string annotations.Pylint doesn't check if class is only generic in type stubs only.
Closes#4369 and#6523
Fix pyreverse crash
RuntimeError: dictionary changed size during iterationRefs#6612
Fix syntax for return type annotations in MermaidJS diagrams produced with
pyreverse.Closes#6467
Fix type annotations of class and instance attributes using the alternative union syntax in
pyreversediagrams.Fix bug where it writes a plain text error message to stdout, invalidating output formats.
Closes#6597
The refactoring checker now also raises 'consider-using-a-generator' messages for
max(),min()andsum().Refs#6595
Update ranges for
using-constant-testandmissing-parentheses-for-call-in-testerror messages.
Don't emit
no-memberinside type annotations withfrom __future__ import annotations.Closes#6594
Fix
unexpected-special-method-signaturefalse positive for__init_subclass__methods with one or more arguments.Closes#6644
Deprecations
The
ignore-mixin-membersoption has been deprecated. You should now use the newignored-checks-for-mixinsoption.Closes#5205
interfaces.implementshas been deprecated and will be removed in 3.0. Please use standard inheritancepatterns instead of
__implements__.Refs#2287
All
Interfaceclasses inpylint.interfaceshave been deprecated. You can subclassthe respective normal classes to get the same behaviour. The
__implements__functionalitywas based on a rejected PEP from 2001:
https://peps.python.org/pep-0245/
Closes#2287
MapReduceMixinhas been deprecated.BaseCheckernow implementsget_map_dataandreduce_map_data. If a checker actually needs to reduce data it should defineget_map_dataas returning something different than
Noneand let itsreduce_map_datahandle a listof the types returned by
get_map_data.An example can be seen by looking at
pylint/checkers/similar.py.The
configattribute ofBaseCheckerhas been deprecated. You can usechecker.linter.configto access the global configuration object instead of a checker-specific object.
Refs#5392
The
levelattribute ofBaseCheckerhas been deprecated: everything is nowdisplayed in
--help, all the time.Refs#5392
The
set_optionmethod ofBaseCheckerhas been deprecated. You can usechecker.linter.set_optionto set an option on the global configuration object instead of a checker-specific object.
Refs#5392
The
options_providersattribute ofArgumentsManagerhas been deprecated.Refs#5392
Fix saving of persistent data files in environments where the user's cache
directory and the linted file are on a different drive.
Closes#6394
The
method-cache-max-size-nonechecker will now also checkfunctools.cache.The
configattribute ofPyLinteris now of theargparse.Namespacetype instead ofoptparse.Values.Refs#5392
UnsupportedActionhas been deprecated.Refs#5392
OptionsManagerMixInhas been deprecated.Refs#5392
OptionParserhas been deprecated.Refs#5392
Optionhas been deprecated.Refs#5392
OptionsProviderMixInhas been deprecated.Refs#5392
ConfigurationMixInhas been deprecated.The
option_groupsattribute ofPyLinterhas been deprecated.Refs#5392
get_global_confighas been deprecated. You can now access all global options fromchecker.linter.config.Refs#5392
OptionsManagerMixInhas been replaced withArgumentsManager.ArgumentsManageris consideredprivate API and most methods that were public on
OptionsManagerMixInhave now been deprecated and willbe removed in a future release.
Refs#5392
OptionsProviderMixInhas been replaced withArgumentsProvider.ArgumentsProvideris consideredprivate API and most methods that were public on
OptionsProviderMixInhave now been deprecated and willbe removed in a future release.
Refs#5392
pylint.pyreverse.ASTWalkerhas been removed, as it was only used internally by a single child class.Refs#6712
pyreverse: Resolving and displaying implemented interfaces that are defined by the__implements__attribute has been deprecated and will be removed in 3.0.
Refs#6713
is_class_subscriptable_pep585_with_postponed_evaluation_enabledhas been deprecated.Use
is_postponed_evaluation_enabled(node) and is_node_in_type_annotation_context(node)instead.
Refs#6536
Configuration
📅Schedule: Branch creation - "before 3am on Monday" (UTC), Automerge - At any time (no schedule defined).
🚦Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated byMend Renovate. View repository job loghere.