Skip to content

Fix Tuple Special Cases from Docstrings #17440

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

Closed
wants to merge 6 commits into from
+4 −1
Closed

Fix Tuple Special Cases from Docstrings #17440

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4f6fab6
update regex
InvincibleRMC Jun 25, 2024
9f20e36
update test cases
InvincibleRMC Jun 25, 2024
74bbda4
Merge branch 'master' into fix-tuple-special-cases-docstrings
InvincibleRMC Jun 29, 2024
ab83a68
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 29, 2024
c914089
Merge branch 'master' into fix-tuple-special-cases-docstrings
InvincibleRMC Jul 20, 2024
bae6136
Merge branch 'master' into fix-tuple-special-cases-docstrings
InvincibleRMC Dec 2, 2024
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
2 changes: 1 addition & 1 deletion mypy/stubdoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
Sig: _TypeAlias = Tuple[str, str]


_TYPE_RE: Final = re.compile(r"^[a-zA-Z_][\w\[\], .\"\']*(\.[a-zA-Z_][\w\[\], ]*)*$")
_TYPE_RE: Final = re.compile(r"^[a-zA-Z_][\w\[\], ().\"\']*(\.[a-zA-Z_][\w\[\], ]*)*$")
Copy link

@offensive-vk offensive-vk Jul 1, 2024

Choose a reason for hiding this comment

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

So basically this giant regex matches these:

  • a
  • abc
  • a[1], b(2).c
  • a_b.c_d
  • a.b.c

_ARG_NAME_RE: Final = re.compile(r"\**[A-Za-z_][A-Za-z0-9_]*$")


Expand Down
3 changes: 3 additions & 0 deletions mypy/test/teststubgen.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1386,6 +1386,9 @@ def test_is_valid_type(self) -> None:
assert is_valid_type("List[int]")
assert is_valid_type("Dict[str, int]")
assert is_valid_type("None")
assert is_valid_type("tuple[int]")
assert is_valid_type("tuple[()]")
assert is_valid_type("tuple[int, ...]")
assert is_valid_type("Literal[26]")
assert is_valid_type("Literal[0x1A]")
assert is_valid_type('Literal["hello world"]')
Expand Down