# avocado_varianter_yaml_to_mux package¶

## avocado_varianter_yaml_to_mux.mux module¶

This file contains mux-enabled implementations of parts useful for creating a custom Varianter plugin.

class avocado_varianter_yaml_to_mux.mux.Control(code, value=None)

Bases: object

Container used to identify node vs. control sequence

class avocado_varianter_yaml_to_mux.mux.MuxPlugin

Bases: object

Base implementation of Mux-like Varianter plugin. It should be used as a base class in conjunction with avocado.core.plugin_interfaces.Varianter.

debug = None
default_params = None
initialize_mux(root, paths, debug)

Initialize the basic values

Note: We can’t use __init__ as this object is intended to be used via dispatcher with no __init__ arguments.
paths = None
root = None
to_str(summary, variants, **kwargs)
update_defaults(defaults)
variants = None
class avocado_varianter_yaml_to_mux.mux.MuxTree(root)

Bases: object

Object representing part of the tree from the root to leaves or another multiplex domain. Recursively it creates multiplexed variants of the full tree.

Parameters: root – Root of this tree slice
iter_variants()

Iterates through variants without verifying the internal filters

:yield all existing variants

class avocado_varianter_yaml_to_mux.mux.MuxTreeNode(name='', value=None, parent=None, children=None)

Class for bounding nodes into tree-structure with support for multiplexation

fingerprint()

Reports string which represents the value of this node.

merge(other)

Merges other node into this one without checking the name of the other node. New values are appended, existing values overwritten and unaffected ones are kept. Then all other node children are added as children (recursively they get either appended at the end or merged into existing node in the previous position.

class avocado_varianter_yaml_to_mux.mux.MuxTreeNodeDebug(name='', value=None, parent=None, children=None, srcyaml=None)

Debug version of TreeNodeDebug :warning: Origin of the value is appended to all values thus it’s not suitable for running tests.

merge(other)

Merges other node into this one without checking the name of the other node. New values are appended, existing values overwritten and unaffected ones are kept. Then all other node children are added as children (recursively they get either appended at the end or merged into existing node in the previous position.

class avocado_varianter_yaml_to_mux.mux.OutputList(values, nodes, yamls)

Bases: list

List with some debug info

class avocado_varianter_yaml_to_mux.mux.OutputValue(value, node, srcyaml)

Bases: object

Ordinary value with some debug info

class avocado_varianter_yaml_to_mux.mux.TreeNodeDebug(name='', value=None, parent=None, children=None, srcyaml=None)

Debug version of TreeNodeDebug :warning: Origin of the value is appended to all values thus it’s not suitable for running tests.

merge(other)

Override origin with the one from other tree. Updated/Newly set values are going to use this location as origin.

class avocado_varianter_yaml_to_mux.mux.ValueDict(srcyaml, node, values)

Bases: dict

Dict which stores the origin of the items

items()

Slower implementation with the use of __getitem__

iteritems()

Slower implementation with the use of __getitem__

avocado_varianter_yaml_to_mux.mux.apply_filters(root, filter_only=None, filter_out=None)

Apply a set of filters to the tree.

The basic filtering is filter only, which includes nodes, and the filter out rules, that exclude nodes.

Note that filter_out is stronger than filter_only, so if you filter out something, you could not bypass some nodes by using a filter_only rule.

Parameters: root – Root node of the multiplex tree. filter_only – the list of paths which will include nodes. filter_out – the list of paths which will exclude nodes. the original tree minus the nodes filtered by the rules.
avocado_varianter_yaml_to_mux.mux.path_parent(path)

From a given path, return its parent path.

Parameters: path – the node path as string. the parent path as string.

## Module contents¶

Varianter plugin to parse yaml files to params

class avocado_varianter_yaml_to_mux.ListOfNodeObjects

Bases: list

Used to mark list as list of objects from whose node is going to be created

class avocado_varianter_yaml_to_mux.YamlToMux

Processes the mux options into varianter plugin

description = 'Multiplexer plugin to parse yaml files to params'
initialize(args)
name = 'yaml_to_mux'
class avocado_varianter_yaml_to_mux.YamlToMuxCLI

Defines arguments for YamlToMux plugin

configure(parser)

Configures “run” and “variants” subparsers

description = "YamlToMux options for the 'run' subcommand"
name = 'yaml_to_mux'
run(args)

The YamlToMux varianter plugin handles these

avocado_varianter_yaml_to_mux.create_from_yaml(paths, debug=False)

Create tree structure from yaml-like file :param fileobj: File object to be processed :raise SyntaxError: When yaml-file is corrupted :return: Root of the created tree structure

avocado_varianter_yaml_to_mux.get_named_tree_cls(path, klass)

Return TreeNodeDebug class with hardcoded yaml path