Skip to content

Commit

Permalink
Bump pylint to 3.1.0, update changelog
Browse files Browse the repository at this point in the history
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
  • Loading branch information
Pierre-Sassoulas and jacobtylerwalls committed Feb 25, 2024
1 parent c954636 commit 053c2c3
Show file tree
Hide file tree
Showing 20 changed files with 118 additions and 55 deletions.
108 changes: 107 additions & 1 deletion doc/whatsnew/3/3.1/index.rst
Expand Up @@ -7,10 +7,116 @@
:maxdepth: 2

:Release:3.1
:Date: TBA
:Date: 2024-02-25

Summary -- Release highlights
=============================

Two new checks--``use-yield-from``, ``deprecated-attribute``--
and a smattering of bug fixes.

.. towncrier release notes start
What's new in Pylint 3.1.0?
---------------------------
Release date: 2024-02-25


New Features
------------

- Skip ``consider-using-join`` check for non-empty separators if an ``suggest-join-with-non-empty-separator`` option is set to ``no``.

Closes #8701 (`#8701 <https://github.com/pylint-dev/pylint/issues/8701>`_)

- Discover ``.pyi`` files when linting.

These can be ignored with the ``ignore-patterns`` setting.

Closes #9097 (`#9097 <https://github.com/pylint-dev/pylint/issues/9097>`_)

- Check ``TypeAlias`` and ``TypeVar`` (PEP 695) nodes for ``invalid-name``.

Refs #9196 (`#9196 <https://github.com/pylint-dev/pylint/issues/9196>`_)

- Support for resolving external toml files named pylintrc.toml and .pylintrc.toml.

Closes #9228 (`#9228 <https://github.com/pylint-dev/pylint/issues/9228>`_)

- Check for `.clear`, `.discard`, `.pop` and `remove` methods being called on a set while it is being iterated over.

Closes #9334 (`#9334 <https://github.com/pylint-dev/pylint/issues/9334>`_)



New Checks
----------

- New message `use-yield-from` added to the refactoring checker. This message is emitted when yielding from a loop can be replaced by `yield from`.

Closes #9229. (`#9229 <https://github.com/pylint-dev/pylint/issues/9229>`_)

- Added a ``deprecated-attribute`` message to check deprecated attributes in the stdlib.

Closes #8855 (`#8855 <https://github.com/pylint-dev/pylint/issues/8855>`_)


False Positives Fixed
---------------------

- Fixed false positive for ``inherit-non-class`` for generic Protocols.

Closes #9106 (`#9106 <https://github.com/pylint-dev/pylint/issues/9106>`_)

- Exempt ``TypedDict`` from ``typing_extensions`` from ``too-many-ancestor`` checks.

Refs #9167 (`#9167 <https://github.com/pylint-dev/pylint/issues/9167>`_)



False Negatives Fixed
---------------------

- Extend broad-exception-raised and broad-exception-caught to except*.

Closes #8827 (`#8827 <https://github.com/pylint-dev/pylint/issues/8827>`_)

- Fix a false-negative for unnecessary if blocks using a different than expected ordering of arguments.

Closes #8947. (`#8947 <https://github.com/pylint-dev/pylint/issues/8947>`_)



Other Bug Fixes
---------------

- Improve the message provided for wrong-import-order check. Instead of the import statement ("import x"), the message now specifies the import that is out of order and which imports should come after it. As reported in the issue, this is particularly helpful if there are multiple imports on a single line that do not follow the PEP8 convention.

The message will report imports as follows:
For "import X", it will report "(standard/third party/first party/local) import X"
For "import X.Y" and "from X import Y", it will report "(standard/third party/first party/local) import X.Y"
The import category is specified to provide explanation as to why pylint has issued the message and guidence to the developer on how to fix the problem.

Closes #8808 (`#8808 <https://github.com/pylint-dev/pylint/issues/8808>`_)



Other Changes
-------------

- Print how many files were checked in verbose mode.

Closes #8935 (`#8935 <https://github.com/pylint-dev/pylint/issues/8935>`_)

- Fix a crash when an enum class which is also decorated with a ``dataclasses.dataclass`` decorator is defined.

Closes #9100 (`#9100 <https://github.com/pylint-dev/pylint/issues/9100>`_)



Internal Changes
----------------

- Update astroid version to 3.1.0.

Refs #9457 (`#9457 <https://github.com/pylint-dev/pylint/issues/9457>`_)
3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/8701.feature

This file was deleted.

8 changes: 0 additions & 8 deletions doc/whatsnew/fragments/8808.bugfix

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/8827.false_negative

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/8855.new_check

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/8935.other

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/8947.false_negative

This file was deleted.

5 changes: 0 additions & 5 deletions doc/whatsnew/fragments/9097.feature

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9100.other

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9106.false_positive

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9167.false_positive

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9196.feature

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9228.feature

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9229.feature

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9334.feature

This file was deleted.

3 changes: 0 additions & 3 deletions doc/whatsnew/fragments/9457.internal

This file was deleted.

5 changes: 5 additions & 0 deletions examples/pylintrc
Expand Up @@ -468,6 +468,11 @@ max-nested-blocks=5
# printed.
never-returning-functions=sys.exit,argparse.parse_error

# Let 'consider-using-join' be raised when the separator to join on would be
# non-empty (resulting in expected fixes of the type: ``"- " + " -
# ".join(items)``)
suggest-join-with-non-empty-separator=yes


[REPORTS]

Expand Down
4 changes: 4 additions & 0 deletions examples/pyproject.toml
Expand Up @@ -394,6 +394,10 @@ max-nested-blocks = 5
# considered as an explicit return statement and no message will be printed.
never-returning-functions = ["sys.exit", "argparse.parse_error"]

# Let 'consider-using-join' be raised when the separator to join on would be non-
# empty (resulting in expected fixes of the type: ``"- " + " - ".join(items)``)
suggest-join-with-non-empty-separator = true

[tool.pylint.reports]
# Python expression which should return a score less than or equal to 10. You
# have access to the variables 'fatal', 'error', 'warning', 'refactor',
Expand Down
2 changes: 1 addition & 1 deletion pylint/__pkginfo__.py
Expand Up @@ -9,7 +9,7 @@

from __future__ import annotations

__version__ = "3.1.0-dev0"
__version__ = "3.1.0"


def get_numversion_from_version(v: str) -> tuple[int, int, int]:
Expand Down
2 changes: 1 addition & 1 deletion tbump.toml
@@ -1,7 +1,7 @@
github_url = "https://github.com/pylint-dev/pylint"

[version]
current = "3.1.0-dev0"
current = "3.1.0"
regex = '''
^(?P<major>0|[1-9]\d*)
\.
Expand Down

0 comments on commit 053c2c3

Please sign in to comment.