Option definitions

class momotor.options.OptionDefinition(name, type=None, doc=None, required=False, multiple=False, all=False, location=None, domain=None, default=<object object>, enable=True, deprecated=None)

Definition of an option.

Options are provided by steps, recipes, configs and products. When resolving the option to a value, these are inspected based on the location attribute. Depending on the other settings like multiple and required one or more option values are returned when resolving the option.

resolve(providers, subdomains=None)

Resolve the value of this option by inspecting the options of the providers.

Sub-domains to look for can be specified for each provider. Options including a specified sub-domain take priority over options without the sub-domain.

If the subdomains option is not provided, a default is generated from the providers.task_id value if this is specified. To disable the default subdomains, set subdomains to False

Parameters:

  • providers (Providers) – The providers

  • subdomains (Mapping[Literal['step', 'recipe', 'config', 'product'], str | Sequence[str | None] | None] | bool | None) – For each provider, a sequence of subdomains to take into account when looking for options. Merged with domain. Missing values and empty sequences are interpreted as containing None. If not set or True, generates subdomains based on providers.task_id. Set to False to disable generation of subdomains.

Return type:

Any

Returns:

The resolved option value. A tuple of values if multiple is True.

NO_DEFAULT: ClassVar[object] = <object object>

Sentinel indicating there is no default

all: bool = False

When multiple is True, resolve() will match the first provider in location that defines an option with the correct name and domain. Set all to True to resolve all matching options of all providers listed in location. Has no effect when multiple is False.

default: Any = <object object>

The default value if the option is not provided by any provider.

deprecated: str | None = None

If this option is deprecated, set to the reason for deprecation. Should describe which option(s) - if any - replace this option

doc: str | None = None

Documentation of the option

domain: str | None = None

The domain of the option: Momotor defines the following values for domain:

  • checklet: (Default) Options defined and used by checklets.

  • scheduler: Options used by the Momotor Broker for executing and scheduling the step.

  • tools: Options used by the Momotor Broker to declare tools used by the checklet.

  • x-…: “Experimental”, or private use domains

Domain names starting with x- can be used for private use cases. All other domain names are reserved for use by Momotor in the future.

Cannot have a subdomain. Required (but can be provided through the name argument)

enable: bool = True

If False this OptionDefinition will be disabled (i.e. ignored as if it was not listed)

property fullname: OptionNameDomain

Full name, including domain

location: str | Sequence[str] | None = None

The names and order of the providers resolve() looks for the options. Can be provided as a comma separated string, or as a sequence of strings. Required. CheckletBaseMeta provides the default. When accessing, will always be a sequence

multiple: bool = False

This option can be provided multiple times. If True, resolve() will return a FilterableTuple of matched options. If False, resolve() will return a single value, or throw a ValueError if multiple options match. Default: False

name: OptionNameDomain | str

Name of the option. Required

required: bool = False

This option is required. If the option is not defined by any of the providers, resolve() will throw a ValueError exception: Default: False

property shortname: str

Commonly used option name. Only includes domain if it is not the default domain

type: Optional[Literal['string', 'boolean', 'integer', 'float']] = None

Expected type of the option. Optional. If not set, the type as given by the <option> node is used as-is. Allowed values: string, integer, float and boolean

class momotor.options.OptionNameDomain(name, domain='checklet')

Name and domain of an option.

classmethod from_qualified_name(name)

Create an OptionNameDomain from a qualified name (i.e. including the domain). If name does not include a domain, the default domain is used.

Return type:

Self

qualified_name()

Return the fully qualified option name (i.e. including the domain)

Return type:

str

short_name()

Return the short name of the option (i.e. without the domain if it is the default domain)

Return type:

str

domain: str = 'checklet'

The domain of the option

name: str

The name of the option