tisserande.models.function_types

Pydantic models for function type tables (PythonFunction, MemberFunction, ShellFunction).

Classes

PythonFunctionBase	Model for a python function.
PythonFunctionCreate	Fields used to create a PythonFunction.
PythonFunction	PythonFunction response model.
MemberFunctionBase	Model for a member function.
MemberFunctionCreate	Fields used to create a MemberFunction.
MemberFunction	MemberFunction response model.
ShellFunctionBase	Model for a shell function/script.
ShellFunctionCreate	Fields used to create a ShellFunction.
ShellFunction	ShellFunction response model.

Module Contents

class tisserande.models.function_types.PythonFunctionBase(/, **data: Any)

Bases: pydantic.BaseModel

Model for a python function.

name: str = None

module_: str = None

class tisserande.models.function_types.PythonFunctionCreate(/, **data: Any)

Bases: PythonFunctionBase

Fields used to create a PythonFunction.

class tisserande.models.function_types.PythonFunction(/, **data: Any)

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.function_types.MemberFunctionBase(/, **data: Any)

Bases: pydantic.BaseModel

Model for a member function.

name: str = None

class tisserande.models.function_types.MemberFunctionCreate(/, **data: Any)

Bases: MemberFunctionBase

Fields used to create a MemberFunction.

class_name: str | None = None

class_id: int | None = None

class tisserande.models.function_types.MemberFunction(/, **data: Any)

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.function_types.ShellFunctionBase(/, **data: Any)

Bases: pydantic.BaseModel

Model for a shell function/script.

name: str = None

class tisserande.models.function_types.ShellFunctionCreate(/, **data: Any)

Bases: ShellFunctionBase

Fields used to create a ShellFunction.

class tisserande.models.function_types.ShellFunction(/, **data: Any)

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