pandas.Timedelta — pandas 2.2.3 documentation (original) (raw)

class pandas.Timedelta(value=, unit=None, **kwargs)#

Represents a duration, the difference between two dates or times.

Timedelta is the pandas equivalent of python’s datetime.timedeltaand is interchangeable with it in most cases.

Parameters:

valueTimedelta, timedelta, np.timedelta64, str, or int

unitstr, default ‘ns’

Denote the unit of the input, if input is an integer.

Possible values:

• ‘W’, or ‘D’
• ‘days’, or ‘day’
• ‘hours’, ‘hour’, ‘hr’, or ‘h’
• ‘minutes’, ‘minute’, ‘min’, or ‘m’
• ‘seconds’, ‘second’, ‘sec’, or ‘s’
• ‘milliseconds’, ‘millisecond’, ‘millis’, ‘milli’, or ‘ms’
• ‘microseconds’, ‘microsecond’, ‘micros’, ‘micro’, or ‘us’
• ‘nanoseconds’, ‘nanosecond’, ‘nanos’, ‘nano’, or ‘ns’.

Deprecated since version 2.2.0: Values H, T, S, L, U, and N are deprecated in favour of the values h, min, s, ms, us, and ns.

**kwargs

Available kwargs: {days, seconds, microseconds, milliseconds, minutes, hours, weeks}. Values for construction in compat with datetime.timedelta. Numpy ints and floats will be coerced to python ints and floats.

Notes

The constructor may take in either both values of value and unit or kwargs as above. Either one of them must be used during initialization

The .value attribute is always in ns.

If the precision is higher than nanoseconds, the precision of the duration is truncated to nanoseconds.

Examples

Here we initialize Timedelta object with both value and unit

td = pd.Timedelta(1, "d") td Timedelta('1 days 00:00:00')

Here we initialize the Timedelta object with kwargs

td2 = pd.Timedelta(days=1) td2 Timedelta('1 days 00:00:00')

We see that either way we get the same result

Attributes

Methods