Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release branch 3.2.0 #9619

Merged
merged 3 commits into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,9 @@ jobs:
. venv/bin/activate
cd doc
pre-commit run --hook-stage push sphinx-generated-doc --all-files || {
echo "git diff:" ; \
git diff ; \
echo "Make sure that there are no modifications locally when launching 'make html'" ; \
echo "End of 'git diff'" ; \
echo "Make sure that 'make html' succeed without any modifications locally." ; \
exit 1; \
}
14 changes: 10 additions & 4 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ contributors:
- Glenn Matthews <glenn@e-dad.net>:
* autogenerated documentation for optional extensions,
* bug fixes and enhancements for docparams (née check_docs) extension
- crazybolillo <antonio@zoftko.com>
- Vlad Temian <vladtemian@gmail.com>: redundant-unittest-assert and the JSON reporter.
- Julien Jehannet <julien.jehannet@logilab.fr>
- Boris Feld <lothiraldan@gmail.com>
Expand Down Expand Up @@ -157,7 +158,6 @@ contributors:
* Added new useless-return checker,
* Added new try-except-raise checker
- theirix <theirix@gmail.com>
- crazybolillo <antonio@zoftko.com>
- Téo Bouvard <teobouvard@gmail.com>
- Stavros Ntentos <133706+stdedos@users.noreply.github.com>
- Nicolas Boulenguez <nicolas@debian.org>
Expand All @@ -174,6 +174,7 @@ contributors:
- Andreas Freimuth <andreas.freimuth@united-bits.de>: fix indentation checking with tabs
- Alexandru Coman <fcoman@bitdefender.com>
- jpkotta <jpkotta@gmail.com>
- Thomas Grainger <tagrain@gmail.com>
- Takahide Nojima <nozzy123nozzy@gmail.com>
- Taewon D. Kim <kimt33@mcmaster.ca>
- Sneaky Pete <sneakypete81@gmail.com>
Expand Down Expand Up @@ -254,14 +255,15 @@ contributors:
- Wes Turner <westurner@google.com> (Google): added new check 'inconsistent-quotes'
- Tyler Thieding <tyler@thieding.com>
- Tobias Hernstig <30827238+thernstig@users.noreply.github.com>
- Thomas Grainger <tagrain@gmail.com>
- Sviatoslav Sydorenko <wk@sydorenko.org.ua>
- Smixi <sismixx@hotmail.fr>
- Simu Toni <simutoni@gmail.com>
- Sergei Lebedev <185856+superbobry@users.noreply.github.com>
- Scott Worley <scottworley@scottworley.com>
- Saugat Pachhai <suagatchhetri@outlook.com>
- Samuel FORESTIER <HorlogeSkynet@users.noreply.github.com>
- Rémi Cardona <remi.cardona@polyconseil.fr>
- Ryan Ozawa <ryan.ozawa21@gmail.com>
- Raphael Gaschignard <raphael@makeleaps.com>
- Ram Rachum <ram@rachum.com> (cool-RR)
- Radostin Stoyanov <rst0git@users.noreply.github.com>
Expand All @@ -281,6 +283,7 @@ contributors:
- Maarten ter Huurne <maarten@treewalker.org>
- Lefteris Karapetsas <lefteris@refu.co>
- LCD 47 <lcd047@gmail.com>
- Jérome Perrin <perrinjerome@gmail.com>
- Justin Li <justinnhli@gmail.com>
- John Kirkham <jakirkham@gmail.com>
- Jens H. Nielsen <Jens.Nielsen@microsoft.com>
Expand Down Expand Up @@ -351,6 +354,7 @@ contributors:
- cherryblossom <31467609+cherryblossom000@users.noreply.github.com>
- bluesheeptoken <louis.fruleux1@gmail.com>
- anatoly techtonik <techtonik@gmail.com>
- akirchhoff-modular <github-work@kirchhoff.digital>
- agutole <toldo_carp@hotmail.com>
- Zeckie <49095968+Zeckie@users.noreply.github.com>
- Zeb Nicholls <zebedee.nicholls@climate-energy-college.org>
Expand All @@ -373,6 +377,7 @@ contributors:
- Victor Jiajunsu <16359131+jiajunsu@users.noreply.github.com>
- ViRuSTriNiTy <cradle-of-mail@gmx.de>
- Val Lorentz <progval+github@progval.net>
- Ulrich Eckhardt <UlrichEckhardt@users.noreply.github.com>
- Udi Fuchs <udifuchs@gmail.com>
- Trevor Bekolay <tbekolay@gmail.com>
* Added --list-msgs-enabled command
Expand Down Expand Up @@ -404,7 +409,6 @@ contributors:
- Santiago Castro <bryant@montevideo.com.uy>
- Samuel Freilich <sfreilich@google.com> (sfreilich)
- Sam Vermeiren <88253337+PaaEl@users.noreply.github.com>
- Ryan Ozawa <ryan.ozawa21@gmail.com>
- Ryan McGuire <ryan@enigmacurry.com>
- Ry4an Brase <ry4an-hg@ry4an.org>
- Ruro <ruro.ruro@ya.ru>
Expand Down Expand Up @@ -488,7 +492,6 @@ contributors:
- Kayran Schmidt <59456929+yumasheta@users.noreply.github.com>
- Karthik Nadig <kanadig@microsoft.com>
- Jürgen Hermann <jh@web.de>
- Jérome Perrin <perrinjerome@gmail.com>
- Josselin Feist <josselin@trailofbits.com>
- Jonathan Kotta <KottaJonathan@JohnDeere.com>
- John Paraskevopoulos <io.paraskev@gmail.com>: add 'differing-param-doc' and 'differing-type-doc'
Expand All @@ -505,6 +508,7 @@ contributors:
- Jared Garst <cultofjared@gmail.com>
- Jared Deckard <jared.deckard@gmail.com>
- Janne Rönkkö <jannero@users.noreply.github.com>
- Jamie Scott <jamie@jami.org.uk>
- James Sinclair <james@nurfherder.com>
- James M. Allen <james.m.allen@gmail.com>
- James Lingard <jchl@aristanetworks.com>
Expand Down Expand Up @@ -598,9 +602,11 @@ contributors:
- Alok Singh <8325708+alok@users.noreply.github.com>
- Allan Chandler <95424144+allanc65@users.noreply.github.com> (allanc65)
* Fixed issue 5452, false positive missing-param-doc for multi-line Google-style params
- Alex Waygood <alex.waygood@gmail.com>
- Alex Mor <5476113+nashcontrol@users.noreply.github.com>
- Alex Jurkiewicz <alex@jurkiewi.cz>
- Alex Hearn <alex.d.hearn@gmail.com>
- Alex Fortin <alex.antoine.fortin@gmail.com>
- Aleksander Mamla <alek.mamla@gmail.com>
- Alan Evangelista <alanoe@linux.vnet.ibm.com>
- Alan Chan <achan961117@gmail.com>
Expand Down
77 changes: 76 additions & 1 deletion doc/whatsnew/3/3.2/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,80 @@
Summary -- Release highlights
=============================


