Skip to content

Temporal Duration

Helpers for representing durations and time spans.

Duration Module

Time duration operations.

This submodule provides utilities for creating and manipulating time durations using timedelta objects.

Examples

from rite.temporal.duration import duration_from_hours from rite.temporal.duration import duration_to_seconds dur = duration_from_hours(2) duration_to_seconds(dur) 7200.0

Modules

duration_from_days

Duration From Days

Create duration from days.

Examples

from rite.temporal.duration import duration_from_days duration_from_days(7) timedelta(days=7)

Functions

duration_from_days(days: int | float) -> timedelta

Create timedelta from days.

Parameters:

Name Type Description Default
days int | float

Number of days.

required

Returns:

Type Description
timedelta

Timedelta object.

Examples:

>>> duration_from_days(7)
timedelta(days=7)
>>> duration_from_days(1.5)
timedelta(days=1, seconds=43200)
Notes

Standard timedelta constructor.

duration_from_hours

Duration From Hours

Create duration from hours.

Examples

from rite.temporal.duration import duration_from_hours duration_from_hours(24) timedelta(days=1)

Functions

duration_from_hours(hours: int | float) -> timedelta

Create timedelta from hours.

Parameters:

Name Type Description Default
hours int | float

Number of hours.

required

Returns:

Type Description
timedelta

Timedelta object.

Examples:

>>> duration_from_hours(24)
timedelta(days=1)
>>> duration_from_hours(1.5)
timedelta(seconds=5400)
Notes

Converts to seconds internally.

duration_from_minutes

Duration From Minutes

Create duration from minutes.

Examples

from rite.temporal.duration import duration_from_minutes duration_from_minutes(60) timedelta(seconds=3600)

Functions

duration_from_minutes(minutes: int | float) -> timedelta

Create timedelta from minutes.

Parameters:

Name Type Description Default
minutes int | float

Number of minutes.

required

Returns:

Type Description
timedelta

Timedelta object.

Examples:

>>> duration_from_minutes(60)
timedelta(seconds=3600)
>>> duration_from_minutes(1.5)
timedelta(seconds=90)
Notes

Converts to seconds internally.

duration_from_seconds

Duration From Seconds

Create duration from seconds.

Examples

from rite.temporal.duration import duration_from_seconds duration_from_seconds(3600) timedelta(seconds=3600)

Functions

duration_from_seconds(seconds: int | float) -> timedelta

Create timedelta from seconds.

Parameters:

Name Type Description Default
seconds int | float

Number of seconds.

required

Returns:

Type Description
timedelta

Timedelta object.

Examples:

>>> duration_from_seconds(3600)
timedelta(seconds=3600)
>>> duration_from_seconds(90.5)
timedelta(seconds=90, microseconds=500000)
Notes

Supports both int and float values.

duration_to_seconds

Duration To Seconds

Convert duration to total seconds.

Examples

from rite.temporal.duration import duration_to_seconds from datetime import timedelta duration_to_seconds(timedelta(hours=1)) 3600.0

Functions

duration_to_seconds(td: timedelta) -> float

Convert timedelta to total seconds.

Parameters:

Name Type Description Default
td timedelta

Timedelta object.

required

Returns:

Type Description
float

Total seconds as float.

Examples:

>>> from datetime import timedelta
>>> duration_to_seconds(timedelta(hours=1))
3600.0
>>> duration_to_seconds(timedelta(days=1))
86400.0
Notes

Returns float for precision.

options: show_root_heading: true show_source: false heading_level: 2