pyrtma.validators.StructArray

class StructArray(msg_struct, len)

Bases: FieldValidator, Sequence, Generic[_S]

Validator for structure arrays

Validator for structure arrays

Parameters:

• msg_struct (Type[TypeVar(_S, bound= MessageBase)]) – Structure class

• len (int) – Array length

Methods

count
index	Raises ValueError if the value is not present.
pretty_print	Generate formatted string for structure array
validate_array	Validate structure array
validate_many	Validate multiple structures
validate_one	Validate a structure

count(value) → integer -- return number of occurrences of value

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

pretty_print(add_tabs=0)

Generate formatted string for structure array

Parameters:

add_tabs (int, optional) – Indent level. Defaults to 0.

Returns:

Formatted string

Return type:

str

validate_array(value)

Validate structure array

Parameters:

value (StructArray[TypeVar(_S, bound= MessageBase)]) – StructArray to validate

Raises:

TypeError – Wrong type

validate_many(value)

Validate multiple structures

Parameters:

value (Iterable[TypeVar(_S, bound= MessageBase)]) – Structure values to validate

validate_one(value)

Validate a structure

Parameters:

value (TypeVar(_S, bound= MessageBase)) – Structure value to validate