.. towncrier release notes start

What's new in Pylint 3.2.0?
---------------------------
Release date: 2024-05-14


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

- Understand `six.PY2` and `six.PY3` for conditional imports.

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

- A new `github` reporter has been added. This reporter returns the output of `pylint` in a format that
Github can use to automatically annotate code. Use it with `pylint --output-format=github` on your Github Workflows.

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



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

- Add check ``possibly-used-before-assignment`` when relying on names after an ``if/else``
switch when one branch failed to define the name, raise, or return.

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

- Checks for generators that use contextmanagers that don't handle cleanup properly.
Is meant to raise visibility on the case that a generator is not fully exhausted and the contextmanager is not cleaned up properly.
A contextmanager must yield a non-constant value and not handle cleanup for GeneratorExit.
The using generator must attempt to use the yielded context value `with x() as y` and not just `with x()`.

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



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

- If and Try nodes are now checked for useless return statements as well.

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

- Fix false negative for ``property-with-parameters`` in the case of parameters which are ``positional-only``, ``keyword-only``, ``variadic positional`` or ``variadic keyword``.

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

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

pylint now understands the ``@overload`` decorator return values better.

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

Performance Improvements
------------------------


- Ignored modules are now not checked at all, instead of being checked and then
ignored. This should speed up the analysis of large codebases which have
ignored modules.

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


- ImportChecker's logic has been modified to avoid context files when possible. This makes it possible
to cache module searches on astroid and reduce execution times.

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

