tisserande.models

Submodules

Classes

Array

Array response model.

ArrayCreate

Fields used to create an Array.

Class

Class response model.

ClassCreate

Fields used to create a Class.

ConfigDictType

ConfigDictType response model.

ConfigDictTypeCreate

Fields used to create a ConfigDictType.

ConfigFileType

ConfigFileType response model.

ConfigFileTypeCreate

Fields used to create a ConfigFileType.

DataFileType

DataFileType response model.

DataFileTypeCreate

Fields used to create a DataFileType.

Parameter

Parameter response model.

ParameterCreate

Fields used to create a Parameter.

Edge

Edge response model.

EdgeCreate

Fields used to create an Edge.

Execution

Execution response model.

ExecutionCreate

Fields used to create an Execution.

MemberFunction

MemberFunction response model.

MemberFunctionCreate

Fields used to create a MemberFunction.

PythonFunction

PythonFunction response model.

PythonFunctionCreate

Fields used to create a PythonFunction.

ShellFunction

ShellFunction response model.

ShellFunctionCreate

Fields used to create a ShellFunction.

ArrayNode

ArrayNode response model.

ArrayNodeCreate

Fields used to create an ArrayNode.

ConfigDictNode

ConfigDictNode response model.

ConfigDictNodeCreate

Fields used to create a ConfigDictNode.

ConfigFileNode

ConfigFileNode response model.

ConfigFileNodeCreate

Fields used to create a ConfigFileNode.

DataFileNode

DataFileNode response model.

DataFileNodeCreate

Fields used to create a DataFileNode.

MemberFunctionNode

MemberFunctionNode response model.

MemberFunctionNodeCreate

Fields used to create a MemberFunctionNode.

Node

Node response model.

NodeCreate

Generic node creation model.

ObjectNode

ObjectNode response model.

ObjectNodeCreate

Fields used to create an ObjectNode.

ParameterNode

ParameterNode response model.

ParameterNodeCreate

Fields used to create a ParameterNode.

PythonFunctionNode

PythonFunctionNode response model.

PythonFunctionNodeCreate

Fields used to create a PythonFunctionNode.

ShellFunctionNode

ShellFunctionNode response model.

ShellFunctionNodeCreate

Fields used to create a ShellFunctionNode.

ExecutionStatus

Create a collection of name/value pairs.

NodeType

Create a collection of name/value pairs.

Package Contents

class tisserande.models.Array(/, **data: Any)[source]

Bases: ArrayBase

Array response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name', 'n_dim', 'shape']
id_: int = None
class tisserande.models.ArrayCreate(/, **data: Any)[source]

Bases: ArrayBase

Fields used to create an Array.

class tisserande.models.Class(/, **data: Any)[source]

Bases: ClassBase

Class response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name', 'module_']
id_: int = None
class tisserande.models.ClassCreate(/, **data: Any)[source]

Bases: ClassBase

Fields used to create a Class.

class tisserande.models.ConfigDictType(/, **data: Any)[source]

Bases: ConfigDictTypeBase

ConfigDictType response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name']
id_: int = None
class tisserande.models.ConfigDictTypeCreate(/, **data: Any)[source]

Bases: ConfigDictTypeBase

Fields used to create a ConfigDictType.

class tisserande.models.ConfigFileType(/, **data: Any)[source]

Bases: ConfigFileTypeBase

ConfigFileType response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name']
id_: int = None
class tisserande.models.ConfigFileTypeCreate(/, **data: Any)[source]

Bases: ConfigFileTypeBase

Fields used to create a ConfigFileType.

class tisserande.models.DataFileType(/, **data: Any)[source]

Bases: DataFileTypeBase

DataFileType response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name']
id_: int = None
class tisserande.models.DataFileTypeCreate(/, **data: Any)[source]

Bases: DataFileTypeBase

Fields used to create a DataFileType.

class tisserande.models.Parameter(/, **data: Any)[source]

Bases: ParameterBase

Parameter response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name']
id_: int = None
class tisserande.models.ParameterCreate(/, **data: Any)[source]

Bases: ParameterBase

Fields used to create a Parameter.

class tisserande.models.Edge(/, **data: Any)[source]

