Repository navigation
regex group class should return AnyStr | None instead of AnyStr | Any #10526
Description
Every time when using the regex library I'm stumbling over this when extracting the group text from a regex match. From what I read the function returns the match as an AnyStr which corresponds to the type variable of the Match[AnyStr]. But it also returns Any. I don't possibly know how to return anything else from this method.
If a match was successful the group method will do one of the following:
- The last text matched by the capturing group (either by name or number) as an AnyStr type
(?P<groupname>.+) Noneif the capturing group was part of a regex branch that did not match(\d+)|(\w+)- The Error
IndexError("no such group")if a group was referred that is not part of the pattern.
This is the method and here is the comment that argues similar.
The same problem can be observed in the following places:
- group(self, __group)
- group(self, __group1, __group2, *groups)
- groups(self)
- groupdict(self)
- __getitem__(self)
Note: I'm not a professional and I don't even know if this is the right repository for this issue, but I didn't find any better guidance on where to post this.
The advantages of the AnyStr | None annotation would be:
- null coalescion:
text: str = match.group(1) or "default" - branching:
if match.group(1): print("Match group 1 has matched something")
Activity
AlexWaygood commentedon Aug 1, 2023
This is the right repository for this issue :)
Just to confirm -- your issue title mentions "regex", and there's a third-party library called
regexwhich you can install from PyPI, but all of your links point to the stdlibremodule. Does your issue concern the third-partyregexlibrary or the stdlibremodule? We have stubs for both in typeshed :)AlexWaygood commentedon Aug 1, 2023
Assuming you are discussing the
restdlib module rather than theregexthird-party package, I'm afraid this issue is probably a duplicate of #9465. (We tried fixing it in #9482, but as you can see from the mypy_primer output on that PR, the fix would have been hugely disruptive, so we could never have merged it.)cn-ml commentedon Aug 3, 2023
Sorry, I didn't know about this ambiguity. I was referring to the stdlib
remodule.cn-ml commentedon Aug 3, 2023
I didn't find any issues like mine when I searched the tracker, but it seems i missed some.
Can anybody explain to me what the lower issue here is? In the diff from the
mypy_primerI'm seeing a whole lot oferror messages. In code that seems like someone has forgot to check if the regex group actually produced a matching capturing group or
None. To me this very much seems like the issue is not in theremodule, but the code that uses it in that way. I think types are used to clearly and precisely define what a method behaves like, whichAnydefinitely prevents.On the worst case scenario the
remodule returning any will likely introduce a lot more bugs into user code than a precise type will produce in false positives. I'd much rathercastor check None in all false positives than keep anAnytype in such a frequently used piece of stdlib code.KotlinIsland commentedon Jan 18, 2024
Basedmypy works correctly with these cases: