xylem.specs package

Submodules

xylem.specs.impl module

class xylem.specs.impl.Spec

Bases: xylem.plugin_utils.PluginBase

Spec plugin abstract base class.

Spec plugins are stateless classes such that all functions get are their needed parameters passed on every invocation.

The data and arguments (e.g. url for the ‘rules’ spec plugin) are managed by the sources.database.RulesSource class in the sources.database.RulesDatabase.

is_data_outdated(data, arguments, data_load_time)

keys(data, installer_context)

Return list of keys defined for current os/version.

load_data(arguments)

lookup(data, xylem_key, installer_context)

name

unique_id(arguments)

verify_arguments(arguments)

verify_data(data, arguments)

version

xylem.specs.impl.get_spec_plugin_list()

Return list of spec plugin objects unique by name.

See get_plugin_list()

xylem.specs.impl.verify_spec_name(spec_name)

Verify that a spec_name is valid spec name.

Parameters:spec_name (str) – spec name Raises ValueError:  if spec name is invalid

xylem.specs.rules module

Module contents

xylem.specs.get_spec_plugin_list()

Return list of spec plugin objects unique by name.

See get_plugin_list()

exception xylem.specs.SpecParsingError(msg, related_snippet=None)

Bases: builtins.ValueError

Raised when an invalid spec element is encountered while parsing.

xylem.specs.verify_spec_name(spec_name)

Verify that a spec_name is valid spec name.

Parameters:spec_name (str) – spec name Raises ValueError:  if spec name is invalid

class xylem.specs.Spec

Bases: xylem.plugin_utils.PluginBase

Spec plugin abstract base class.

Spec plugins are stateless classes such that all functions get are their needed parameters passed on every invocation.

The data and arguments (e.g. url for the ‘rules’ spec plugin) are managed by the sources.database.RulesSource class in the sources.database.RulesDatabase.

is_data_outdated(data, arguments, data_load_time)

keys(data, installer_context)

Return list of keys defined for current os/version.

load_data(arguments)

lookup(data, xylem_key, installer_context)

name

unique_id(arguments)

verify_arguments(arguments)

verify_data(data, arguments)

version