| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>aria.parser.consumption — ARIA TOSCA 0.1.1 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <link rel="index" title="Index" |
| href="genindex.html"/> |
| <link rel="search" title="Search" href="search.html"/> |
| <link rel="top" title="ARIA TOSCA 0.1.1 documentation" href="index.html"/> |
| <link rel="next" title="aria.parser.loading" href="aria.parser.loading.html"/> |
| <link rel="prev" title="aria.parser" href="aria.parser.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> ARIA TOSCA |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 0.1.1 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="cli.html">CLI</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="rest.html">REST</a></li> |
| </ul> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="aria.html"><code class="docutils literal"><span class="pre">aria</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.cli.html"><code class="docutils literal"><span class="pre">aria.cli</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.modeling.html"><code class="docutils literal"><span class="pre">aria.modeling</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.modeling.models.html"><code class="docutils literal"><span class="pre">aria.modeling.models</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.html"><code class="docutils literal"><span class="pre">aria.orchestrator</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.context.html"><code class="docutils literal"><span class="pre">aria.orchestrator.context</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ctx_proxy.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ctx_proxy</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ssh.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ssh</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.api.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.api</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.builtin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.builtin</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.executor.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.html"><code class="docutils literal"><span class="pre">aria.parser</span></code></a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">aria.parser.consumption</span></code></a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#consumers">Consumers</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.loading.html"><code class="docutils literal"><span class="pre">aria.parser.loading</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.modeling.html"><code class="docutils literal"><span class="pre">aria.parser.modeling</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.presentation.html"><code class="docutils literal"><span class="pre">aria.parser.presentation</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.reading.html"><code class="docutils literal"><span class="pre">aria.parser.reading</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.validation.html"><code class="docutils literal"><span class="pre">aria.parser.validation</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.storage.html"><code class="docutils literal"><span class="pre">aria.storage</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.utils.html"><code class="docutils literal"><span class="pre">aria.utils</span></code></a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.modeling.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.modeling</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.presentation.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.presentation</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_nfv_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_nfv_v1_0</span></code></a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">ARIA TOSCA</a> |
| |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li><code class="docutils literal"><span class="pre">aria.parser.consumption</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/aria.parser.consumption.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-aria.parser.consumption"> |
| <span id="aria-parser-consumption"></span><h1><a class="reference internal" href="#module-aria.parser.consumption" title="aria.parser.consumption"><code class="xref py py-mod docutils literal"><span class="pre">aria.parser.consumption</span></code></a><a class="headerlink" href="#module-aria.parser.consumption" title="Permalink to this headline">¶</a></h1> |
| <p>Consumption package.</p> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%" /> |
| <col width="90%" /> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.ConsumptionContext" title="aria.parser.consumption.ConsumptionContext"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ConsumptionContext</span></code></a></td> |
| <td>Consumption context.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.consumption.Style" title="aria.parser.consumption.Style"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.Style</span></code></a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="section" id="consumers"> |
| <h2>Consumers<a class="headerlink" href="#consumers" title="Permalink to this headline">¶</a></h2> |
| <table border="1" class="longtable docutils"> |
| <colgroup> |
| <col width="10%" /> |
| <col width="90%" /> |
| </colgroup> |
| <tbody valign="top"> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.Consumer" title="aria.parser.consumption.Consumer"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.Consumer</span></code></a></td> |
| <td>Base class for ARIA consumers.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.consumption.ConsumerChain" title="aria.parser.consumption.ConsumerChain"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ConsumerChain</span></code></a></td> |
| <td>ARIA consumer chain.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.ConsumerException" title="aria.parser.consumption.ConsumerException"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ConsumerException</span></code></a></td> |
| <td>ARIA consumer exception.</td> |
| </tr> |
| <tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.Inputs</span></code></td> |
| <td>Fills in the inputs if provided as arguments.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.ServiceTemplate" title="aria.parser.consumption.ServiceTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ServiceTemplate</span></code></a></td> |
| <td>Generates the service template from the presenter.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.consumption.Types" title="aria.parser.consumption.Types"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.Types</span></code></a></td> |
| <td>Used to just dump the types.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.CoerceServiceInstanceValues" title="aria.parser.consumption.CoerceServiceInstanceValues"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.CoerceServiceInstanceValues</span></code></a></td> |
| <td>Coerces values in the service instance.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.consumption.ValidateServiceInstance" title="aria.parser.consumption.ValidateServiceInstance"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ValidateServiceInstance</span></code></a></td> |
| <td>Validates the service instance.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.SatisfyRequirements" title="aria.parser.consumption.SatisfyRequirements"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.SatisfyRequirements</span></code></a></td> |
| <td>Satisfies node requirements in the service instance.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.consumption.ValidateCapabilities" title="aria.parser.consumption.ValidateCapabilities"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ValidateCapabilities</span></code></a></td> |
| <td>Validates capabilities in the service instance.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.FindHosts" title="aria.parser.consumption.FindHosts"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.FindHosts</span></code></a></td> |
| <td>Find hosts for all nodes in the service instance.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.consumption.ConfigureOperations" title="aria.parser.consumption.ConfigureOperations"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ConfigureOperations</span></code></a></td> |
| <td>Configures all operations in the service instance.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.ServiceInstance" title="aria.parser.consumption.ServiceInstance"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.ServiceInstance</span></code></a></td> |
| <td>Generates the service instance by instantiating the service template.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.consumption.Read" title="aria.parser.consumption.Read"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.Read</span></code></a></td> |
| <td>Reads the presentation, handling imports recursively.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.consumption.Validate" title="aria.parser.consumption.Validate"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.consumption.Validate</span></code></a></td> |
| <td>Validates the presentation.</td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="exception"> |
| <dt id="aria.parser.consumption.ConsumerException"> |
| <em class="property">exception </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ConsumerException</code><span class="sig-paren">(</span><em>message=None</em>, <em>cause=None</em>, <em>cause_traceback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumerException" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="aria.html#aria.exceptions.AriaException" title="aria.exceptions.AriaException"><code class="xref py py-class docutils literal"><span class="pre">aria.exceptions.AriaException</span></code></a></p> |
| <p>ARIA consumer exception.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.ConsumptionContext"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ConsumptionContext</code><span class="sig-paren">(</span><em>set_thread_local=True</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumptionContext" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/2.7/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p> |
| <p>Consumption context.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Variables:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>args</strong> – runtime arguments (usually provided on the command line)</li> |
| <li><strong>out</strong> – message output stream (defaults to stdout)</li> |
| <li><strong>style</strong> (<em>Style</em>) – message output style</li> |
| <li><strong>validation</strong> (<code class="xref py py-class docutils literal"><span class="pre">ValidationContext</span></code>) – validation context</li> |
| <li><strong>loading</strong> (<code class="xref py py-class docutils literal"><span class="pre">LoadingContext</span></code>) – loading context</li> |
| <li><strong>reading</strong> (<code class="xref py py-class docutils literal"><span class="pre">ReadingContext</span></code>) – reading context</li> |
| <li><strong>presentation</strong> (<code class="xref py py-class docutils literal"><span class="pre">PresentationContext</span></code>) – presentation context</li> |
| <li><strong>modeling</strong> (<code class="xref py py-class docutils literal"><span class="pre">ModelingContext</span></code>) – modeling context</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConsumptionContext.get_arg_value"> |
| <code class="descname">get_arg_value</code><span class="sig-paren">(</span><em>name</em>, <em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumptionContext.get_arg_value" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConsumptionContext.get_arg_value_int"> |
| <code class="descname">get_arg_value_int</code><span class="sig-paren">(</span><em>name</em>, <em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumptionContext.get_arg_value_int" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="aria.parser.consumption.ConsumptionContext.get_thread_local"> |
| <em class="property">static </em><code class="descname">get_thread_local</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumptionContext.get_thread_local" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Gets the context attached to the current thread if there is one.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConsumptionContext.has_arg_switch"> |
| <code class="descname">has_arg_switch</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumptionContext.has_arg_switch" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConsumptionContext.set_thread_local"> |
| <code class="descname">set_thread_local</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumptionContext.set_thread_local" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Attaches this context to the current thread.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConsumptionContext.write"> |
| <code class="descname">write</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumptionContext.write" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Writes to our <code class="docutils literal"><span class="pre">out</span></code>, making sure to encode UTF-8 if required.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.Style"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">Style</code><span class="sig-paren">(</span><em>indentation=2</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Style" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/2.7/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p> |
| <dl class="attribute"> |
| <dt id="aria.parser.consumption.Style.indent"> |
| <code class="descname">indent</code><a class="headerlink" href="#aria.parser.consumption.Style.indent" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="aria.parser.consumption.Style.literal"> |
| <em class="property">static </em><code class="descname">literal</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Style.literal" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="aria.parser.consumption.Style.meta"> |
| <em class="property">static </em><code class="descname">meta</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Style.meta" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="aria.parser.consumption.Style.node"> |
| <em class="property">static </em><code class="descname">node</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Style.node" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="aria.parser.consumption.Style.property"> |
| <em class="property">static </em><code class="descname">property</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Style.property" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="aria.parser.consumption.Style.section"> |
| <em class="property">static </em><code class="descname">section</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Style.section" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="aria.parser.consumption.Style.type"> |
| <em class="property">static </em><code class="descname">type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Style.type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.Consumer"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">Consumer</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Consumer" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/2.7/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p> |
| <p>Base class for ARIA consumers.</p> |
| <p>Consumers provide useful functionality by consuming presentations.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.Consumer.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Consumer.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.consumption.Consumer.dump"> |
| <code class="descname">dump</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Consumer.dump" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.ConsumerChain"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ConsumerChain</code><span class="sig-paren">(</span><em>context</em>, <em>consumer_classes=None</em>, <em>handle_exceptions=True</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumerChain" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>ARIA consumer chain.</p> |
| <p>Calls consumers in order, handling exception by calling <code class="docutils literal"><span class="pre">_handle_exception</span></code> on them, and stops |
| the chain if there are any validation issues.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConsumerChain.append"> |
| <code class="descname">append</code><span class="sig-paren">(</span><em>*consumer_classes</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumerChain.append" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConsumerChain.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConsumerChain.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.Read"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">Read</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Read" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Reads the presentation, handling imports recursively.</p> |
| <p>It works by consuming a data source via appropriate <a class="reference internal" href="aria.parser.loading.html#aria.parser.loading.Loader" title="aria.parser.loading.Loader"><code class="xref py py-class docutils literal"><span class="pre">Loader</span></code></a>, |
| <a class="reference internal" href="aria.parser.reading.html#aria.parser.reading.Reader" title="aria.parser.reading.Reader"><code class="xref py py-class docutils literal"><span class="pre">Reader</span></code></a>, and <a class="reference internal" href="aria.parser.presentation.html#aria.parser.presentation.Presenter" title="aria.parser.presentation.Presenter"><code class="xref py py-class docutils literal"><span class="pre">Presenter</span></code></a> |
| instances.</p> |
| <p>It supports agnostic raw data composition for presenters that have |
| <code class="docutils literal"><span class="pre">_get_import_locations</span></code> and <code class="docutils literal"><span class="pre">_merge_import</span></code>.</p> |
| <p>To improve performance, loaders are called asynchronously on separate threads.</p> |
| <p>Note that parsing may internally trigger more than one loading/reading/presentation |
| cycle, for example if the agnostic raw data has dependencies that must also be parsed.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.Read.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Read.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.consumption.Read.dump"> |
| <code class="descname">dump</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Read.dump" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.Validate"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">Validate</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Validate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Validates the presentation.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.Validate.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Validate.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.ServiceTemplate"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ServiceTemplate</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ServiceTemplate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.ConsumerChain</span></code></p> |
| <p>Generates the service template from the presenter.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ServiceTemplate.dump"> |
| <code class="descname">dump</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ServiceTemplate.dump" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.Types"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">Types</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Types" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Used to just dump the types.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.Types.dump"> |
| <code class="descname">dump</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.Types.dump" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.ServiceInstance"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ServiceInstance</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ServiceInstance" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.ConsumerChain</span></code></p> |
| <p>Generates the service instance by instantiating the service template.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ServiceInstance.dump"> |
| <code class="descname">dump</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ServiceInstance.dump" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.FindHosts"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">FindHosts</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.FindHosts" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Find hosts for all nodes in the service instance.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.FindHosts.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.FindHosts.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.ValidateServiceInstance"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ValidateServiceInstance</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ValidateServiceInstance" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Validates the service instance.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ValidateServiceInstance.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ValidateServiceInstance.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.ConfigureOperations"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ConfigureOperations</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConfigureOperations" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Configures all operations in the service instance.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ConfigureOperations.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ConfigureOperations.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.SatisfyRequirements"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">SatisfyRequirements</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.SatisfyRequirements" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Satisfies node requirements in the service instance.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.SatisfyRequirements.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.SatisfyRequirements.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.ValidateCapabilities"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">ValidateCapabilities</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ValidateCapabilities" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Validates capabilities in the service instance.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.ValidateCapabilities.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.ValidateCapabilities.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.consumption.CoerceServiceInstanceValues"> |
| <em class="property">class </em><code class="descclassname">aria.parser.consumption.</code><code class="descname">CoerceServiceInstanceValues</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.CoerceServiceInstanceValues" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.consumption.consumer.Consumer</span></code></p> |
| <p>Coerces values in the service instance.</p> |
| <dl class="method"> |
| <dt id="aria.parser.consumption.CoerceServiceInstanceValues.consume"> |
| <code class="descname">consume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.consumption.CoerceServiceInstanceValues.consume" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div class="articleComments"> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="aria.parser.loading.html" class="btn btn-neutral float-right" title="aria.parser.loading" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="aria.parser.html" class="btn btn-neutral" title="aria.parser" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2016-2017, Apache Software Foundation. |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'0.1.1', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
