Skip to content

TYP: Many typing constructs are invariant #46535

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

TYP: Many typing constructs are invariant #46535

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e8fb98
TYP: Many typing constructs are invariant
twoertwein Mar 27, 2022
dc95914
remove Sequence
twoertwein Mar 28, 2022
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
23 changes: 16 additions & 7 deletions pandas/_typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,15 @@
npt: Any = None


# Functions that take Dict/Mapping/List/Sequence/Callable as arguments can be
# tricky to type:
# - keys of Dict and Mapping cannot be sub-classes (Mapping allows them for values)
# - elements of List cannot be sub-classes (Sequence does)
# - input arguments of Callable cannot be sub-classes
# If you want to allow any type and it's sub-classes in the above cases, you can
# use TypeVar("AllowsSubclasses", bound=class); List[AllowsSubclasses]
HashableT = TypeVar("HashableT", bound=Hashable)

# array-like

ArrayLike = Union["ExtensionArray", np.ndarray]
Expand Down Expand Up @@ -127,19 +136,19 @@
Dtype = Union["ExtensionDtype", NpDtype]
AstypeArg = Union["ExtensionDtype", "npt.DTypeLike"]
# DtypeArg specifies all allowable dtypes in a functions its dtype argument
DtypeArg = Union[Dtype, Dict[Hashable, Dtype]]
DtypeArg = Union[Dtype, Dict[HashableT, Dtype]]
DtypeObj = Union[np.dtype, "ExtensionDtype"]

# converters
ConvertersArg = Dict[Hashable, Callable[[Dtype], Dtype]]
ConvertersArg = Dict[HashableT, Callable[[Dtype], Dtype]]

# parse_dates
ParseDatesArg = Union[
bool, List[Hashable], List[List[Hashable]], Dict[Hashable, List[Hashable]]
bool, List[HashableT], List[List[HashableT]], Dict[HashableT, List[Hashable]]
]

# For functions like rename that convert one label to another
Renamer = Union[Mapping[Hashable, Any], Callable[[Hashable], Hashable]]
Renamer = Union[Mapping[HashableT, Any], Callable[[HashableT], Hashable]]

# to maintain type information across generic functions and parametrization
T = TypeVar("T")
Expand All @@ -156,7 +165,7 @@

# types of `func` kwarg for DataFrame.aggregate and Series.aggregate
AggFuncTypeBase = Union[Callable, str]
AggFuncTypeDict = Dict[Hashable, Union[AggFuncTypeBase, List[AggFuncTypeBase]]]
AggFuncTypeDict = Dict[HashableT, Union[AggFuncTypeBase, List[AggFuncTypeBase]]]
AggFuncType = Union[
AggFuncTypeBase,
List[AggFuncTypeBase],
Expand Down Expand Up @@ -260,10 +269,10 @@ def closed(self) -> bool:
FormattersType = Union[
List[Callable], Tuple[Callable, ...], Mapping[Union[str, int], Callable]
]
ColspaceType = Mapping[Hashable, Union[str, int]]
ColspaceType = Mapping[HashableT, Union[str, int]]
FloatFormatType = Union[str, Callable, "EngFormatter"]
ColspaceArgType = Union[
str, int, Sequence[Union[str, int]], Mapping[Hashable, Union[str, int]]
str, int, Sequence[Union[str, int]], Mapping[HashableT, Union[str, int]]
]

# Arguments for fillna()
Expand Down