Merge branch 'main' into f-strings-variable

Author: Pierre-Sassoulas

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
           - --remove-duplicate-keys
           - --remove-unused-variables
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.23.1
+    rev: v2.23.3
     hooks:
       - id: pyupgrade
         args: [--py36-plus]
@@ -85,7 +85,7 @@ repos:
         args: []
         require_serial: true
         additional_dependencies: ["types-pkg_resources==0.1.3", "types-toml==0.1.3"]
-        exclude: tests/functional/|tests/input|tests/extensions/data|tests/regrtest_data/|tests/data/|doc/|bin/
+        exclude: tests/functional/|tests/input|tests(/.*)*/data|tests/regrtest_data/|tests/data/|tests(/.*)+/conftest.py|doc/|bin/
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v2.3.2
     hooks:

CONTRIBUTORS.txt

@@ -508,6 +508,7 @@ contributors:
 
 * Maksym Humetskyi (mhumetskyi): contributor
   - Fixed ignored empty functions by similarities checker with "ignore-signatures" option enabled
+  - Ignore function decorators signatures as well by similarities checker with "ignore-signatures" option enabled
 
 * Daniel Dorani (doranid): contributor
 
@@ -529,3 +530,7 @@ contributors:
 * Daniel van Noord (DanielNoord): contributor
 
 * Michal Vasilek: contributor
+
+* Kai Mueller (kasium): contributor
+
+* Sam Vermeiren (PaaEl): contributor

ChangeLog

@@ -12,10 +12,31 @@ Release date: TBA
 ..
   Put bug fixes that should not wait for a new minor version here
 
+* 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).
 
@@ -48,10 +69,6 @@ Release date: TBA
 
   Closes #4365
 
-* ``CodeStyleChecker``
-
-  * Extended ``consider-using-tuple`` check to cover ``in`` comparisons.
-
 * Added ``forgotten-debug-statement``: Emitted when ``breakpoint``, ``pdb.set_trace`` or ``sys.breakpointhook`` calls are found
 
   Closes #3692
@@ -79,6 +96,63 @@ Release date: TBA
   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.
+
 
 What's New in Pylint 2.9.6?
 ===========================

doc/development_guide/contribute.rst

@@ -16,7 +16,8 @@ Please take the time to check if it is already in the issue tracker at
 https://github.com/PyCQA/pylint
 
 If you cannot find it in the tracker, create a new issue there or discuss your
-problem on the [email protected] mailing list or using the discord server https://discord.gg/kFebW799.
+problem on the [email protected] mailing list or using the discord
+server https://discord.gg/Egy6P8AMB5.
 
 The code-quality mailing list is also a nice place to provide feedback about
 Pylint, since it is shared with other tools that aim at improving the quality of

doc/faq.rst

@@ -30,9 +30,7 @@ Everything should be explained on :ref:`installation`.
 2.2 What kind of versioning system does Pylint use?
 ---------------------------------------------------
 
-Pylint uses the git distributed version control system. The URL of the
-repository is: https://github.com/PyCQA/pylint . To get the latest version of
-Pylint from the repository, simply invoke ::
+Pylint uses git. To get the latest version of Pylint from the repository, simply invoke ::
 
     git clone https://github.com/PyCQA/pylint
 
@@ -60,8 +58,7 @@ The supported running environment since Pylint 2.7.X is Python 3.6+.
 -----------------------------------------------------------------
 
 Pylint expects the name of a package or module as its argument. As a
-convenience,
-you can give it a file name if it's possible to guess a module name from
+convenience, you can give it a file name if it's possible to guess a module name from
 the file's path using the python path. Some examples :
 
 "pylint mymodule.py" should always work since the current working
@@ -73,16 +70,16 @@ or if "directory" is in the python path.
 
 "pylint /whatever/directory/mymodule.py" will work if either:
 
-	- "/whatever/directory" is in the python path
+    - "/whatever/directory" is in the python path
 
-	- your cwd is "/whatever/directory"
+    - your cwd is "/whatever/directory"
 
-	- "directory" is a python package and "/whatever" is in the python
+    - "directory" is a python package and "/whatever" is in the python
           path
 
         - "directory" is an implicit namespace package and is in the python path.
 
-	- "directory" is a python package and your cwd is "/whatever" and so
+    - "directory" is a python package and your cwd is "/whatever" and so
           on...
 
 3.2 Where is the persistent data stored to compare between successive runs?
@@ -106,13 +103,13 @@ localized using the following rules:
 3.3 How do I find the option name (for pylintrc) corresponding to a specific command line option?
 --------------------------------------------------------------------------------------------------------
 
-You can always generate a sample pylintrc file with --generate-rcfile
+You can generate a sample pylintrc file with --generate-rcfile
 Every option present on the command line before this will be included in
 the rc file
 
 For example::
 
-	pylint --disable=bare-except,invalid-name --class-rgx='[A-Z][a-z]+' --generate-rcfile
+    pylint --disable=bare-except,invalid-name --class-rgx='[A-Z][a-z]+' --generate-rcfile
 
 3.4 I'd rather not run Pylint from the command line. Can I integrate it with my editor?
 ---------------------------------------------------------------------------------------
@@ -123,12 +120,24 @@ Much probably. Read :ref:`ide-integration`
 4. Message Control
 ==================
 
-4.1 Is it possible to locally disable a particular message?
+4.1 How to disable a particular message?
 -----------------------------------------------------------
 
