Skip to content

TYP: timedeltas.pyi #40766

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.

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

Merged
merged 3 commits into from
Apr 14, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
106 changes: 106 additions & 0 deletions pandas/_libs/tslibs/timedeltas.pyi
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
from datetime import timedelta
from time import struct_time
Copy link
Member

Choose a reason for hiding this comment

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

unused

from typing import (
AnyStr,
Copy link
Member

Choose a reason for hiding this comment

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

unused

ClassVar,
Optional,
Copy link
Member

Choose a reason for hiding this comment

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

unused

SupportsAbs,
Copy link
Member

Choose a reason for hiding this comment

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

unused

Tuple,
Type,
TypeVar,
Union,
Copy link
Member

Choose a reason for hiding this comment

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

unused

overload,
)

import numpy as np

from pandas._libs.tslibs import (
NaT,
Copy link
Member

Choose a reason for hiding this comment

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

unused

NaTType,
Tick,
)

_S = TypeVar("_S")


def ints_to_pytimedelta(
arr: np.ndarray, # const int64_t[:]
box: bool = ...,
) -> np.ndarray: ... # np.ndarray[object]


def array_to_timedelta64(
values: np.ndarray, # ndarray[object]
unit: str | None = ...,
errors: str = ...,
) -> np.ndarray: ... # np.ndarray[m8ns]


def parse_timedelta_unit(unit: str | None) -> str: ...


def delta_to_nanoseconds(delta: Tick | np.timedelta64 | timedelta | int) -> int: ...


class Timedelta(timedelta):
min: ClassVar[Timedelta]
max: ClassVar[Timedelta]
resolution: ClassVar[Timedelta]
value: int # np.int64

def __new__(
cls: Type[_S],
value=...,
unit=...,
**kwargs
) -> _S | NaTType: ...

@property
def days(self) -> int: ...
@property
def seconds(self) -> int: ...
@property
def microseconds(self) -> int: ...
def total_seconds(self) -> float: ...

def to_pytimedelta(self) -> timedelta: ...
def to_timedelta64(self) -> np.timedelta64: ...

@property
def asm8(self) -> np.timedelta64: ...

# TODO: round/floor/ceil could return NaT?
def round(self: _S, freq) -> _S: ...
def floor(self: _S, freq) -> _S: ...
def ceil(self: _S, freq) -> _S: ...

@property
def resolution_string(self) -> str: ...

def __add__(self, other: timedelta) -> timedelta: ...
def __radd__(self, other: timedelta) -> timedelta: ...
def __sub__(self, other: timedelta) -> timedelta: ...
def __rsub__(self, other: timedelta) -> timedelta: ...
def __neg__(self) -> timedelta: ...
def __pos__(self) -> timedelta: ...
def __abs__(self) -> timedelta: ...
def __mul__(self, other: float) -> timedelta: ...
def __rmul__(self, other: float) -> timedelta: ...

@overload
def __floordiv__(self, other: timedelta) -> int: ...
@overload
def __floordiv__(self, other: int) -> timedelta: ...

@overload
def __truediv__(self, other: timedelta) -> float: ...
@overload
def __truediv__(self, other: float) -> timedelta: ...
def __mod__(self, other: timedelta) -> timedelta: ...
def __divmod__(self, other: timedelta) -> Tuple[int, timedelta]: ...

def __le__(self, other: timedelta) -> bool: ...
def __lt__(self, other: timedelta) -> bool: ...
def __ge__(self, other: timedelta) -> bool: ...
def __gt__(self, other: timedelta) -> bool: ...
def __hash__(self) -> int: ...
7 changes: 7 additions & 0 deletions pandas/core/reshape/tile.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
"""
Quantilization functions and related stuff
"""
from typing import (
Any,
Callable,
)

import numpy as np

from pandas._libs import (
Expand Down Expand Up @@ -550,6 +555,8 @@ def _format_labels(
""" based on the dtype, return our labels """
closed = "right" if right else "left"

formatter: Callable[[Any], Timestamp] | Callable[[Any], Timedelta]

if is_datetime64tz_dtype(dtype):
formatter = lambda x: Timestamp(x, tz=dtype.tz)
adjust = lambda x: x - Timedelta("1ns")
Expand Down
7 changes: 6 additions & 1 deletion pandas/core/tools/timedeltas.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@
import numpy as np

from pandas._libs import lib
from pandas._libs.tslibs import NaT
from pandas._libs.tslibs import (
NaT,
NaTType,
)
from pandas._libs.tslibs.timedeltas import (
Timedelta,
parse_timedelta_unit,
Expand Down Expand Up @@ -141,6 +144,8 @@ def to_timedelta(arg, unit=None, errors="raise"):

def _coerce_scalar_to_timedelta_type(r, unit="ns", errors="raise"):
"""Convert string 'r' to a timedelta object."""
result: Timedelta | NaTType # TODO: alias?

try:
result = Timedelta(r, unit)
except ValueError:
Expand Down