unitelabs.cdk.sila

Attributes

Name
Stream
Type
Value
= AsyncIterator[T]
Description
Name
__all__
Type
Value
= [ "Server", "Feature", "Handler", "ObservableCommand", "Intermediate", "IntermediateResponse", "Response", "UnobservableCommand", "UnobservableProperty", "ObservableProperty", "Stream", "CustomDataType", "DefinedExecutionError", "Metadata", "Status", "data_types", "constraints", "errors", "datetime", "identifiers", "utils" ]
Description

Classes

Intermediate
Bases
typing.Generic[T]
Methods
- init(
  self,
  command_execution : sila.commands.CommandExecution
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    command_execution
    Type
    sila.commands.CommandExecution
    Default
    Description
- send(self, value : T) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    value
    Type
    T
    Default
    Description
Attributes
- Name
  command_execution
  Type
  sila.commands.CommandExecution
  Value
  = weakref.proxy(command_execution)
  Description
IntermediateResponse
Decorators
dataclasses.dataclass
Methods
- __init__(self, name : str, description : str) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    name
    Type
    str
    Default
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
- __call__(self, function : typing.Callable) -> typing.Callable
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
  Response
  Type
  typing.Callable
  Description
Attributes
- Name
  name
  Type
  str
  Value
  = None
  Description
- Name
  description
  Type
  str
  Value
  = ''
  Description
- Name
  annotation
  Type
  type
  Value
  = dataclasses.field(init=False, default=type(None))
  Description
Response
Decorators
dataclasses.dataclass
Methods
- __init__(self, name : str, description : str) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    name
    Type
    str
    Default
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
- __call__(self, function : typing.Callable) -> typing.Callable
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
  Response
  Type
  typing.Callable
  Description
Attributes
- Name
  name
  Type
  str
  Value
  = None
  Description
- Name
  description
  Type
  str
  Value
  = ''
  Description
- Name
  annotation
  Type
  type
  Value
  = dataclasses.field(init=False, default=type(None))
  Description
Status
Methods
- init(
  self,
  command_execution : sila.commands.CommandExecution
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    command_execution
    Type
    sila.commands.CommandExecution
    Default
    Description
- update(
  self,
  progress : float[],
  remaining_time : sila.datetime.timedelta[],
  updated_lifetime : sila.datetime.timedelta[]
  ) -> None
  Updates the execution status of an observable command execution
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    progress
    Type
    float[]
    Default
    = None
    Description
  - Name
    remaining_time
    Type
    sila.datetime.timedelta[]
    Default
    = None
    Description
  - Name
    updated_lifetime
    Type
    sila.datetime.timedelta[]
    Default
    = None
    Description
Attributes
- Name
  command_execution
  Type
  sila.commands.CommandExecution
  Value
  = weakref.proxy(command_execution)
  Description
CustomDataType
Bases
abc.ABC
Decorators
dataclasses.dataclass
Methods
- __init__(self) -> None
- __init_subclass__(
  cls,
  *args,
  identifier,
  display_name,
  description,
  **kwargs
  ) -> None
  Parameters
  - Name
    cls
    Type
    Default
    Description
  - Name
    *args
    Type
    Default
    = ()
    Description
  - Name
    identifier
    Type
    Default
    = ''
    Description
  - Name
    display_name
    Type
    Default
    = ''
    Description
  - Name
    description
    Type
    Default
    = ''
    Description
  - Name
    **kwargs
    Type
    Default
    = {}
    Description
Attributes
- Name
  identifier
  Type
  str
  Value
  = ''
  Description
- Name
  display_name
  Type
  str
  Value
  = ''
  Description
- Name
  description
  Type
  str
  Value
  = ''
  Description
DefinedExecutionError
Bases
sila.server.errors.DefinedExecutionError
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  *args,
  identifier : str,
  display_name : str,
  description : str,
  **kwargs
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    *args
    Type
    Default
    = ()
    Description
  - Name
    identifier
    Type
    str
    Default
    = ''
    Description
  - Name
    display_name
    Type
    str
    Default
    = ''
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
  - Name
    **kwargs
    Type
    Default
    = {}
    Description
Feature
Bases
sila.server.Feature
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  *args,
  identifier : str,
  display_name : str,
  description : str,
  **kwargs
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    *args
    Type
    Default
    = ()
    Description
  - Name
    identifier
    Type
    str
    Default
    = ''
    Description
  - Name
    display_name
    Type
    str
    Default
    = ''
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
  - Name
    **kwargs
    Type
    Default
    = {}
    Description
- add_to_server(self, server : sila.server.Server) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    server
    Type
    sila.server.Server
    Default
    Description
Metadata
Bases
sila.server.Metadata
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  *args,
  identifier : str,
  display_name : str,
  description : str,
  **kwargs
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    *args
    Type
    Default
    = ()
    Description
  - Name
    identifier
    Type
    str
    Default
    = ''
    Description
  - Name
    display_name
    Type
    str
    Default
    = ''
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
  - Name
    **kwargs
    Type
    Default
    = {}
    Description
ObservableCommand
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  name : str,
  description : str,
  errors : list[type[DefinedExecutionError]]
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    name
    Type
    str
    Default
    = ''
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
  - Name
    errors
    Type
    list[type[DefinedExecutionError]]
    Default
    Description
- __call__(self, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
- attach(self, feature : sila.server.Feature, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    feature
    Type
    sila.server.Feature
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
- _infer_parameters_from_signature(self, feature, function : typing.Callable) -> dict[str, sila.server.data_types.Structure.Element]
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    feature
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
  Response
  Type
  dict[str, sila.server.data_types.Structure.Element]
  Description
Attributes
- Name
  name
  Type
  str
  Value
  = ''
  Description
- Name
  description
  Type
  str
  Value
  = ''
  Description
- Name
  errors
  Type
  list[type[DefinedExecutionError]]
  Value
  = dataclasses.field(default_factory=list)
  Description
ObservableProperty
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  identifier : str,
  display_name : str,
  description : str,
  errors : list[type[DefinedExecutionError]]
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    identifier
    Type
    str
    Default
    = ''
    Description
  - Name
    display_name
    Type
    str
    Default
    = ''
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
  - Name
    errors
    Type
    list[type[DefinedExecutionError]]
    Default
    Description
- __call__(self, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
- attach(self, feature : sila.server.Feature, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    feature
    Type
    sila.server.Feature
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
Attributes
- Name
  identifier
  Type
  str
  Value
  = ''
  Description
- Name
  display_name
  Type
  str
  Value
  = ''
  Description
- Name
  description
  Type
  str
  Value
  = ''
  Description
- Name
  errors
  Type
  list[type[DefinedExecutionError]]
  Value
  = dataclasses.field(default_factory=list)
  Description
UnobservableCommand
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  identifier : str,
  display_name : str,
  description : str,
  errors : list[type[DefinedExecutionError]]
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    identifier
    Type
    str
    Default
    = ''
    Description
  - Name
    display_name
    Type
    str
    Default
    = ''
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
  - Name
    errors
    Type
    list[type[DefinedExecutionError]]
    Default
    Description
- __call__(self, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
- attach(self, feature : sila.server.Feature, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    feature
    Type
    sila.server.Feature
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
- _infer_parameters_from_signature(self, feature, function : typing.Callable) -> dict[str, sila.server.data_types.Structure.Element]
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    feature
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
  Response
  Type
  dict[str, sila.server.data_types.Structure.Element]
  Description
Attributes
- Name
  identifier
  Type
  str
  Value
  = ''
  Description
- Name
  display_name
  Type
  str
  Value
  = ''
  Description
- Name
  description
  Type
  str
  Value
  = ''
  Description
- Name
  errors
  Type
  list[type[DefinedExecutionError]]
  Value
  = dataclasses.field(default_factory=list)
  Description
UnobservableProperty
Decorators
dataclasses.dataclass
Methods
- init(
  self,
  identifier : str,
  display_name : str,
  description : str,
  errors : list[type[DefinedExecutionError]]
  ) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    identifier
    Type
    str
    Default
    = ''
    Description
  - Name
    display_name
    Type
    str
    Default
    = ''
    Description
  - Name
    description
    Type
    str
    Default
    = ''
    Description
  - Name
    errors
    Type
    list[type[DefinedExecutionError]]
    Default
    Description
- __call__(self, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
- attach(self, feature : sila.server.Feature, function : typing.Callable) -> None
  Parameters
  - Name
    self
    Type
    Default
    Description
  - Name
    feature
    Type
    sila.server.Feature
    Default
    Description
  - Name
    function
    Type
    typing.Callable
    Default
    Description
Attributes
- Name
  identifier
  Type
  str
  Value
  = ''
  Description
- Name
  display_name
  Type
  str
  Value
  = ''
  Description
- Name
  description
  Type
  str
  Value
  = ''
  Description
- Name
  errors
  Type
  list[type[DefinedExecutionError]]
  Value
  = dataclasses.field(default_factory=list)
  Description

unitelabs.cdk.sila

Packages

Attributes

Classes

Intermediate

Methods

__init__(self, command_execution : sila.commands.CommandExecution) -> None

Parameters

send(self, value : T) -> None

Parameters

Attributes

IntermediateResponse

Methods

__init__(self, name : str, description : str) -> None

Parameters

__call__(self, function : typing.Callable) -> typing.Callable

Parameters

Response

Attributes

Response

Methods

__init__(self, name : str, description : str) -> None

Parameters

__call__(self, function : typing.Callable) -> typing.Callable

Parameters

Response

Attributes

Status

Methods

__init__(self, command_execution : sila.commands.CommandExecution) -> None

Parameters

update(self, progress : float[], remaining_time : sila.datetime.timedelta[], updated_lifetime : sila.datetime.timedelta[]) -> None

Parameters

Attributes

CustomDataType

Methods

__init__(self) -> None

__init_subclass__(cls, *args, identifier, display_name, description, **kwargs) -> None

Parameters

Attributes

DefinedExecutionError

Methods

__init__(self, *args, identifier : str, display_name : str, description : str, **kwargs) -> None

Parameters

Feature

Methods

__init__(self, *args, identifier : str, display_name : str, description : str, **kwargs) -> None

Parameters

add_to_server(self, server : sila.server.Server) -> None

Parameters

Metadata

Methods

__init__(self, *args, identifier : str, display_name : str, description : str, **kwargs) -> None

Parameters

ObservableCommand

Methods

__init__(self, name : str, description : str, errors : list[type[DefinedExecutionError]]) -> None

Parameters

__call__(self, function : typing.Callable) -> None

Parameters

attach(self, feature : sila.server.Feature, function : typing.Callable) -> None

Parameters

_infer_parameters_from_signature(self, feature, function : typing.Callable) -> dict[str, sila.server.data_types.Structure.Element]

Parameters

Response

Attributes

ObservableProperty

Methods

__init__(self, identifier : str, display_name : str, description : str, errors : list[type[DefinedExecutionError]]) -> None

Parameters

__call__(self, function : typing.Callable) -> None

Parameters

attach(self, feature : sila.server.Feature, function : typing.Callable) -> None

Parameters

Attributes

UnobservableCommand

Methods

__init__(self, identifier : str, display_name : str, description : str, errors : list[type[DefinedExecutionError]]) -> None

Parameters

__call__(self, function : typing.Callable) -> None

init(
self,
command_execution : sila.commands.CommandExecution
) -> None

init(self, name : str, description : str) -> None

call(self, function : typing.Callable) -> typing.Callable

init(self, name : str, description : str) -> None

call(self, function : typing.Callable) -> typing.Callable

init(
self,
command_execution : sila.commands.CommandExecution
) -> None

update(
self,
progress : float[],
remaining_time : sila.datetime.timedelta[],
updated_lifetime : sila.datetime.timedelta[]
) -> None

init(self) -> None

__init_subclass__(
cls,
*args,
identifier,
display_name,
description,
**kwargs
) -> None

init(
self,
*args,
identifier : str,
display_name : str,
description : str,
**kwargs
) -> None

init(
self,
*args,
identifier : str,
display_name : str,
description : str,
**kwargs
) -> None

init(
self,
*args,
identifier : str,
display_name : str,
description : str,
**kwargs
) -> None

init(
self,
name : str,
description : str,
errors : list[type[DefinedExecutionError]]
) -> None

call(self, function : typing.Callable) -> None

init(
self,
identifier : str,
display_name : str,
description : str,
errors : list[type[DefinedExecutionError]]
) -> None

call(self, function : typing.Callable) -> None

init(
self,
identifier : str,
display_name : str,
description : str,
errors : list[type[DefinedExecutionError]]
) -> None

call(self, function : typing.Callable) -> None

init(
self,
identifier : str,
display_name : str,
description : str,
errors : list[type[DefinedExecutionError]]
) -> None

call(self, function : typing.Callable) -> None