-Yes, this feature has been added in Pylint 0.11. This may be done by
-adding "#pylint: disable=some-message,another-one" at the desired block level
-or at the end of the desired line of code
+For a single line : Add ``#pylint: disable=some-message,another-one`` at the
+end of the desired line of code. Since Pylint 2.10 you can also use
+``#pylint: disable-next=...`` on the line just above the problem.
+``...`` in the following example is a short hand for the list of
+messages you want to disable.
+
+For larger disable : You can add ``#pylint: disable=...`` at the block level to
+disable for the block. It's possible to enable for the reminder of the block
+with ``#pylint: enable=...`` A block is either a scope (say a function, a module),
+or a multiline statement (try, finally, if statements, for loops).
+`It's currently impossible to disable inside an else block`_
+
+Read :ref:`message-control` for details and examples.
+
+.. _`It's currently impossible to disable inside an else block`: https://github.com/PyCQA/pylint/issues/872
 
 4.2 Is there a way to disable a message for a particular module only?
 ---------------------------------------------------------------------
@@ -137,25 +146,21 @@ Yes, you can disable or enable (globally disabled) messages at the
 module level by adding the corresponding option in a comment at the
 top of the file: ::
 
-	# pylint: disable=wildcard-import, method-hidden
-	# pylint: enable=too-many-lines
+    # pylint: disable=wildcard-import, method-hidden
+    # pylint: enable=too-many-lines
 
 4.3 How can I tell Pylint to never check a given module?
 --------------------------------------------------------
 
-With Pylint < 0.25, add "#pylint: disable-all" at the beginning of the
-module. Pylint 0.26.1 and up have renamed that directive to
-"#pylint: skip-file" (but the first version will be kept for backward
-compatibility).
+Add ``#pylint: skip-file`` at the beginning of the module.
 
 In order to ease finding which modules are ignored an Information-level message
-`file-ignored` is emitted. With recent versions of Pylint, if you use the old
-syntax, an additional `deprecated-disable-all` message is emitted.
+`file-ignored` is emitted.
 
 4.4 Do I have to remember all these numbers?
 --------------------------------------------
 
-No, starting from 0.25.3, you can use symbolic names for messages::
+No, you can use symbolic names for messages::
 
     # pylint: disable=fixme, line-too-long
 
@@ -191,6 +196,10 @@ for not being included as default messages. But most of the disabled
 messages are from the Python 3 porting checker, which is disabled by
 default. It needs special activation with the ``--py3k`` flag.
 
+You can see the plugin you need to explicitly `load in the technical reference`_
+
+.. _`load in the technical reference`: http://pylint.pycqa.org/en/latest/technical_reference/extensions.html?highlight=load%20plugin
+
 4.8 I am using another popular linter alongside pylint. Which messages should I disable to avoid duplicates?
 ------------------------------------------------------------------------------------------------------------
 

doc/release.md

@@ -8,7 +8,7 @@ So, you want to release the `X.Y.Z` version of pylint ?
    pinned to the latest version.
 2. Install the release dependencies `pip3 install pre-commit tbump`
 3. Bump the version by using `tbump X.Y.Z --no-tag --no-push`
-4. Check the result
+4. Check the result (Do `git diff vX.Y.Z-1 ChangeLog doc/whatsnew/` in particular).
 5. Move back to a dev version for pylint with `tbump`:
 
 ```bash

doc/tutorial.rst

@@ -153,7 +153,8 @@ needed a bit more info.  We can see the second line is: ::
 
   "simplecaesar.py:1:0: C0114: Missing module docstring (missing-module-docstring)"
 
-This basically means that line 1 violates a convention ``C0114``.  It's telling me I really should have a docstring.  I agree, but what if I didn't fully understand what rule I violated.  Knowing only that I violated a convention
+This basically means that line 1 violates a convention ``C0114``.  It's telling me I really should have a docstring.
+I agree, but what if I didn't fully understand what rule I violated.  Knowing only that I violated a convention
 isn't much help if I'm a newbie. Another piece of information there is the
 message symbol between parens, ``missing-module-docstring`` here.
 

doc/user_guide/message-control.rst

@@ -39,6 +39,13 @@ The pragma controls can disable / enable:
 
         a, b = ... # pylint: disable=unbalanced-tuple-unpacking
 
+* All the violations on the following line
+
+    .. sourcecode:: python
+
+        # pylint: disable-next=unbalanced-tuple-unpacking
+        a, b = ...
+
 * All the violations in a single scope
 
     .. sourcecode:: python
@@ -179,6 +186,14 @@ Here's an example with all these rules in a single place:
             print(self.bla)
             print(self.blop)
 
+        def meth9(self):
+            """test next line disabling"""
+            # no error
+            # pylint: disable-next=no-member
+            print(self.bla)
+            # error
+            print(self.blop)
+
 
 Detecting useless disables
 --------------------------

doc/whatsnew/2.10.rst

@@ -32,18 +32,33 @@ New checkers
 
   Closes #2507
 
+* Added ``use-sequence-for-iteration``: Emitted when iterating over an in-place defined ``set``.
+
+
 
 Extensions
 ==========
 
 * ``CodeStyleChecker``
 
-  * Extended ``consider-using-tuple`` check to cover ``in`` comparisons.
+  * Limit ``consider-using-tuple`` to be emitted only for in-place defined ``lists``.
+
+  * Emit ``consider-using-tuple`` even if list contains a ``starred`` expression.
 
 
 Other Changes
 =============
 
+* pyreverse now permit to produce colored generated diagram by using the ``colorized`` option.
+
+* Pyreverse - add output in PlantUML format
+
+* ``consider-using-with`` is no longer triggered if a context manager is returned from a function.
+
+* 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 type-hints
 
 * Performance of the Similarity checker has been improved.
@@ -65,3 +80,33 @@ Other Changes
   Closes #3249
   Closes #3608
   Closes #4346
+
+* 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 ``format-string-without-interpolation`` checker: Emitted when formatting is applied to a string without any variables to be replaced
+
+  Closes #4042
+
+* 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.