mxcubecore.CommandContainer#

Classes

`ChannelObject`(name[, username])	Channel base class
`CommandContainer`()	Mixin class for generic command and channel containers
`CommandObject`(name[, username])	Command launcher base class

Exceptions

ConnectionError

General Connection Error

class mxcubecore.CommandContainer.ChannelObject(name: str, username: str | None = None, **kwargs)[source]#

Bases: object

Channel base class

Parameters:

name (str) –
username (str | None) –

connect_notify(signal: str) → None[source]#

Connection notifier.

Parameters:: signal (str) – Signal name.
Return type:: None

connect_signal(signalName: str, callableFunc: Callable) → None[source]#

Connect signal.

Parameters:

signalName (str) – Signal name.
callableFunc (Callable) – Connection method.

Return type:

None

disconnect_signal(signalName: str, callableFunc: Callable) → None[source]#

Disconnect signal.

Parameters:

signalName (str) – Signal name.
callableFunc (Callable) – Disconnection method.

Return type:

None

emit(signal: str, *args) → None[source]#

Emit signal message.

Parameters:

signal (str) – Signal name.
*args (tuple) – Message arguments.

Return type:

None

get_value(force: bool = False)[source]#

Get channel value.

Parameters:: force (bool, optional) – Force get value. Defaults to False.
Raises:: NotImplementedError – If method has not been implemented for this object.

is_connected() → bool[source]#

Check if signal is connected.

Returns:: True if connected, else False.
Return type:: bool

name() → str[source]#

Get channel name.

Returns:: Channel name.
Return type:: str

update(value: Any) → None[source]#

Update command object.

Parameters:: value (Any) – Updated value.
Return type:: None

userName() → str[source]#

Get user name.

Returns:: User name.
Return type:: str

class mxcubecore.CommandContainer.CommandContainer[source]#

Bases: object

Mixin class for generic command and channel containers

add_channel(attributes_dict: Dict[str, Any], channel: str, add_now: bool = True) → ChannelObject | None[source]#

Add channel.

Parameters:

attributes_dict (Dict[str, Any]) – Channel attributes.
channel (str) – Channel name.
add_now (bool, optional) – Whether the channel should be added now.
True. (Defaults to) –

Raises:

ConnectionError – If a connection error occurred while adding the channel.

Returns:

Channel object or None if adding later.

Return type:

Union[ChannelObject, None]

add_command(arg1: Dict[str, Any], arg2: str | None = None, add_now: bool = True) → CommandObject | None[source]#

Add command.

Parameters:

arg1 (Dict[str, Any]) – Command attributes.
arg2 (Optional[str], optional) – Command name. Defaults to None.
add_now (bool, optional) – Whether to add command now. Defaults to True.

Raises:

ConnectionError – If a connection error occurred while adding the command.

Returns:

Command object or None if adding later.

Return type:

Union[CommandObject, None]

execute_command(command_name: str, *args, **kwargs) → Any[source]#

Execute command.

Parameters:

command_name (str) – Command name.
*args (tuple) – Arguments to pass through to the command to be executed.
**kwargs (Dict[str, Any]) – Named arguments to pass through to the
executed. (command to be) –

Raises:

AttributeError – If command not found.

Returns:

Execution output.

Return type:

Any

get_channel_names_list() → List[str][source]#

Get a list of all channel names.

Returns:: Channel names.
Return type:: List[str]

get_channel_object(channel_name: str, optional: bool = False) → ChannelObject | None[source]#

Get channel.

Parameters:

channel_name (str) – Channel name.
optional (bool, optional) – If a missing channel should be logged
False. (as an error. Defaults to) –

Returns:

Channel object or None if not found.

Return type:

Union[ChannelObject, None]

get_channel_value(channel_name: str) → Any[source]#

Get channel value.

Parameters:: channel_name (str) – Channel name.
Returns:: Channel value.
Return type:: Any

get_channels() → Generator[ChannelObject, None, None][source]#

Get object channels.

Yields:: Generator[ChannelObject, None, None] – Object channels.
Return type:: Generator[ChannelObject, None, None]

get_command_names_list() → List[str][source]#

Get list of command names.

Returns:: Command names.
Return type:: List[str]

get_command_object(cmd_name: str) → CommandObject | None[source]#

Get command object.

Parameters:: cmd_name (str) – Command name.
Returns:: Command object or None if not found.
Return type:: Union[CommandObject, None]

get_commands() → Generator[CommandObject, None, None][source]#

Get object commands.

Yields:: Generator[CommandObject, None, None] – Command objects.
Return type:: Generator[CommandObject, None, None]

set_channel_value(channel_name: str, value: Any) → None[source]#

Set channel value.

Parameters:

channel_name (str) – Channel name.
value (Any) – Value to set.

Return type:

None

class mxcubecore.CommandContainer.CommandObject(name: str, username: str | None = None, **kwargs)[source]#

Bases: object

Command launcher base class

Parameters:

name (str) –
username (str | None) –

add_argument(argName: str, argType: str, combo_items: Any | None = None, onchange: Any | None = None, valuefrom: Any | None = None) → None[source]#

Add command argument.

Parameters:

argName (str) – Name.
argType (str) – Type.
combo_items (Optional[Any], optional) – Combo items. Defaults to None.
onchange (Optional[Any], optional) – On change. Defaults to None.
valuefrom (Optional[Any], optional) – Value from. Defaults to None.

Return type:

None

connect(signal_name: str, callable_func: Callable) → None[source]#

Connect to signal.

Parameters:

signal_name (str) – Signal name.
callable_func (Callable) – Connection method.

Return type:

None

emit(signal: str, *args) → None[source]#

Emit signal message.

Parameters:

signal (str) – Signal name.
*args (tuple) – Message arguments.

Return type:

None

get_arguments() → List[Tuple[str, str, Any, Any]] | Any[source]#

Get command arguments.

Returns:: Command arguments.
Return type:: Union[List[Tuple[str, str, Any, Any]], Any]

get_combo_argument_items(argName: str) → Any[source]#

Get combo argument items.

Parameters:: argName (str) – Combo argument name.
Returns:: Combo argument value.
Return type:: Any

is_connected() → bool[source]#

Check if signal is connected.

Returns:: True if connected, else False.
Return type:: bool

name() → str[source]#

Get command name.

Returns:: Command name.
Return type:: str

set_argument_json_schema(json_schema_str: Any) → None[source]#

Set the JSON Schema.

Parameters:: json_schema_str (Any) – JSON Schema.
Return type:: None

userName() → str[source]#

Get user name.

Returns:: User name.
Return type:: str

exception mxcubecore.CommandContainer.ConnectionError[source]#

Bases: Exception

General Connection Error