TimeInterval¶

class TimeInterval(value: float | int, unit: str)¶

Bases: Time

TimeInterval object.

Attributes¶

unitstr: Symbol of the unit of measurement for time interval.
valuefloat or int: Time interval numerical value.

Methods¶

to(): It converts actual value to a new value computed using target_unit as the reference unit of measurement.

to(target_unit: str, inplace: bool = False) → TimeInterval¶

It converts actual value to a new value computed using target_unit as the reference unit of measurement.

If inplace is True, it overrides actual value and unit, otherwise it returns a new instance with the converted value and the target_unit as unit.

Parameters¶

target_unitstr: Target unit to which convert the current value.
inplacebool, optional: Whether to override the current instance value. Default is False, so it does not override the current value.

Returns¶

TimeInterval: Converted time interval.

Raises

TypeError

If target_unit is not a str,
if inplace is not a bool.

KeyError

If the target_unit is not among available ones.

Examples

TimeInterval instantiation.

>>> from gearpy.units import TimeInterval
>>> dt = TimeInterval(1, 'hour')
>>> dt
... 1 hour

Conversion from hour to second with inplace = False by default, so it does not override the current value.

>>> dt.to('sec')
... 3600.0 sec
>>> dt
... 1 hour

Conversion from hour to second with inplace = True, in order to override the current value.

>>> dt.to('sec', inplace = True)
... 3600.0 sec
>>> dt
... 3600.0 sec

property unit: str¶

Symbol of the unit of measurement for time interval. It must be a str. Available units are:

'sec' for second,
'min' for minute,
'hour' for hour,
'ms' for millisecond.

Returns¶

str: Symbol of the unit of measurement for time interval.

Raises

TypeError: If unit is not a str.
KeyError: If the unit is not among available ones.

property value: float | int¶

Time interval numerical value. The relative unit is expressed by the unit property. It must be positive.

Returns¶

float or int: Time interval numerical value.

Raises

TypeError: If value is not a float or an int.
ValueError: If value is negative or null.