Skip to content

Improve operator.mod #6463

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 3 commits into from
Closed

Improve operator.mod #6463

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb33390
Improve operator.mod
AlexWaygood Dec 1, 2021
74c160d
Account for existence of `__rmod__`
AlexWaygood Dec 1, 2021
e58d237
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 1, 2021
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
17 changes: 16 additions & 1 deletion stdlib/_operator.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ from typing_extensions import ParamSpec, SupportsIndex, final
_R = TypeVar("_R")
_T = TypeVar("_T")
_T_co = TypeVar("_T_co", covariant=True)
_T_contra = TypeVar("_T_contra", contravariant=True)
_K = TypeVar("_K")
_V = TypeVar("_V")
_P = ParamSpec("_P")
Expand All @@ -35,6 +36,15 @@ class _SupportsNeg(Protocol[_T_co]):
class _SupportsPos(Protocol[_T_co]):
def __pos__(self) -> _T_co: ...

# We cannot specify the return type in _SupportsMod & _SupportsRMod
# because whether __mod__ or __rmod__ is called first depends
# on whether the rhs operand is a subclass of the lhs operand.
class _SupportsMod(Protocol[_T_contra]):
def __mod__(self, x: _T_contra) -> Any: ...

class _SupportsRMod(Protocol[_T_contra]):
def __rmod__(self, x: _T_contra) -> Any: ...

# Different to _typeshed.SupportsLessThan
class _SupportsLT(Protocol):
def __lt__(self, other: Any) -> Any: ...
Expand All @@ -48,6 +58,8 @@ class _SupportsLE(Protocol):
class _SupportsGE(Protocol):
def __ge__(self, other: Any) -> Any: ...

# We have to use a union as we get false-positive errors
# if `lt`/`le`/`gt`/`ge` do not all have the same signature.
_SupportsComparison = Union[_SupportsLE, _SupportsGE, _SupportsGT, _SupportsLT]

def lt(__a: _SupportsComparison, __b: _SupportsComparison) -> Any: ...
Expand All @@ -68,7 +80,10 @@ def index(__a: SupportsIndex) -> int: ...
def inv(__a: _SupportsInversion[_T_co]) -> _T_co: ...
def invert(__a: _SupportsInversion[_T_co]) -> _T_co: ...
def lshift(__a: Any, __b: Any) -> Any: ...
def mod(__a: Any, __b: Any) -> Any: ...
@overload
def mod(__a: _SupportsMod[_T_contra], __b: _T_contra) -> Any: ...
@overload
def mod(__a: _T_contra, __b: _SupportsRMod[_T_contra]) -> Any: ...
def mul(__a: Any, __b: Any) -> Any: ...
def matmul(__a: Any, __b: Any) -> Any: ...
def neg(__a: _SupportsNeg[_T_co]) -> _T_co: ...
Expand Down