Time

class Time(value: float | int, unit: str)

Bases: UnitBase

Time object.

Attributes

unitstr

Symbol of the unit of measurement for time.

valuefloat or int

Time 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) → Time

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

Time

Converted time.

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

Time instantiation.

>>> from gearpy.units import Time
>>> t = Time(1, 'hour')
>>> t
... 1 hour

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

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

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

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

property unit: str

Symbol of the unit of measurement for time. 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.

Raises

TypeError

If unit is not a str.

KeyError

If the unit is not among available ones.

property value: float | int

Time numerical value. The relative unit is expressed by the unit property.

Returns

float or int

Time numerical value.

Raises

TypeError

If value is not a float or an int.