- An internal check for ``trailing-comma-tuple`` being enabled for a file or not is now
done once per file instead of once for each token.

Refs #9608. (`#9608 <https://github.com/pylint-dev/pylint/issues/9608>`_)
16 changes: 16 additions & 0 deletions doc/whatsnew/3/3.3/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

***************************
What's New in Pylint 3.3
***************************

.. toctree::
:maxdepth: 2

:Release:3.3
:Date: TBA

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


.. towncrier release notes start
1 change: 1 addition & 0 deletions doc/whatsnew/3/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This is the full list of change in pylint 3.x minors, by categories.
.. toctree::
:maxdepth: 2

3.3/index
3.2/index
3.1/index
3.0/index
4 changes: 0 additions & 4 deletions doc/whatsnew/fragments/1727.new_check

This file was deleted.

6 changes: 0 additions & 6 deletions doc/whatsnew/fragments/2832.new_check

This file was deleted.

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

This file was deleted.

4 changes: 0 additions & 4 deletions doc/whatsnew/fragments/9310.performance

This file was deleted.

5 changes: 0 additions & 5 deletions doc/whatsnew/fragments/9442.other

This file was deleted.

4 changes: 0 additions & 4 deletions doc/whatsnew/fragments/9443.feature

This file was deleted.

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

This file was deleted.

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

This file was deleted.

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

This file was deleted.

4 changes: 0 additions & 4 deletions doc/whatsnew/fragments/9608.performance

This file was deleted.

4 changes: 2 additions & 2 deletions examples/pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ ignore-patterns=^\.#
# List of module names for which member attributes should not be checked and
# will not be imported (useful for modules/projects where namespaces are
# manipulated during runtime and thus existing member attributes cannot be
# deduced by static analysis). It supports qualified module names, as well
# as Unix pattern matching.
# deduced by static analysis). It supports qualified module names, as well as
# Unix pattern matching.
ignored-modules=

# Python code to execute, usually for sys.path manipulation such as
Expand Down
10 changes: 5 additions & 5 deletions examples/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ ignore = ["CVS"]
# file locks
ignore-patterns = ["^\\.#"]

# List of module names for which member attributes should not be checked and
# will not be imported (useful for modules/projects where namespaces are
# manipulated during runtime and thus existing member attributes cannot be
# deduced by static analysis). It supports qualified module names, as well
# as Unix pattern matching.
# List of module names for which member attributes should not be checked and will
# not be imported (useful for modules/projects where namespaces are manipulated
# during runtime and thus existing member attributes cannot be deduced by static
# analysis). It supports qualified module names, as well as Unix pattern
# matching.
# ignored-modules =

# Python code to execute, usually for sys.path manipulation such as
Expand Down
2 changes: 1 addition & 1 deletion pylint/__pkginfo__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

from __future__ import annotations

__version__ = "3.2.0-dev0"
__version__ = "3.3.0-dev0"


def get_numversion_from_version(v: str) -> tuple[int, int, int]:
Expand Down
4 changes: 4 additions & 0 deletions script/.contributors_aliases.json
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,10 @@
"mails": ["pedro@algarvio.me"],
"name": "Pedro Algarvio"
},
"perrinjerome@gmail.com": {
"mails": ["jerome@nexedi.com", "perrinjerome@gmail.com"],
"name": "Jérome Perrin"
},
"peter.kolbus@gmail.com": {
"comment": " (Garmin)",
"mails": ["peter.kolbus@gmail.com", "peter.kolbus@garmin.com"],
Expand Down
2 changes: 1 addition & 1 deletion tbump.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
github_url = "https://github.com/pylint-dev/pylint"

[version]
current = "3.2.0-dev0"
current = "3.3.0-dev0"
regex = '''
^(?P<major>0|[1-9]\d*)
\.
Expand Down
4 changes: 2 additions & 2 deletions towncrier.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.towncrier]
version = "3.2.0"
version = "3.3.0"
directory = "doc/whatsnew/fragments"
filename = "doc/whatsnew/3/3.2/index.rst"
filename = "doc/whatsnew/3/3.3/index.rst"
template = "doc/whatsnew/fragments/_template.rst"
issue_format = "`#{issue} <https://github.com/pylint-dev/pylint/issues/{issue}>`_"
wrap = false # doesn't wrap links correctly if beginning with indentation
Expand Down
Loading