[pointless-string-statement] Ignore docstrings on py3.12 type aliases (…

…#9269)
pylint-dev · Dec 8, 2023 · 796eae3 · 796eae3
1 parent db6dcfc
commit 796eae3
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 1 deletion.
diff --git a/doc/data/messages/p/pointless-string-statement/related.rst b/doc/data/messages/p/pointless-string-statement/related.rst
@@ -0,0 +1 @@
+- `Discussion thread re: docstrings on assignments <https://discuss.python.org/t/docstrings-for-new-type-aliases-as-defined-in-pep-695/39816>`_
diff --git a/doc/whatsnew/fragments/9268.false_positive b/doc/whatsnew/fragments/9268.false_positive
@@ -0,0 +1,4 @@
+Fixed ``pointless-string-statement`` false positive for docstrings
+on Python 3.12 type aliases.
+
+Closes #9268
diff --git a/pylint/checkers/base/basic_checker.py b/pylint/checkers/base/basic_checker.py
@@ -446,7 +446,9 @@ def visit_expr(self, node: nodes.Expr) -> None:
                     if (
                         sibling is not None
                         and sibling.scope() is scope
-                        and isinstance(sibling, (nodes.Assign, nodes.AnnAssign))
+                        and isinstance(
+                            sibling, (nodes.Assign, nodes.AnnAssign, nodes.TypeAlias)
+                        )
                     ):
                         return
             self.add_message("pointless-string-statement", node=node)

diff --git a/tests/functional/s/statement_without_effect_py312.py b/tests/functional/s/statement_without_effect_py312.py
@@ -0,0 +1,7 @@
+"""Move this into statement_without_effect.py when python 3.12 is minimum."""
+
+type MyTuple = tuple[str, str]
+"""
+Multiline docstring
+for Python3.12 type alias (PEP 695)
+"""
diff --git a/tests/functional/s/statement_without_effect_py312.rc b/tests/functional/s/statement_without_effect_py312.rc
@@ -0,0 +1,2 @@
+[testoptions]
+min_pyver=3.12