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.

Sign up for GitHub

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

Jump to bottom

[pointless-string-statement] Ignore docstrings on py3.12 type aliases #9269

Merged
merged 2 commits into from
Dec 8, 2023
Merged

[pointless-string-statement] Ignore docstrings on py3.12 type aliases #9269

merged 2 commits into from
Dec 8, 2023

Conversation

jacobtylerwalls
Copy link
Member

Type of Changes

Type
βœ“ πŸ› Bug fix

Description

Closes #9268

@jacobtylerwalls jacobtylerwalls added False Positive 🦟 A message is emitted but nothing is wrong with the code backport maintenance/3.3.x labels Nov 28, 2023
@jacobtylerwalls jacobtylerwalls added this to the 3.0.3 milestone Nov 28, 2023
@codecov Codecov
Copy link

codecov bot commented Nov 28, 2023 •
edited
Loading

Codecov Report

Merging #9269 (e89686c) into main (37081fd) will increase coverage by 0.00%.
Report is 2 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #9269    /-   ##
=======================================
  Coverage   95.81%   95.81%           
=======================================
  Files         173      173           
  Lines       18761    18762     1     
=======================================
  Hits        17975    17976     1     
  Misses        786      786
Files Coverage Ξ”
pylint/checkers/base/basic_checker.py 98.08% <ΓΈ> (ΓΈ)

... and 1 file with indirect coverage changes

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@jacobtylerwalls jacobtylerwalls marked this pull request as draft November 28, 2023 14:01
@jacobtylerwalls
Copy link
Member Author

Setting to draft pending decision on issue.

@jacobtylerwalls jacobtylerwalls marked this pull request as ready for review December 6, 2023 16:07
DanielNoord
DanielNoord reviewed Dec 6, 2023
View reviewed changes
Copy link
Collaborator

@DanielNoord DanielNoord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM!

Could you add a link to the Discuss topic in the documentation of pointless-statement? You can find it under the doc directory.

Pierre-Sassoulas
Pierre-Sassoulas previously approved these changes Dec 6, 2023
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AS Daniel said a link to the discussion would be useful otherwise LGTM. Thank you for initiating and folllowing up on the python.org discussion.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 8, 2023

πŸ€– Effect of this PR on checked open source code: πŸ€–

Effect on black:
The following messages are now emitted:

  1. deprecated-typing-alias:
    'typing.Tuple' is deprecated, use 'tuple' instead
    https://github.com/psf/black/blob/e4ae213f06050e7f76ebcf01578c002e412dafdc/src/black/brackets.py#L63
  2. deprecated-typing-alias:
    'typing.Tuple' is deprecated, use 'tuple' instead
    https://github.com/psf/black/blob/e4ae213f06050e7f76ebcf01578c002e412dafdc/src/black/handle_ipynb_magics.py#L67
  3. deprecated-typing-alias:
    'typing.Tuple' is deprecated, use 'tuple' instead
    https://github.com/psf/black/blob/e4ae213f06050e7f76ebcf01578c002e412dafdc/src/black/handle_ipynb_magics.py#L189
  4. deprecated-typing-alias:
    'typing.Tuple' is deprecated, use 'tuple' instead
    https://github.com/psf/black/blob/e4ae213f06050e7f76ebcf01578c002e412dafdc/src/blackd/__init__.py#L193
  5. deprecated-typing-alias:
    'typing.Tuple' is deprecated, use 'tuple' instead
    https://github.com/psf/black/blob/e4ae213f06050e7f76ebcf01578c002e412dafdc/src/blib2to3/pgen2/tokenize.py#L199

Effect on music21:
The following messages are now emitted:

  1. invalid-name:
    Attribute name "id" doesn't conform to '[a-z_][A-Za-z0-9_]{2,30}$' pattern
    https://github.com/cuthbertLab/music21/blob/a938a8c8c74f21ceec5a99a1998d96c00d5f77e9/music21/base.py#L579

