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_raw_bytes(value)

Validate whether provided value stores raw bytes.

Attributes

RawByte

Typing alias of byte value - integer in range 0x00-0xFF - that is used by the package.

RawBytesTuple

Typing alias of a tuple filled with byte values.

RawBytesSet

Typing alias of a set filled with byte values.

RawBytes

Typing alias of a sequence filled with byte values.

TimeMilliseconds

Typing alias of an amount of time in milliseconds that is used by the package.

TimeStamp

Typing alias of a timestamp that is used by the package.

uds.utilities.common_types.RawByte

Typing alias of byte value - integer in range 0x00-0xFF - that is used by the package.

uds.utilities.common_types.RawBytesTuple

Typing alias of a tuple filled with byte values.

uds.utilities.common_types.RawBytesSet

Typing alias of a set filled with byte values.

uds.utilities.common_types.RawBytes

Typing alias of a sequence filled with byte values.

uds.utilities.common_types.TimeMilliseconds

Typing alias of an amount of time in milliseconds that is used by the package.

uds.utilities.common_types.TimeStamp

Typing alias of a timestamp that is used by the package.

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

Validate whether provided value stores raw bytes.

Parameters

value (Any) – Value to validate.

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