summaryrefslogtreecommitdiff
path: root/doc/data
diff options
context:
space:
mode:
authorOllie <46904826+ollie-iterators@users.noreply.github.com>2023-02-13 15:28:04 -0500
committerGitHub <noreply@github.com>2023-02-13 21:28:04 +0100
commitb444ac0081e77cfd662bd8201428528e57a264de (patch)
tree466efa49118da51c61724c16351887bad78aba9e /doc/data
parent84442612f2b5cffeeba63bf3685c36452c849b6e (diff)
downloadpylint-git-b444ac0081e77cfd662bd8201428528e57a264de.tar.gz
[doc] consider ...-alternative-union-syntax, -alias and namedtuple-or-dataclass (#8271)
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'doc/data')
-rw-r--r--doc/data/messages/c/consider-alternative-union-syntax/bad.py3
-rw-r--r--doc/data/messages/c/consider-alternative-union-syntax/details.rst1
-rw-r--r--doc/data/messages/c/consider-alternative-union-syntax/good.py2
-rw-r--r--doc/data/messages/c/consider-alternative-union-syntax/pylintrc2
-rw-r--r--doc/data/messages/c/consider-using-alias/bad.py3
-rw-r--r--doc/data/messages/c/consider-using-alias/details.rst1
-rw-r--r--doc/data/messages/c/consider-using-alias/good.py4
-rw-r--r--doc/data/messages/c/consider-using-alias/pylintrc4
-rw-r--r--doc/data/messages/c/consider-using-namedtuple-or-dataclass/bad.py14
-rw-r--r--doc/data/messages/c/consider-using-namedtuple-or-dataclass/details.rst1
-rw-r--r--doc/data/messages/c/consider-using-namedtuple-or-dataclass/good.py19
-rw-r--r--doc/data/messages/c/consider-using-namedtuple-or-dataclass/pylintrc2
12 files changed, 50 insertions, 6 deletions
diff --git a/doc/data/messages/c/consider-alternative-union-syntax/bad.py b/doc/data/messages/c/consider-alternative-union-syntax/bad.py
new file mode 100644
index 000000000..ea31c5f8a
--- /dev/null
+++ b/doc/data/messages/c/consider-alternative-union-syntax/bad.py
@@ -0,0 +1,3 @@
+from typing import Union
+
+cats: Union[int, str] # [consider-alternative-union-syntax]
diff --git a/doc/data/messages/c/consider-alternative-union-syntax/details.rst b/doc/data/messages/c/consider-alternative-union-syntax/details.rst
deleted file mode 100644
index ab8204529..000000000
--- a/doc/data/messages/c/consider-alternative-union-syntax/details.rst
+++ /dev/null
@@ -1 +0,0 @@
-You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ !
diff --git a/doc/data/messages/c/consider-alternative-union-syntax/good.py b/doc/data/messages/c/consider-alternative-union-syntax/good.py
index c40beb573..a39de7999 100644
--- a/doc/data/messages/c/consider-alternative-union-syntax/good.py
+++ b/doc/data/messages/c/consider-alternative-union-syntax/good.py
@@ -1 +1 @@
-# This is a placeholder for correct code for this message.
+cats: (int | str)
diff --git a/doc/data/messages/c/consider-alternative-union-syntax/pylintrc b/doc/data/messages/c/consider-alternative-union-syntax/pylintrc
new file mode 100644
index 000000000..0c377b2d3
--- /dev/null
+++ b/doc/data/messages/c/consider-alternative-union-syntax/pylintrc
@@ -0,0 +1,2 @@
+[MAIN]
+load-plugins = pylint.extensions.typing
diff --git a/doc/data/messages/c/consider-using-alias/bad.py b/doc/data/messages/c/consider-using-alias/bad.py
new file mode 100644
index 000000000..e3d078593
--- /dev/null
+++ b/doc/data/messages/c/consider-using-alias/bad.py
@@ -0,0 +1,3 @@
+import typing
+
+cats: typing.Dict[str, int] # [consider-using-alias]
diff --git a/doc/data/messages/c/consider-using-alias/details.rst b/doc/data/messages/c/consider-using-alias/details.rst
deleted file mode 100644
index ab8204529..000000000
--- a/doc/data/messages/c/consider-using-alias/details.rst
+++ /dev/null
@@ -1 +0,0 @@
-You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ !
diff --git a/doc/data/messages/c/consider-using-alias/good.py b/doc/data/messages/c/consider-using-alias/good.py
index c40beb573..4277488db 100644
--- a/doc/data/messages/c/consider-using-alias/good.py
+++ b/doc/data/messages/c/consider-using-alias/good.py
@@ -1 +1,3 @@
-# This is a placeholder for correct code for this message.
+import typing
+
+cats: typing.cast(dict[str, int], "string")
diff --git a/doc/data/messages/c/consider-using-alias/pylintrc b/doc/data/messages/c/consider-using-alias/pylintrc
new file mode 100644
index 000000000..038a94c77
--- /dev/null
+++ b/doc/data/messages/c/consider-using-alias/pylintrc
@@ -0,0 +1,4 @@
+[main]
+load-plugins = pylint.extensions.typing
+py-version = 3.7
+runtime-typing=no
diff --git a/doc/data/messages/c/consider-using-namedtuple-or-dataclass/bad.py b/doc/data/messages/c/consider-using-namedtuple-or-dataclass/bad.py
new file mode 100644
index 000000000..d1f3ebab2
--- /dev/null
+++ b/doc/data/messages/c/consider-using-namedtuple-or-dataclass/bad.py
@@ -0,0 +1,14 @@
+FELIDAES = { # [consider-using-namedtuple-or-dataclass]
+ "The queen's cymric, fragile furry friend": {
+ "tail_length_cm": 1,
+ "paws": 4,
+ "eyes": 2,
+ "Elizabethan collar": 1,
+ },
+ "Rackat the red, terror of the sea": {
+ "tail_length_cm": 13,
+ "paws": 3,
+ "eyes": 1,
+ "Red Hat": 1,
+ },
+}
diff --git a/doc/data/messages/c/consider-using-namedtuple-or-dataclass/details.rst b/doc/data/messages/c/consider-using-namedtuple-or-dataclass/details.rst
deleted file mode 100644
index ab8204529..000000000
--- a/doc/data/messages/c/consider-using-namedtuple-or-dataclass/details.rst
+++ /dev/null
@@ -1 +0,0 @@
-You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ !
diff --git a/doc/data/messages/c/consider-using-namedtuple-or-dataclass/good.py b/doc/data/messages/c/consider-using-namedtuple-or-dataclass/good.py
index c40beb573..b13713f59 100644
--- a/doc/data/messages/c/consider-using-namedtuple-or-dataclass/good.py
+++ b/doc/data/messages/c/consider-using-namedtuple-or-dataclass/good.py
@@ -1 +1,18 @@
-# This is a placeholder for correct code for this message.
+from typing import NamedTuple
+
+
+class FelidaeCharacteristics(NamedTuple):
+ tail_length_cm: int
+ paws: int
+ eyes: int
+ hat: str | None
+
+
+FELIDAES = {
+ "The queen's cymric, fragile furry friend": FelidaeCharacteristics(
+ tail_length_cm=1, paws=4, eyes=2, hat="Elizabethan collar"
+ ),
+ "Rackat the red, terror of the sea": FelidaeCharacteristics(
+ tail_length_cm=21, paws=3, eyes=1, hat="Red Hat"
+ ),
+}
diff --git a/doc/data/messages/c/consider-using-namedtuple-or-dataclass/pylintrc b/doc/data/messages/c/consider-using-namedtuple-or-dataclass/pylintrc
new file mode 100644
index 000000000..8663ab085
--- /dev/null
+++ b/doc/data/messages/c/consider-using-namedtuple-or-dataclass/pylintrc
@@ -0,0 +1,2 @@
+[MAIN]
+load-plugins=pylint.extensions.code_style