API

CLI and Plugins

OpenPathSamplingCLI(*args, **kwargs)

Main class for the command line interface

plugin_management.CLIPluginLoader(…)

Abstract object for CLI plugins

plugin_management.FilePluginLoader(search_path)

File-based plugins (quick and dirty)

plugin_management.NamespacePluginLoader(…)

Load namespace plugins (plugins for wide distribution)

Parameter Decorators

These are the functions used to create the reusable parameter decorators. Note that you will probably never need to use these; instead, use the existing parameter decorators.

param_core.Option(*args, **kwargs)

Wrapper for click.option decorators

param_core.Argument(*args, **kwargs)

Wrapper for click.argument decorators

param_core.AbstractLoader(param)

Abstract object for getting relevant OPS object from the CLI.

param_core.StorageLoader(param, mode)

Open an OPS storage file

param_core.OPSStorageLoadNames(param, store)

Simple loader that expects its input to be a name or index.

param_core.OPSStorageLoadSingle(param, store)

Objects that expect to load a single object.

Search strategies

These are the various strategies for finding objects in a storage, in particular if we have to guess because the user didn’t provide an explicit choice or didn’t tag.

param_core.Getter(store_name)

Abstract strategy for getting things from storage

param_core.GetByName(store_name)

Strategy using the CLI input as name for a stored item

param_core.GetByNumber(store_name)

Strategy using the CLI input as numeric index of the stored item

param_core.GetPredefinedName(store_name, name)

Strategy predefining name and store, allow default names

param_core.GetOnly(store_name)

Strategy getting item from store if it is the only one

param_core.GetOnlyNamed(store_name)

Strategy selecting item from store if it is the only named item

param_core.GetOnlySnapshot([store_name])

Strategy selecting only snapshot from a snapshot store