tierkreis.idl.models

Tierkreis IDL models representation used for TSP parsing.

Module Contents

Classes

GenericType	A Tierkreis worker generic type.
TypedArg	A Tierkreis worker method argument.
Method	A Tierkreis worker method.
Interface	A Tierkreis worker interface.
Model	A Tierkreis worker model.

API

class GenericType

A Tierkreis worker generic type.

Represents a single (composed) type in worker definitions.

Fields:

origin (ElementaryType): The base type, e.g., str in list[str]. args: (Sequence[GenericType | str]) The nested types.

e.g., list[str] in set[list[str]]

is_ptype (bool): true if the type was either

1. constructed from a type that was a PType,

2. not constructed from a type at all (e.g. from a string in the parser).

has_serialization (bool): true if the type has custom serialization.

origin: tierkreis.idl.models.ElementaryType = None

args: Sequence[GenericType | str] = None

is_ptype: bool = True

has_serialization: bool = False

classmethod from_type(t: type, *, has_serialization: bool = False) → Self

Construct a generic type from a python type.

Parameters:

• t (type) – The python type.

• has_serialization (bool, defaults to False.) – If the type has custom serialization.

Returns:

The Tierkreis type.

Return type:

Self

included_structs() → set[GenericType]

Find the included structs of this type.

A struct is an instance of RestrictedNamedTuple or opaque strings. :return: The list of structs :rtype: set[GenericType]

__hash__() → int

Produce a hash of the generic type.

Returns:

The hash.

Return type:

int

__eq__(value: object) → bool

Check the equality of self with an object.

self == value <==> self.origin == value.origin

Parameters:

other (object) – The object to compare to.

Returns:

If both object have the same origin.

Return type:

bool

class TypedArg

A Tierkreis worker method argument.

Represents a single argument to a tasks in a worker. :fields:

name (str): The argument name. t (GenericType): The argument type. has_default(bool): Whether the argument has a default value.

name: str = None

t: tierkreis.idl.models.GenericType = None

has_default: bool = False

class Method

A Tierkreis worker method.

Represents a tasks in a worker.

Fields:

name (str): The method name. args (list[TypedArg]): The list of method arguments. return_type (GenericType): The method return type. return_type_is_portmapping (bool): Whether the return_type is a portmapping.

name: tierkreis.idl.models.GenericType = None

args: list[tierkreis.idl.models.TypedArg] = None

return_type: tierkreis.idl.models.GenericType = None

return_type_is_portmapping: bool = False

class Interface

A Tierkreis worker interface.

Represents a list of tasks contained in the worker.

Fields:

name (str): The worker name. methods (list[Method]): The available tasks in the worker.

name: str = None

methods: list[tierkreis.idl.models.Method] = None

class Model

A Tierkreis worker model.

Represents a type in a worker.

Fields:

is_portmapping (bool): Whether the model is a portmapping. t (GenericType): The type of the model. decl (list[TypedArg]) The list of its typed arguments.

is_portmapping: bool = None

t: tierkreis.idl.models.GenericType = None

decls: list[tierkreis.idl.models.TypedArg] = None

__hash__() → int

Produce a hash of the model.

Returns:

The hash.

Return type:

int

__lt__(other: tierkreis.idl.models.Model) → bool

Check order of two models.

Uses lexicographical ordering of the origin of the models (generic) types.

Parameters:

other (Model) – The model to compare to.

Returns:

If self comes before other.

Return type:

bool

is_pmodel() → bool

Check if the model is known to be a PModel, i.e. if all fields have types that were known to be PModels.

Raises an exception if some types are PModels and others not.

model_dependencies(known_models: dict[str, tierkreis.idl.models.Model]) → set[tierkreis.idl.models.Model]

Get a set of models this model depends on.

For example, if you have model A { x: int, y: B } model B { z: str } Then A depends on B.

Parameters:

known_models (dict[str, Model]) – A dictionary of known models by their name.

Returns:

A set of models this model depends on.

Return type:

set[Model]