otupy.types.base.record.Record

class Record

Bases: Openc2Type

OpenC2 Record

Implements OpenC2 Record:

An ordered map from a list of keys with positions to values with positionally-defined semantics. Each key has a position and name, and is mapped to a type.

It expect keys to be public class attributes. All internal attributes must be kept private by prefixing it with an ‘_’.

Methods

fromdict	Builds instance from dictionary
todict	Converts to dictionary

classmethod fromdict(dic, e)

Builds instance from dictionary

It is used during deserialization to create an otupy instance from the text message. It takes an Encoder instance that is used to recursively build instances of the inner objects (the Encoder provides standard methods to create instances of base objects like strings, integers, boolean).

Parameters:

• dic – The intermediary dictionary representation from which the object is built.

• e – The Encoder that is being used.

Returns:

An instance of this class initialized from the dictionary values.

todict(e)

Converts to dictionary

It is used to convert this object to an intermediary representation during serialization. It takes an Encoder argument that is used to recursively serialize inner data and structures (the Encoder provides standard methods for converting base types to dictionaries)..

Parameters:

e – The Encoder that is being used.

Returns:

A dictionary compliants to the Language Specification’s serialization rules.