`LumensalisCP.common`

Module Contents

Functions

`dictAddUnique`	_summary_ add a unique key/value pair to a dictionary, or assert that the key is already present with the same value.
`updateKWDefaults`	_summary_
`safeRepr`
`safeFmt`	A safe formatting function that returns a formatted string or an error message if formatting fails.
`ensure`	_summary_ Throw an EnsureException if the condition is not met.
`toZeroToOne`	Convert a value to a float. If the value is already a float, it is returned as is.
`withinZeroToOne`	__summary__ Convert a value to a float between 0.0 and 1.0 inclusive. If the value is already a float, it is clamped to the range.
`SHOW_EXCEPTION`

Data

`TimeInNS`
`TimeSpanInNS`
`TimeInMS`
`TimeSpanInMS`
`TimeInSeconds`
`TimeSpanInSeconds`
`DegreesPerSecond`
`Degrees`
`ZeroToOne`
`PlusMinusOne`
`Volts`
`Hertz`

API

LumensalisCP.common.TimeInNS : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.TimeSpanInNS : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.TimeInMS : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.TimeSpanInMS : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.TimeInSeconds : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.TimeSpanInSeconds : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.DegreesPerSecond : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.Degrees : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.ZeroToOne : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.PlusMinusOne : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.Volts : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.Hertz : LumensalisCP.CPTyping.TypeAlias = None

LumensalisCP.common.dictAddUnique(d: LumensalisCP.CPTyping.Dict[LumensalisCP.CPTyping.Any, LumensalisCP.CPTyping.Any], key: LumensalisCP.CPTyping.Any, value: LumensalisCP.CPTyping.Any) → None

_summary_ add a unique key/value pair to a dictionary, or assert that the key is already present with the same value.

Args: : d (Mapping[str,Any]): target dictionary key (str): key to add value (Any): value to add

LumensalisCP.common.updateKWDefaults(kwargs: LumensalisCP.CPTyping.Dict[str, LumensalisCP.CPTyping.Any], **updatedDefaults) → LumensalisCP.CPTyping.Dict[str, LumensalisCP.CPTyping.Any]

_summary_

Args: : kwargs (Mapping): keyword dictionary/mapping to update

**

updatedDefaults: keyword arguments to update the defaults with

Returns: : Mapping: the modified kwargs

LumensalisCP.common.safeRepr(v)

LumensalisCP.common.safeFmt(fmtStr: str, *args: LumensalisCP.CPTyping.Any)

A safe formatting function that returns a formatted string or an error message if formatting fails.

exception LumensalisCP.common.EnsureException

Bases: Exception

_summary_ base class for exceptions raised by the ensure function. Args:

Exception (type): _description_

Initialization

Initialize self. See help(type(self)) for accurate signature.

LumensalisCP.common.ensure(condition: bool, fmtStr: str | None = None, *args: LumensalisCP.CPTyping.Any)

_summary_ Throw an EnsureException if the condition is not met.

Args: : condition (bool): condition value to test fmtStr (str | None, optional): _description_. Defaults to None.

Raises: : EnsureException: _description_

LumensalisCP.common.toZeroToOne(value: LumensalisCP.CPTyping.Any) → float

Convert a value to a float. If the value is already a float, it is returned as is.

LumensalisCP.common.withinZeroToOne(value: LumensalisCP.CPTyping.Any) → LumensalisCP.common.ZeroToOne

__summary__ Convert a value to a float between 0.0 and 1.0 inclusive. If the value is already a float, it is clamped to the range.

LumensalisCP.common