Fix incorrect tuple annotation detection (#45)

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [0.0.16] - 2023-07-14
+
+- Fixed
+  - Fixed a bug (https://github.com/jsh9/pydoclint/issues/44) where tuple type
+    annotation is incorrectly detected
+- Full diff
+  - https://github.com/jsh9/pydoclint/compare/0.0.15...0.0.16
+
 ## [0.0.15] - 2023-07-10
 
 - Fixed
@@ -8,7 +16,7 @@
   - Fixed false positives when `return` and `raise` statements are in a block
     within a nested function
 - Full diff
-  - https://github.com/jsh9/pydoclint/compare/0.0.15...0.0.15
+  - https://github.com/jsh9/pydoclint/compare/0.0.14...0.0.15
 
 ## [0.0.14] - 2023-07-05
 

pydoclint/utils/return_anno.py

@@ -57,10 +57,11 @@ def decompose(self) -> List[str]:
             return self.putAnnotationInList()
 
     def _isTuple(self) -> bool:
-        return (
-            self.annotation is not None
-            and self.annotation.lower().startswith('tuple[')
-        )
+        try:
+            annoHead = ast.parse(self.annotation).body[0].value.value.id
+            return annoHead in {'tuple', 'Tuple'}
+        except Exception:
+            return False
 
     def putAnnotationInList(self) -> List[str]:
         """Put annotation string in a list"""

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pydoclint
-version = 0.0.15
+version = 0.0.16
 description = A Python docstring linter that checks arguments, returns, yields, and raises sections
 long_description = file: README.md
 long_description_content_type = text/markdown

tests/utils/test_return_anno.py

@@ -0,0 +1,35 @@
+import pytest
+
+from pydoclint.utils.return_anno import ReturnAnnotation
+
+
+@pytest.mark.parametrize(
+    'annotation, expected',
+    [
+        (None, False),
+        ('', False),
+        ('    ', False),
+        ('Tuple[int]', True),
+        ('Tuple[int, str]', True),
+        ('Tuple[int, str, bool]', True),
+        ('Tuple[int, str, None, Dict[str, Any]]', True),
+        ('Tuple[int, ...]', True),
+        ('tuple[int, str]', True),
+        ('Optional[Tuple[int, str]]', False),
+        ('Union[Tuple[int, str], Tuple[int, str]]', False),
+        ('tuple[int, str] | tuple[int, bool]', False),
+        ('tuple[str, str, bool, bool] | None', False),
+        ('tuple[int | str, str | bool, bool | float]', True),
+        ('int', False),
+        ('(int, str, bool)', False),
+        ('tuple(int, str, bool)', False),
+        ('Tuple(int, str, bool)', False),
+        ('tuple(1, 2, 3)', False),
+        ("'tuple[int, int, str]'", True),
+        ('"tuple[int, int, str]"', True),
+        ("'tuple'[int, int, str]", True),
+    ],
+)
+def testIsTuple(annotation: str, expected: bool) -> None:
+    retAnno = ReturnAnnotation(annotation=annotation)
+    assert retAnno._isTuple() == expected