DOC: The `value` parameter of `pandas.Timedelta` can also accept float

[5j9]

Pandas version checks

• I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.Timedelta.html#pandas.Timedelta

Documentation problem

It currently states:

pandas/pandas/_libs/tslibs/timedeltas.pyx

Line 1867 in 2a10e04

value : Timedelta, timedelta, np.timedelta64, str, or int

There is no float.

Suggested fix for documentation

Add float, to accepted types.

There already exists a code branch for float values so this should not be a problem:

pandas/pandas/_libs/tslibs/timedeltas.pyx

Line 2056 in 2a10e04

elif is_integer_object(value) or is_float_object(value):

[ZKaoChi]

Hello! I tested this method and I found that although pd.Timedelta can accept float values numbers, the result only takes the integer part. For example

print(pd.Timedelta(3651015))
0 days 00:00:00.003651015
print(pd.Timedelta(365.1015))
0 days 00:00:00.000000365

[5j9]

@ZKaoChi Hi! Thanks for looking into this.

The default unit value is ns, and I think that's the lowest resolution supported. So that might be expected for the default ns unit. But if you pass any other unit, the fractional part will matter:

In [11]: pd.Timedelta(3.5, 'hours')
Out[11]: Timedelta('0 days 03:30:00')

In [12]: pd.Timedelta(3, 'hours')
Out[12]: Timedelta('0 days 03:00:00')

In [15]: pd.Timedelta(3, 'W')
Out[15]: Timedelta('21 days 00:00:00')

In [16]: pd.Timedelta(3.5, 'W')
Out[16]: Timedelta('24 days 12:00:00')

In [17]: pd.Timedelta(3.5, 'microseconds')
Out[17]: Timedelta('0 days 00:00:00.000003500')

In [18]: pd.Timedelta(3, 'microseconds')
Out[18]: Timedelta('0 days 00:00:00.000003')

[yuanx749]

Agreed. datetime.timedelta also accepts float, and Timedelta is the pandas equivalent of it.

[ZKaoChi]

@5j9 Thanks for your correction! It was my oversight not to notice the units of the data.

[ZKaoChi]

I'm new and I wanna solve this issue, but my pre-commit.ci - pr was failed because of cython-lint. Coule anyone please teache me how to deal with it?