uds.utilities.helpers

Module with helper method reused within the package.

Functions

validate_time(value[, accept_zero])	Validate time value.
validate_timeout(value)	Validate timeout value.
find_element(…)	Find the element matching all given attributes.

Module Contents

uds.utilities.helpers.validate_time(value, accept_zero=True)

Validate time value.

Parameters:

• value (uds.utilities.common_types.TimeMillisecondsAlias) – Time value to check.

• accept_zero (bool) – Whether zero is acceptable value.

Raises:

• TypeError – Provided value is not int or float type.

• ValueError – Provided value is a negative number or equal zero (accept_zero=False).

Return type:

None

uds.utilities.helpers.validate_timeout(value)

Validate timeout value.

Parameters:

value (uds.utilities.common_types.TimeMillisecondsAlias | None) – Timeout value to check.

Raises:

• TypeError – Provided value is not None, int or float type.

• ValueError – Provided value is not a positive number.

Return type:

None

uds.utilities.helpers.find_element(values: collections.abc.Iterable[T1], element_type: type[T2], **attributes: Any) → T2 | None

uds.utilities.helpers.find_element(values: collections.abc.Iterable[T1], element_type: None = None, **attributes: Any) → T1 | None

Find the element matching all given attributes.

Parameters:

• values – Iterator with elements to look in.

• element_type – Element type to look for. None if type is irrelevant.

• attributes – Attributes of an object. If an element does not have an attribute, None value is assumed.

Returns:

An object that was found or None if not found.