Bases: EdgeBase

Edge response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'from_id', 'to_id', 'execution_id']
id_: int = None
execution_id: uuid.UUID | None = None
class tisserande.models.EdgeCreate(/, **data: Any)[source]

Bases: EdgeBase

Fields used to create an Edge.

execution_id: uuid.UUID | None = None
class tisserande.models.Execution(/, **data: Any)[source]

Bases: ExecutionBase

Execution response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'function_node_id', 'status', 'start_time', 'duration_seconds']
id_: uuid.UUID
function_node_id: uuid.UUID | None = None
class tisserande.models.ExecutionCreate(/, **data: Any)[source]

Bases: ExecutionBase

Fields used to create an Execution.

function_node_id: uuid.UUID | None = None
class tisserande.models.MemberFunction(/, **data: Any)[source]

Bases: MemberFunctionBase

MemberFunction response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name', 'class_id']
id_: int = None
class_id: int = None
class tisserande.models.MemberFunctionCreate(/, **data: Any)[source]

Bases: MemberFunctionBase

Fields used to create a MemberFunction.

class_name: str | None = None
class_id: int | None = None
class tisserande.models.PythonFunction(/, **data: Any)[source]

Bases: PythonFunctionBase

PythonFunction response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name', 'module_']
id_: int = None
class tisserande.models.PythonFunctionCreate(/, **data: Any)[source]

Bases: PythonFunctionBase

Fields used to create a PythonFunction.

class tisserande.models.ShellFunction(/, **data: Any)[source]

Bases: ShellFunctionBase

ShellFunction response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'name']
id_: int = None
class tisserande.models.ShellFunctionCreate(/, **data: Any)[source]

Bases: ShellFunctionBase

Fields used to create a ShellFunction.

class tisserande.models.ArrayNode(/, **data: Any)[source]

Bases: ArrayNodeBase

ArrayNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'array_id']
id_: uuid.UUID
array_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.ArrayNodeCreate(/, **data: Any)[source]

Bases: ArrayNodeBase

Fields used to create an ArrayNode.

array_name: str | None = None
array_id: int | None = None
arg_name: str | None = None
class tisserande.models.ConfigDictNode(/, **data: Any)[source]

Bases: ConfigDictNodeBase

ConfigDictNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'config_dict_type_id']
id_: uuid.UUID
config_dict_type_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.ConfigDictNodeCreate(/, **data: Any)[source]

Bases: ConfigDictNodeBase

Fields used to create a ConfigDictNode.

config_dict_type_name: str | None = None
config_dict_type_id: int | None = None
arg_name: str | None = None
class tisserande.models.ConfigFileNode(/, **data: Any)[source]

Bases: ConfigFileNodeBase

ConfigFileNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'path', 'config_file_type_id']
id_: uuid.UUID
config_file_type_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.ConfigFileNodeCreate(/, **data: Any)[source]

Bases: ConfigFileNodeBase

Fields used to create a ConfigFileNode.

config_file_type_name: str | None = None
config_file_type_id: int | None = None
arg_name: str | None = None
class tisserande.models.DataFileNode(/, **data: Any)[source]

Bases: DataFileNodeBase

DataFileNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'path', 'data_file_type_id']
id_: uuid.UUID
data_file_type_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.DataFileNodeCreate(/, **data: Any)[source]

Bases: DataFileNodeBase

Fields used to create a DataFileNode.

data_file_type_name: str | None = None
data_file_type_id: int | None = None
arg_name: str | None = None
class tisserande.models.MemberFunctionNode(/, **data: Any)[source]

Bases: MemberFunctionNodeBase

MemberFunctionNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'member_function_id']
id_: uuid.UUID
member_function_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.MemberFunctionNodeCreate(/, **data: Any)[source]

Bases: MemberFunctionNodeBase

Fields used to create a MemberFunctionNode.

member_function_name: str | None = None
member_function_id: int | None = None
class tisserande.models.Node(/, **data: Any)[source]

Bases: NodeBase

