uds.utilities.common_types

Module with all common types (and its aliases) used in the package and helper functions for these types.

Module Contents

Functions

validate_nibble(value)

Validate whether provided value stores a nibble value.

validate_raw_byte(value)

Validate whether provided value stores a raw byte value.

validate_raw_bytes(value[, allow_empty])

Validate whether provided value stores raw bytes value.

Attributes

TimeMillisecondsAlias

Alias of a time value in milliseconds.

RawBytesTupleAlias

Alias of a tuple filled with byte values.

RawBytesSetAlias

Alias of a set filled with byte values.

RawBytesListAlias

Alias of a list filled with byte values.

RawBytesAlias

Alias of a sequence filled with byte values.
uds.utilities.common_types.TimeMillisecondsAlias

Alias of a time value in milliseconds.

uds.utilities.common_types.RawBytesTupleAlias

Alias of a tuple filled with byte values.

uds.utilities.common_types.RawBytesSetAlias

Alias of a set filled with byte values.

uds.utilities.common_types.RawBytesListAlias

Alias of a list filled with byte values.

uds.utilities.common_types.RawBytesAlias

Alias of a sequence filled with byte values.

uds.utilities.common_types.validate_nibble(value)[source]

Validate whether provided value stores a nibble value.

Parameters:

value (int) – Value to validate.

Raises:

  • TypeError – Value is not int type.

  • ValueError – Value is out of byte range (0x0-0xF).

Return type:

None

uds.utilities.common_types.validate_raw_byte(value)[source]

Validate whether provided value stores a raw byte value.

Parameters:

value (int) – Value to validate.

Raises:

  • TypeError – Value is not int type.

  • ValueError – Value is out of byte range (0x00-0xFF).

Return type:

None

uds.utilities.common_types.validate_raw_bytes(value, allow_empty=False)[source]

Validate whether provided value stores raw bytes value.

Parameters:

  • value (RawBytesAlias) – Value to validate.

  • allow_empty (bool) – True if empty list is allowed, False otherwise.

Raises:

  • TypeError – Value is not tuple or list type.

  • ValueError – Value does not contain raw bytes (int value between 0x00-0xFF) only.

Return type:

None