The following messages are no longer emitted:

  1. invalid-name:
    Attribute name "id" doesn't conform to '[a-z_][A-Za-z0-9_]{2,30}$' pattern
    https://github.com/cuthbertLab/music21/blob/a938a8c8c74f21ceec5a99a1998d96c00d5f77e9/music21/prebase.py#L293
  2. redefined-variable-type:
    Redefinition of n type from music21.note.Note to music21.note.GeneralNote
    https://github.com/cuthbertLab/music21/blob/a938a8c8c74f21ceec5a99a1998d96c00d5f77e9/music21/abcFormat/translate.py#L381

Effect on pytest:
The following messages are now emitted:

  1. deprecated-typing-alias:
    'typing.Callable' is deprecated, use 'collections.abc.Callable' instead
    https://github.com/pytest-dev/pytest/blob/d1675646f2d5f218cbaae5b88f3b5dee5a5061ca/src/_pytest/python_api.py#L797
  2. deprecated-typing-alias:
    'typing.Callable' is deprecated, use 'collections.abc.Callable' instead
    https://github.com/pytest-dev/pytest/blob/d1675646f2d5f218cbaae5b88f3b5dee5a5061ca/src/_pytest/_py/path.py#L148
  3. deprecated-typing-alias:
    'typing.Callable' is deprecated, use 'collections.abc.Callable' instead
    https://github.com/pytest-dev/pytest/blob/d1675646f2d5f218cbaae5b88f3b5dee5a5061ca/src/_pytest/_io/pprint.py#L163

The following messages are no longer emitted:

  1. deprecated-typing-alias:
    'typing.Tuple' is deprecated, use 'tuple' instead
    https://github.com/pytest-dev/pytest/blob/d1675646f2d5f218cbaae5b88f3b5dee5a5061ca/src/_pytest/doctest.py#L218
  2. deprecated-typing-alias:
    'typing.Tuple' is deprecated, use 'tuple' instead
    https://github.com/pytest-dev/pytest/blob/d1675646f2d5f218cbaae5b88f3b5dee5a5061ca/src/_pytest/runner.py#L257
  3. deprecated-typing-alias:
    'typing.Callable' is deprecated, use 'collections.abc.Callable' instead
    https://github.com/pytest-dev/pytest/blob/d1675646f2d5f218cbaae5b88f3b5dee5a5061ca/src/_pytest/compat.py#L105

This comment was generated for commit e89686c

@jacobtylerwalls jacobtylerwalls merged commit 796eae3 into pylint-dev:main Dec 8, 2023
44 checks passed
@jacobtylerwalls jacobtylerwalls deleted the pointless-string-type-alias branch December 8, 2023 12:06
github-actions bot pushed a commit that referenced this pull request Dec 8, 2023
@jacobtylerwalls @github-actions
[pointless-string-statement] Ignore docstrings on py3.12 type aliases (…
ed5a45e 
…#9269)

(cherry picked from commit 796eae3)
@github-actions github-actions bot mentioned this pull request Dec 8, 2023
Merged
jacobtylerwalls added a commit that referenced this pull request Dec 8, 2023
@github-actions @jacobtylerwalls
[pointless-string-statement] Ignore docstrings on py3.12 type aliases (…
d0d5c91 
…#9269) (#9287)

(cherry picked from commit 796eae3)

Co-authored-by: Jacob Walls <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DanielNoord DanielNoord DanielNoord approved these changes

@Pierre-Sassoulas Pierre-Sassoulas Pierre-Sassoulas left review comments

Assignees
No one assigned
Labels
Backported False Positive 🦟 A message is emitted but nothing is wrong with the code python 3.12
Projects
None yet
Milestone
3.0.3
Development

Successfully merging this pull request may close these issues.

Invalid pointless-string-statement for docstrings for Python 3.12 type-aliases (PEP 695)
3 participants
@jacobtylerwalls @Pierre-Sassoulas @DanielNoord