Node response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'arg_name', 'execution_id']
id_: uuid.UUID
execution_id: uuid.UUID | None = None
path: str | None = None
config_data: dict[str, Any] | None = None
value_float: float | None = None
value_json: Any | None = None
arg_name: str | None = None
data_file_type_id: int | None = None
config_file_type_id: int | None = None
config_dict_type_id: int | None = None
parameter_id: int | None = None
array_id: int | None = None
class_id: int | None = None
python_function_id: int | None = None
member_function_id: int | None = None
shell_function_id: int | None = None
class tisserande.models.NodeCreate(/, **data: Any)[source]

Bases: NodeBase

Generic node creation model.

path: str | None = None
config_data: dict[str, Any] | None = None
value_float: float | None = None
value_json: Any | None = None
arg_name: str | None = None
data_file_type_name: str | None = None
data_file_type_id: int | None = None
config_file_type_name: str | None = None
config_file_type_id: int | None = None
config_dict_type_name: str | None = None
config_dict_type_id: int | None = None
parameter_name: str | None = None
parameter_id: int | None = None
array_name: str | None = None
array_id: int | None = None
class_name: str | None = None
class_id: int | None = None
python_function_name: str | None = None
python_function_id: int | None = None
member_function_name: str | None = None
member_function_id: int | None = None
shell_function_name: str | None = None
shell_function_id: int | None = None
class tisserande.models.ObjectNode(/, **data: Any)[source]

Bases: ObjectNodeBase

ObjectNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'class_id']
id_: uuid.UUID
class_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.ObjectNodeCreate(/, **data: Any)[source]

Bases: ObjectNodeBase

Fields used to create an ObjectNode.

class_name: str | None = None
class_id: int | None = None
arg_name: str | None = None
class tisserande.models.ParameterNode(/, **data: Any)[source]

Bases: ParameterNodeBase

ParameterNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'value_float', 'parameter_id']
id_: uuid.UUID
parameter_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.ParameterNodeCreate(/, **data: Any)[source]

Bases: ParameterNodeBase

Fields used to create a ParameterNode.

parameter_name: str | None = None
parameter_id: int | None = None
arg_name: str | None = None
class tisserande.models.PythonFunctionNode(/, **data: Any)[source]

Bases: PythonFunctionNodeBase

PythonFunctionNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'python_function_id']
id_: uuid.UUID
python_function_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.PythonFunctionNodeCreate(/, **data: Any)[source]

Bases: PythonFunctionNodeBase

Fields used to create a PythonFunctionNode.

python_function_name: str | None = None
python_function_id: int | None = None
class tisserande.models.ShellFunctionNode(/, **data: Any)[source]

Bases: ShellFunctionNodeBase

ShellFunctionNode response model.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

col_names_for_table: ClassVar[list[str]] = ['id_', 'type_', 'shell_function_id']
id_: uuid.UUID
shell_function_id: int | None = None
execution_id: uuid.UUID | None = None
class tisserande.models.ShellFunctionNodeCreate(/, **data: Any)[source]

Bases: ShellFunctionNodeBase

Fields used to create a ShellFunctionNode.

shell_function_name: str | None = None
shell_function_id: int | None = None
class tisserande.models.ExecutionStatus(*args, **kwds)[source]

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

    >>> Color.RED
    <Color.RED: 1>
    
  • value lookup:

    >>> Color(1)
    <Color.RED: 1>
    
  • name lookup:

    >>> Color['RED']
    <Color.RED: 1>
    

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3
>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

PENDING = 'pending'
RUNNING = 'running'
SUCCESS = 'success'
FAILURE = 'failure'
class tisserande.models.NodeType(*args, **kwds)[source]

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

    >>> Color.RED
    <Color.RED: 1>
    
  • value lookup:

    >>> Color(1)
    <Color.RED: 1>
    
  • name lookup:

    >>> Color['RED']
    <Color.RED: 1>
    

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3
>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

DATA_FILE = 'data_file'
CONFIG_FILE = 'config_file'
CONFIG_DICT = 'config_dict'
PARAMETER = 'parameter'
ARRAY = 'array'
OBJECT = 'object'
PYTHON_FUNCTION = 'python_function'
MEMBER_FUNCTION = 'member_function'
SHELL_FUNCTION = 'shell_function'
property is_data: bool
property is_logic: bool