OptionLoader

class sane.options.OptionLoader

Bases: Logger

load_core_options(options, origin=None)

Any processed field should be removed from the options dict, with everything else ignored. All listed options are cummulative and optional unless specified otherwise.

See load_options() for parameters.

Parameters:

• options (dict)

• origin (str)

load_extra_options(options, origin=None)

Load any extra options after load_core_options().

Any processed field should be removed from the options dict, with everything else ignored.

See load_options() for parameters.

Parameters:

• options (dict)

• origin (str)

load_options(options, origin=None)

Base class implementation for loading of dict-based attributes into instance

Take a options dict of relevant attributes and load them via load_core_options() then load_extra_options(). The options dict should be modified in each call to remove processed fields so that at the very end of this method, any unused keys in the options dict may be logged.

The load_extra_options() is meant as a user-overwritable method so that load_core_options() may retain core underlying base class implementation details without the risk of base class loading not being called.

To keep track of every time this function is called and potentially modifying this instance an origin may be provided, noting where the change is coming from.

Parameters:

• options (dict) –

  A dict of class-specific attributes.

  Important

  The options dict is modified such that only unused values are left in it at the end of this method

• origin (str) – A string identifier of where this load is coming from

property origins

A copy of all the workflow file paths (and line numbers if applicable) that formed this object

search_type(type_str, noexcept=False)

Match a type (as an input string) to an actualy python type

If at any point a search is successful, the function immediately returns the found type.

Search priority:

1. type_str using pydoc locate() (effectively search current context for type of that fully qualified name )

2. Split type_str on last . in name and search any user-loaded module that contains the prefix for an attribute matching the suffix. If no split occurs all user modules are searched.

Valid type examples:

import sane
import user_mod.nested.foo # module foo has CustomType

# ... in the context of this class ...
self.search_type( "sane.Action" )
self.search_type( "sane.host.Host" )
self.search_type( "user_mod.nested.foo.CustomType" )
# Using search method (2) if foo was loaded into the user modules by the workflow
# since "foo" is a substring of "user_mod.nested.foo"
self.search_type( "foo.CustomType" )

Returns:

type corresponding to the type_str

Parameters:

type_str (str)