kd.types API

Types used as type annotations in users's code.

Subcategory	Description
DataBag	Base class of all Arolla values in Python.
DataItem	Base class of all Arolla values in Python.
DataSlice	Base class of all Arolla values in Python.
DictItem	DictItem is a DataItem representing a Koda Dict.
Executor	Base class of all Arolla values in Python.
Iterable	QValue specialization for sequence qtype.
JaggedShape	QValue specialization for JAGGED_SHAPE qtypes.
ListItem	ListItem is a DataItem representing a Koda List.
SchemaItem	SchemaItem is a DataItem representing a Koda Schema.
Stream	Stream of values.
StreamReader	Stream reader.
StreamWriter	Stream writer.

kd.types.DataBag()

Base class of all Arolla values in Python.

QValue is immutable. It provides only basic functionality.
Subclasses of this class might have further specialization.

kd.types.DataItem()

Base class of all Arolla values in Python.

QValue is immutable. It provides only basic functionality.
Subclasses of this class might have further specialization.

kd.types.DataSlice()

Base class of all Arolla values in Python.

QValue is immutable. It provides only basic functionality.
Subclasses of this class might have further specialization.

kd.types.DictItem()

DictItem is a DataItem representing a Koda Dict.

kd.types.Executor()

Base class of all Arolla values in Python.

QValue is immutable. It provides only basic functionality.
Subclasses of this class might have further specialization.

kd.types.Iterable(*values: Any, value_type_as: Any = None)

QValue specialization for sequence qtype.

It intentionally provides only __iter__ method, and not __len__ for example,
since the users are expected to use iterables in such a way that they do not
need to know the length in advance, since they can represent streams in
streaming workflows.

kd.types.JaggedShape()

QValue specialization for JAGGED_SHAPE qtypes.

kd.types.ListItem()

ListItem is a DataItem representing a Koda List.

kd.types.SchemaItem()

SchemaItem is a DataItem representing a Koda Schema.

kd.types.Stream()

Stream of values.

The stream keeps all values in memory and can be read more than once.

Note: This class supports parametrization like Stream[T]; however,
the type parameter is currently used only for documentation purposes.
This might be changed in the future.

kd.types.StreamReader()

Stream reader.

Note: This class supports parametrization like StreamReader[T].

kd.types.StreamWriter()

Stream writer.

Note: This class supports parametrization like StreamWriter[T].

Note: It is strongly advised that all streams be explicitly closed.