Skip to content

Releases: pylint-dev/pylint

2.13.0

24 Mar 22:15
Compare
Choose a tag to compare
  • Add missing dunder methods to unexpected-special-method-signature check.

  • No longer emit no-member in for loops that reference self if the binary operation that
    started the for loop uses a self that is encapsulated in tuples or lists.

    Ref pylint-dev/astroid#1360
    Closes #4826

  • Output better error message if unsupported file formats are used with pyreverse.

    Closes #5950

  • Fix pyreverse diagrams type hinting for classmethods and staticmethods.

  • Fix pyreverse diagrams type hinting for methods returning None.

  • Fix matching --notes options that end in a non-word character.

    Closes #5840

  • Updated the position of messages for class and function defintions to no longer cover
    the complete definition. Only the def or class + the name of the class/function
    are covered.

    Closes #5466

  • using-f-string-in-unsupported-version and using-final-decorator-in-unsupported-version msgids
    were renamed from W1601 and W1602 to W2601 and W2602. Disabling using these msgids will break.
    This is done in order to restore consistency with the already existing msgids for apply-builtin and
    basestring-builtin from the now deleted python 3K+ checker. There is now a check that we're not using
    existing msgids or symbols from deleted checkers.

    Closes #5729

  • The line numbering for messages related to function arguments is now more accurate. This can
    require some message disables to be relocated to updated positions.

  • Add --recursive option to allow recursive discovery of all modules and packages in subtree. Running pylint with
    --recursive=y option will check all discovered .py files and packages found inside subtree of directory provided
    as parameter to pylint.

    Closes #352

  • Add modified-iterating-list, modified-iterating-dict and modified-iterating-set,
    emitted when items are added to or removed from respectively a list, dictionary or
    set being iterated through.

    Closes #5348

  • Fix false-negative for assignment-from-none checker using list.sort() method.

    closes #5722

  • New extension import-private-name: indicate imports of external private packages
    and objects (prefixed with _). It can be loaded using load-plugins=pylint.extensions.private_import.

    Closes #5463

  • Fixed crash from arguments-differ and arguments-renamed when methods were
    defined outside the top level of a class.

    Closes #5648

  • Removed the deprecated check_docs extension. You can use the docparams checker
    to get the checks previously included in check_docs.

    Closes #5322

  • Added a testutil extra require to the packaging, as gitpython should not be a dependency
    all the time but is still required to use the primer helper code in pylint.testutil. You can
    install it with pip install pylint[testutil].

    Closes #5486

  • Reinstated checks from the python3 checker that are still useful for python 3
    (eq-without-hash). This is now in the pylint.extensions.eq_without_hash optional
    extension.

    Closes #5025

  • Fixed an issue where ungrouped-imports could not be disabled without raising
    useless-suppression.

    Ref #2366

  • Added several checkers to deal with unicode security issues
    (see Trojan Sources <https://trojansource.codes/>_ and
    PEP 672 <https://www.python.org/dev/peps/pep-0672/>_ for details) that also
    concern the readability of the code. In detail the following checks were added:

    • bad-file-encoding checks that the file is encoded in UTF-8 as suggested by
      PEP8 <https://www.python.org/dev/peps/pep-0008/#id20>.
      UTF-16 and UTF-32 are not supported by Python <https://bugs.python.org/issue1503789>

      at the moment. If this ever changes
      invalid-unicode-codec checks that they aren't used, to allow for backwards
      compatibility.

    • bidirectional-unicode checks for bidirectional unicode characters that
      could make code execution different than what the user expects.

    • invalid-character-backspace, invalid-character-carriage-return,
      invalid-character-sub, invalid-character-esc,
      invalid-character-zero-width-space and invalid-character-nul
      to check for possibly harmful unescaped characters.

    Closes #5281

  • Use the tomli package instead of toml to parse .toml files.

Closes #5885

  • Fix false positive - Allow unpacking of self in a subclass of typing.NamedTuple.

Closes #5312

  • Fixed false negative unpacking-non-sequence when value is an empty list.

Closes #5707

  • Better warning messages for useless else or elif when a function returns early.

    Closes #5614

  • Fixed false positive consider-using-dict-comprehension when creating a dict
    using a list of tuples where key AND value vary depending on the same condition.

    Closes #5588

  • Fixed false positive for global-variable-undefined when global is used with a class name

    Closes #3088

  • Fixed false positive for unused-variable when a nonlocal name is assigned as part of a multi-name assignment.

    Closes #3781

  • Fixed a crash in unspecified-encoding checker when providing None
    to the mode argument of an open() call.

    Closes #5731

  • Fixed a crash involving a NewType named with an f-string.

    Closes #5770
    Ref pylint-dev/astroid#1400

  • Improved bad-open-mode message when providing None to the mode
    argument of an open() call.

    Closes #5733

  • Added lru-cache-decorating-method checker with checks for the use of functools.lru_cache
    on class methods. This is unrecommended as it creates memory leaks by never letting the instance
    getting garbage collected.

    Closes #5670

  • Fixed crash with recursion error for inference of class attributes that referenced
    the class itself.

    Closes #5408
    Ref pylint-dev/astroid#1392

  • Fixed false positive for unused-argument when a method overridden in a subclass
    does nothing with the value of a keyword-only argument.

    Closes #5771
    Ref pylint-dev/astroid#1382

  • The issue template for crashes is now created for crashes which were previously not covered
    by this mechanism.

    Closes #5668

  • Rewrote checker for non-ascii-name.
    It now ensures all Python names are ASCII and also properly
    checks the names of imports (non-ascii-module-import) as
    well as file names (non-ascii-file-name) and emits their respective new warnings.

    Non ASCII characters could be homoglyphs (look alike characters) and hard to
    enter on a non specialized keyboard.
    See Confusable Characters in PEP 672 <https://www.python.org/dev/peps/pep-0672/#confusable-characters-in-identifiers>_

  • When run in parallel mode pylint now pickles the data passed to subprocesses with
    the dill package. The dill package has therefore been added as a dependency.

  • An astroid issue where symlinks were not being taken into account
    was fixed

    Closes #1470
    Closes #3499
    Closes #4302
    Closes #4798
    Closes #5081

  • Fix a crash in unused-private-member checker when analyzing code using
    type(self) in bound methods.

    Closes #5569

  • Optimize parsing of long lines when missing-final-newline is enabled.

    Closes #5724

  • Fix false positives for used-before-assignment from using named
    expressions in a ternary operator test and using that expression as
    a call argument.

    Closes #5177, #5212

  • Fix false positive for undefined-variable when namedtuple class
    attributes are used as return annotations.

    Closes #5568

  • Fix false negative for undefined-variable and related variable messages
    when the same undefined variable is used as a type annotation and is
    accessed multiple times, or is used as a default argument to a function.

    Closes #5399

  • Pyreverse - add output in mermaidjs format

  • Emit used-before-assignment instead of undefined-variable when attempting
    to access unused type annotations.

    Closes #5713

  • Added confidence level CONTROL_FLOW for warnings relying on assumptions
    about control flow.

  • used-before-assignment now considers that assignments in a try block
    may not have occurred when the except or finally blocks are executed.

    Closes #85, #2615

  • Fixed false negative for used-before-assignment when a conditional
    or context manager intervened before the try statement that suggested
    it might fail.

    Closes #4045

  • Fixed false negative for used-before-assignment in finally blocks
    if an except handler did not define the assignment that might have failed
    in the try block.

  • Fixed extremely long processing of long lines with comma's.

    Closes #5483

  • Fixed crash on properties and inherited class methods when comparing them for
    equality against an empty dict.

    Closes #5646

  • Fixed a false positive for assigning-non-slot when the slotted class
    defined __setattr__.

    Closes #3793

  • Fixed a false positive for invalid-class-object when the object
    being assigned to the __class__ attribute is uninferable.

  • Fixed false positive for used-before-assignment with self-referential type
    annotation in conditional statements within class methods.

    Closes #5499

  • Add checker redefined-slots-in-subclass: Emitted when a slot is redefined in a subclass.

    Closes #5617

  • Fixed false positive for global-variable-not-assigned when the del statement is used

    Closes #5333

  • By default, pylint does no longer take files starting with .# into account. Those are
    considered emacs file locks. See
    https://www.gnu.org/software/emacs/manual/html_node/elisp/File-Lock...

Read more

v2.12.2

03 Dec 17:31
Compare
Choose a tag to compare
  • Fixed a false positive for unused-import where everything was not analyzed properly inside typing guards.

  • Fixed a false-positive regression for used-before-assignment for
    typed variables in the body of class methods that reference the same class

    Closes #5342

  • Specified that the ignore-paths option considers "" to represent a
    windows directory delimiter instead of a regular expression escape
    character.

  • Fixed a crash with the ignore-paths option when invoking the option
    via the command line.

    Closes #5437

  • Fixed handling of Sphinx-style parameter docstrings with asterisks. These
    should be escaped with by prepending a "".

    Closes #5406

  • Add endLine and endColumn keys to output of JSONReporter.

    Closes #5380

  • Fixed handling of Google-style parameter specifications where descriptions
    are on the line following the parameter name. These were generating
    false positives for missing-param-doc.

    Closes #5452

  • Fix false negative for consider-iterating-dictionary during membership checks encapsulated in iterables
    or not in checks

    Closes #5323

  • unused-import now check all ancestors for typing guards

    Closes #5316

2.12.1

25 Nov 16:03
Compare
Choose a tag to compare
  • Require Python 3.6.2 to run pylint.

    Closes #5065

2.12.0

25 Nov 14:29
Compare
Choose a tag to compare
  • Upgrade astroid to 2.9.0

    Closes #4982

  • Add ability to add end_line and end_column to the --msg-template option.
    With the standard TextReporter this will add the line and column number of the
    end of a node to the output of Pylint. If these numbers are unknown, they are represented
    by an empty string.

  • Introduced primer tests and a configuration tests framework. The helper classes available in
    pylint/testutil/ are still unstable and might be modified in the near future.

    Closes #4412 #5287

  • Fix install graphiz message which isn't needed for puml output format.

  • MessageTest of the unittest testutil now requires the confidence attribute
    to match the expected value. If none is provided it is set to UNDEFINED.

  • add_message of the unittest testutil now actually handles the col_offset parameter
    and allows it to be checked against actual output in a test.

  • Fix a crash in the check_elif extensions where an undetected if in a comprehension
    with an if statement within a f-string resulted in an out of range error. The checker no
    longer relies on counting if statements anymore and uses known if statements locations instead.
    It should not crash on badly parsed if statements anymore.

  • Fix simplify-boolean-expression when condition can be inferred as False.

    Closes #5200

  • Fix exception when pyreverse parses property function of a class.

  • The functional testutils now accept end_lineno and end_column. Expected
    output files without these will trigger a DeprecationWarning. Expected output files
    can be easily updated with the python tests/test_functional.py --update-functional-output command.

  • The functional testutils now correctly check the distinction betweeen HIGH and
    UNDEFINED confidence. Expected output files without defiend confidence levels will now
    trigger a DeprecationWarning. Expected output files can be easily updated with the
    python tests/test_functional.py --update-functional-output command.

  • The functional test runner now supports the option min_pyver_end_position to control on which python
    versions the end_lineno and end_column attributes should be checked. The default value is 3.8.

  • Fix accept-no-yields-doc and accept-no-return-doc not allowing missing yield or
    return documentation when a docstring is partially correct

    Closes #5223

  • Add an optional extension consider-using-any-or-all : Emitted when a for loop only
    produces a boolean and could be replaced by any or all using a generator. Also suggests
    a suitable any or all statement.

    Closes #5008

  • Properly identify parameters with no documentation and add new message called missing-any-param-doc

    Closes #3799

  • Add checkers overridden-final-method & subclassed-final-class

    Closes #3197

  • Fixed protected-access for accessing of attributes and methods of inner classes

    Closes #3066

  • Added support for ModuleNotFoundError (import-error and no-name-in-module).
    ModuleNotFoundError inherits from ImportError and was added in Python 3.6

  • undefined-variable now correctly flags variables which only receive a type annotations
    and never get assigned a value

    Closes #5140

  • undefined-variable now correctly considers the line numbering and order of classes
    used in metaclass declarations

    Closes #4031

  • used-before-assignment now correctly considers references to classes as type annotation
    or default values in first-level methods

    Closes #3771

  • undefined-variable and unused-variable now correctly trigger for assignment expressions
    in functions defaults

    Fixes part of #3688

  • undefined-variable now correctly triggers for assignment expressions in if ... else statements
    This includes a basic form of control flow inference for if ... else statements using
    constant boolean values

    Closes #3688

  • Added the --enable-all-extensions command line option. It will load all available extensions
    which can be listed by running --list-extensions

  • Fix bug with importing namespace packages with relative imports

    Closes #2967 and #5131

  • Improve and flatten unused-wildcard-import message

    Closes #3859

  • In length checker, len-as-condition has been renamed as
    use-implicit-booleaness-not-len in order to be consistent with
    use-implicit-booleaness-not-comparison.

  • Created new UnsupportedVersionChecker checker class that includes checks for features
    not supported by all versions indicated by a py-version.

    • Added using-f-string-in-unsupported-version checker. Issued when py-version
      is set to a version that does not support f-strings (< 3.6)
  • Fix useless-super-delegation false positive when default keyword argument is a variable.

  • Properly emit duplicate-key when Enum members are duplicate dictionary keys

    Closes #5150

  • Use py-version setting for alternative union syntax check (PEP 604),
    instead of the Python interpreter version.

  • Subclasses of dict are regarded as reversible by the bad-reversed-sequence checker
    (Python 3.8 onwards).

    Closes #4981

  • Support configuring mixin class pattern via mixin-class-rgx

  • Added new checker use-implicit-booleaness-not-comparison: Emitted when
    collection literal comparison is being used to check for emptiness.

    Closes #4774

  • mising-param-doc now correctly parses asterisks for variable length and
    keyword parameters

    Closes #3733

  • mising-param-doc now correctly handles Numpy parameter documentation without
    explicit typing

    Closes #5222

  • pylint no longer crashes when checking assignment expressions within if-statements

    Closes #5178

  • Update ``literal-comparison``` checker to ignore tuple literals

    Closes #3031

  • Normalize the input to the ignore-paths option to allow both Posix and
    Windows paths

    Closes #5194

  • Fix double emitting of not-callable on inferrable properties

    Closes #4426

  • self-cls-assignment now also considers tuple assignment

  • Fix missing-function-docstring not being able to check __init__ and other
    magic methods even if the no-docstring-rgx setting was set to do so

  • Added using-final-decorator-in-unsupported-version checker. Issued when py-version
    is set to a version that does not support typing.final (< 3.8)

  • Added configuration option exclude-too-few-public-methods to allow excluding
    classes from the min-public-methods checker.

    Closes #3370

  • The --jobs parameter now fallbacks to 1 if the host operating system does not
    have functioning shared semaphore implementation.

    Closes #5216

  • Fix crash for unused-private-member when checking private members on __class__

    Closes #5261

  • Crashes when a list is encountered in a toml configuration do not happen anymore.

    Closes #4580

  • Moved misplaced-comparison-constant to its own extension comparison_placement.
    This checker was opinionated and now no longer a default. It can be reactived by adding
    pylint.extensions.comparison_placement to load-plugins in your config.

    Closes #1064

  • A new bad-configuration-section checker was added that will emit for misplaced option
    in pylint's top level namespace for toml configuration. Top-level dictionaries or option defined
    in the wrong section will still silently not be taken into account, which is tracked in a
    follow-up issue.

    Follow-up in #5259

  • Fix crash for protected-access on (outer) class traversal

  • Added new checker useless-with-lock to find incorrect usage of with statement and threading module locks.
    Emitted when with threading.Lock(): is used instead of with lock_instance:.

    Closes #5208

  • Make yn validator case insensitive, to allow for True and False in config files.

  • Fix crash on open() calls when the mode argument is not a simple string.

    Partially closes #5321

  • Inheriting from a class that implements __class_getitem__ no longer raises inherit-non-class.

  • Pyreverse - Add the project root directory to sys.path

    Closes #2479

  • Don't emit consider-using-f-string if py-version is set to Python < 3.6.
    f-strings were added in Python 3.6

    Closes #5019

  • Fix regression for unspecified-encoding with pathlib.Path.read_text()

    Closes #5029

  • Don't emit consider-using-f-string if the variables to be interpolated include a backslash

  • Fixed false positive for cell-var-from-loop when variable is used as the default
    value for a keyword-only parameter.

    Closes #5012

  • Fix false-positive undefined-variable with Lambda, IfExp, and
    assignment expression.

  • Fix false-positive useless-suppression for wrong-import-order

    Closes #2366

  • Fixed toml dependency issue

    Closes #5066

  • Fix false-positive useless-suppression for line-too-long

    Closes #4212

  • Fixed invalid-name not checking parameters of overwritten base object methods

    Closes #3614

  • Fixed crash in consider-using-f-string if format is not called

    Closes #5058

  • Fix crash with AssignAttr in if TYPE_CHECKING blocks.

    Closes #5111

  • Improve node information for invalid-name on function argument.

  • Prevent return type checkers being called on functions with ellipses as body

    Closes #4736

  • Add is_sys_guard and is_typing_guard helper functions from astroid
    to pylint.checkers.utils.

  • Fix regression on ClassDef inference

    Closes #5030
    Clos...

Read more

v2.11.1

16 Sep 20:54
Compare
Choose a tag to compare
  • unspecified-encoding now checks the encoding of pathlib.Path() correctly

    Closes #5017

v2.11.0

16 Sep 16:26
Compare
Choose a tag to compare
  • The python3 porting mode checker and it's py3k option were removed. You can still find it in older pylint
    versions.

  • raising-bad-type is now properly emitted when raising a string

  • Added new extension SetMembershipChecker with use-set-for-membership check:
    Emitted when using an in-place defined list or tuple to do a membership test. sets are better optimized for that.

    Closes #4776

  • Added py-version config key (if [MASTER] section). Used for version dependant checks.
    Will default to whatever Python version pylint is executed with.

  • CodeStyleChecker

    • Added consider-using-assignment-expr: Emitted when an assignment is directly followed by an if statement
      and both can be combined by using an assignment expression :=. Requires Python 3.8

      Closes #4862

  • Added consider-using-f-string: Emitted when .format() or '%' is being used to format a string.

    Closes #3592

  • Fix false positive for consider-using-with if a context manager is assigned to a
    variable in different paths of control flow (e. g. if-else clause).

    Closes #4751

  • https is now prefered in the documentation and http://pylint.pycqa.org correctly redirect to https://pylint.pycqa.org

    Closes #3802

  • Fix false positive for function-redefined for simple type annotations

    Closes #4936

  • Fix false positive for protected-access if a protected member is used in type hints of function definitions

  • Fix false positive dict-iter-missing-items for dictionaries only using tuples as keys

    Closes #3282

  • The unspecified-encoding checker now also checks calls to pathlib.Path().read_text()
    and pathlib.Path().write_text()

    Closes #4945

  • Fix false positive superfluous-parens for tuples created with inner tuples

    Closes #4907

  • Fix false positive unused-private-member for accessing attributes in a class using cls

    Closes #4849

  • Fix false positive unused-private-member for private staticmethods accessed in classmethods.

    Closes #4849

  • Extended consider-using-in check to work for attribute access.

  • Setting min-similarity-lines to 0 now makes the similarty checker stop checking for duplicate code

    Closes #4901

  • Fix a bug where pylint complained if the cache's parent directory does not exist

    Closes #4900

  • The global-variable-not-assigned checker now catches global variables that are never reassigned in a
    local scope and catches (reassigned) functions

    Closes #1375
    Closes #330

  • Fix false positives for invalid-all-format that are lists or tuples at runtime

    Closes #4711

  • Fix no-self-use and docparams extension for async functions and methods.

  • Add documentation for pyreverse and symilar

    Closes #4616

  • Non symbolic messages with the wrong capitalisation now correctly trigger use-symbolic-message-instead

    Closes #5000

  • The consider-iterating-dictionary checker now also considers membership checks

    Closes #4069

  • The invalid-name message is now more detailed when using multiple naming style regexes.

v2.10.2

21 Aug 17:30
Compare
Choose a tag to compare
  • We now use platformdirs instead of appdirs since the latter is not maintained.

    Closes #4886

  • Fix a crash in the checker raising shallow-copy-environ when failing to infer
    on copy.copy

    Closes #4891

v2.10.1

21 Aug 04:28
Compare
Choose a tag to compare
  • pylint does not crash when PYLINT_HOME does not exist.

    Closes #4883

v2.10.0

20 Aug 21:00
Compare
Choose a tag to compare
  • pyreverse: add option to produce colored output.

    Closes #4488

  • pyreverse: add output in PlantUML format.

    Closes #4498

  • consider-using-with is no longer triggered if a context manager is returned from a function.

    Closes #4748

  • pylint does not crash with a traceback anymore when a file is problematic. It
    creates a template text file for opening an issue on the bug tracker instead.
    The linting can go on for other non problematic files instead of being impossible.

  • pyreverse: Show class has-a relationships inferred from the type-hint

    Closes #4744

  • Fixed a crash when importing beyond the top level package during import-error
    message creation

    Closes #4775

  • Added ignored-parents option to the design checker to ignore specific
    classes from the too-many-ancestors check (R0901).

    Partially closes #3057

  • Added unspecified-encoding: Emitted when open() is called without specifying an encoding

    Closes #3826

  • Improved the Similarity checker performance. Fix issue with --min-similarity-lines used with --jobs.

    Close #4120
    Close #4118

  • Don't emit no-member error if guarded behind if statement.

    Ref #1162
    Closes #1990
    Closes #4168

  • The default for PYLINTHOME is now the standard XDG_CACHE_HOME, and pylint now uses appdirs.

    Closes #3878

  • Added use-list-literal: Emitted when list() is called with no arguments instead of using []

    Closes #4365

  • Added use-dict-literal: Emitted when dict() is called with no arguments instead of using {}

    Closes #4365

  • Added optional extension consider-ternary-expression: Emitted whenever a variable is assigned in both branches of an if/else block.

    Closes #4366

  • Added optional extension while-used: Emitted whenever a while loop is used.

    Closes #4367

  • Added forgotten-debug-statement: Emitted when breakpoint, pdb.set_trace or sys.breakpointhook calls are found

    Closes #3692

  • Fix false-positive of unused-private-member when using nested functions in a class

    Closes #4673

  • Fix crash for unused-private-member that occurred with nested attributes.

    Closes #4755

  • Fix a false positive for unused-private-member with class names

    Closes #4681

  • Fix false positives for superfluous-parens with walrus operator, ternary operator and inside list comprehension.

    Closes #2818
    Closes #3249
    Closes #3608
    Closes #4346

  • Added format-string-without-interpolation checker: Emitted when formatting is applied to a string without any variables to be replaced

    Closes #4042

  • Refactor of --list-msgs & --list-msgs-enabled: both options now show whether messages are emittable with the current interpreter.

    Closes #4778

  • Fix false negative for used-before-assignment when the variable is assigned
    in an exception handler, but used outside of the handler.

    Closes #626

  • Added disable-next option: allows using # pylint: disable-next=msgid to disable a message for the following line

    Closes #1682

  • Added redundant-u-string-prefix checker: Emitted when the u prefix is added to a string

    Closes #4102

  • Fixed cell-var-from-loop checker: handle cell variables in comprehensions within functions,
    and function default argument expressions. Also handle basic variable shadowing.

    Closes #2846
    Closes #3107

  • Fixed bug with cell-var-from-loop checker: it no longer has false negatives when
    both unused-variable and used-before-assignment are disabled.

  • Fix false postive for invalid-all-format if the list or tuple builtin functions are used

    Closes #4711

  • Config files can now contain environment variables

    Closes #3839

  • Fix false-positive used-before-assignment with an assignment expression in a Return node

    Closes #4828

  • Added use-sequence-for-iteration: Emitted when iterating over an in-place defined set.

  • CodeStyleChecker

    • Limit consider-using-tuple to be emitted only for in-place defined lists.

    • Emit consider-using-tuple even if list contains a starred expression.

  • Ignore decorators lines by similarities checker when ignore signatures flag enabled

    Closes #4839

  • Allow true and false values in pylintrc for better compatibility with toml config.

  • Class methods' signatures are ignored the same way as functions' with similarities "ignore-signatures" option enabled

    Closes #4653

  • Improve performance when inferring Call nodes, by utilizing caching.

  • Improve error message for invalid-metaclass when the node is an Instance.

v2.9.6

28 Jul 18:51
Compare
Choose a tag to compare
  • Fix a false positive undefined-variable when variable name in decoration
    matches function argument

    Closes #3791