Momotor Engine Options

momotor-engine-options reads the options that configure a Momotor check. Recipes, configurations, products, and results are bundles. A bundle can carry options such as a time limit or a tool version. This package finds the value that applies to the current task and converts it to the type your code needs.

Use this package when you write a checklet, a scheduler, or another Momotor tool that reads options from bundles. Recipe authors use it indirectly. The option values in their recipes use the reference syntax that this package parses.

Key concepts

An option has a name and a domain, such as timeout in the checklet domain. An OptionDefinition describes how to read one option. It names the bundles to search, the value type, and a default. Providers holds the bundles and the current task for one lookup. The Glossary defines these and the other terms used in this documentation.

Start with Resolve your first option to resolve an option in Python. Option definitions then explains the lookup order in detail. For recipe authors, Element reference syntax describes references and selectors, and Domains and options lists the built-in option domains.

Install

Install the package in your virtual environment:

python -m pip install momotor-engine-options

The package requires Python 3.11 through 3.14 and momotor-bundles version 9.

Changed in version 3.0.0: The package now requires momotor-bundles version 9 and Python 3.11 or newer. Python 3.10 and momotor-bundles version 8 are no longer supported.

Contents

Appendix

The pages in this appendix are API references for the parser, utility, and documentation helpers. You need them when you call these modules directly or extend them. The main pages above link here where relevant.

Indices and tables