Duration

A span of time, such as 27 days, 4 hours, 12 minutes, and 3 seconds.

A Duration represents a difference from one point in time to another. The duration may be "negative" if the difference is from a later time to an earlier.

Properties

• days(int) –

  The number of days in the duration.

• hours(int) –

  The number of hours in the duration.

• in_days(int) –

  Returns total duration in days.

• in_hours(int) –

  Returns total duration in hours.

• in_microseconds(int) –

  Returns total duration in microseconds.

• in_milliseconds(int) –

  Returns total duration in milliseconds.

• in_minutes(int) –

  Returns total duration in minutes.

• in_seconds(int) –

  Returns total duration in seconds.

• is_negative(bool) –

  Returns True if duration is negative.

• microseconds(int) –

  The number of microseconds in the duration.

• milliseconds(int) –

  The number of milliseconds in the duration.

• minutes(int) –

  The number of minutes in the duration.

• seconds(int) –

  The number of seconds in the duration.

Methods

• abs –

  Returns absolute (non-negative) Duration.

• copy –

  Returns a copy of this Duration instance with the given fields replaced

• from_unit –

  Creates a Duration from individual time units.

Properties

days class-attribute instance-attribute

days: int = 0

The number of days in the duration.

hours class-attribute instance-attribute

hours: int = 0

The number of hours in the duration.

in_days property

in_days: int

Returns total duration in days.

in_hours property

in_hours: int

Returns total duration in hours.

in_microseconds property

in_microseconds: int

Returns total duration in microseconds.

in_milliseconds property

in_milliseconds: int

Returns total duration in milliseconds.

in_minutes property

in_minutes: int

Returns total duration in minutes.

in_seconds property

in_seconds: int

Returns total duration in seconds.

is_negative property

is_negative: bool

Returns True if duration is negative.

microseconds class-attribute instance-attribute

microseconds: int = 0

The number of microseconds in the duration.

milliseconds class-attribute instance-attribute

milliseconds: int = 0

The number of milliseconds in the duration.

minutes class-attribute instance-attribute

minutes: int = 0

The number of minutes in the duration.

seconds class-attribute instance-attribute

seconds: int = 0

The number of seconds in the duration.

Methods

abs

abs() -> Duration

Returns absolute (non-negative) Duration.

copy

copy(
    *,
    microseconds: int | None = None,
    milliseconds: int | None = None,
    seconds: int | None = None,
    minutes: int | None = None,
    hours: int | None = None,
    days: int | None = None,
) -> Duration

Returns a copy of this Duration instance with the given fields replaced with the new values.

from_unit classmethod

from_unit(
    *,
    days: int = 0,
    hours: int = 0,
    minutes: int = 0,
    seconds: int = 0,
    milliseconds: int = 0,
    microseconds: int = 0,
) -> Duration

Creates a Duration from individual time units.