| |
| |
| <!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.reading — 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.validation" href="aria.parser.validation.html"/> |
| <link rel="prev" title="aria.parser.presentation" href="aria.parser.presentation.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"><a class="reference internal" href="aria.parser.consumption.html"><code class="docutils literal"><span class="pre">aria.parser.consumption</span></code></a></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 current"><a class="current reference internal" href="#"><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.reading</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/aria.parser.reading.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.reading"> |
| <span id="aria-parser-reading"></span><h1><a class="reference internal" href="#module-aria.parser.reading" title="aria.parser.reading"><code class="xref py py-mod docutils literal"><span class="pre">aria.parser.reading</span></code></a><a class="headerlink" href="#module-aria.parser.reading" title="Permalink to this headline">¶</a></h1> |
| <p>Reading 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.reading.ReadingContext" title="aria.parser.reading.ReadingContext"><code class="xref py py-obj docutils literal"><span class="pre">aria.parser.reading.ReadingContext</span></code></a></td> |
| <td>Reading context.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.reading.ReaderException" title="aria.parser.reading.ReaderException"><code class="xref py py-obj docutils literal"><span class="pre">ReaderException</span></code></a></td> |
| <td>ARIA reader exception.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.reading.ReaderNotFoundError" title="aria.parser.reading.ReaderNotFoundError"><code class="xref py py-obj docutils literal"><span class="pre">ReaderNotFoundError</span></code></a></td> |
| <td>ARIA reader error: reader not found for source.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.reading.ReaderSyntaxError" title="aria.parser.reading.ReaderSyntaxError"><code class="xref py py-obj docutils literal"><span class="pre">ReaderSyntaxError</span></code></a></td> |
| <td>ARIA read format error.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.reading.AlreadyReadException" title="aria.parser.reading.AlreadyReadException"><code class="xref py py-obj docutils literal"><span class="pre">AlreadyReadException</span></code></a></td> |
| <td>ARIA reader exception: already read.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.reading.JinjaReader" title="aria.parser.reading.JinjaReader"><code class="xref py py-obj docutils literal"><span class="pre">JinjaReader</span></code></a></td> |
| <td>ARIA Jinja reader.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.reading.JsonReader" title="aria.parser.reading.JsonReader"><code class="xref py py-obj docutils literal"><span class="pre">JsonReader</span></code></a></td> |
| <td>ARIA JSON reader.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.reading.Locator" title="aria.parser.reading.Locator"><code class="xref py py-obj docutils literal"><span class="pre">Locator</span></code></a></td> |
| <td>Stores location information (line and column numbers) for agnostic raw data.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.reading.deepcopy_with_locators" title="aria.parser.reading.deepcopy_with_locators"><code class="xref py py-obj docutils literal"><span class="pre">deepcopy_with_locators</span></code></a></td> |
| <td>Like <code class="xref py py-func docutils literal"><span class="pre">deepcopy()</span></code>, but also copies over locators.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.reading.copy_locators" title="aria.parser.reading.copy_locators"><code class="xref py py-obj docutils literal"><span class="pre">copy_locators</span></code></a></td> |
| <td>Copies over <code class="docutils literal"><span class="pre">_locator</span></code> for all elements, recursively.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.reading.RawReader" title="aria.parser.reading.RawReader"><code class="xref py py-obj docutils literal"><span class="pre">RawReader</span></code></a></td> |
| <td>ARIA raw reader.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.reading.Reader" title="aria.parser.reading.Reader"><code class="xref py py-obj docutils literal"><span class="pre">Reader</span></code></a></td> |
| <td>Base class for ARIA readers.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.reading.ReaderSource" title="aria.parser.reading.ReaderSource"><code class="xref py py-obj docutils literal"><span class="pre">ReaderSource</span></code></a></td> |
| <td>Base class for ARIA reader sources.</td> |
| </tr> |
| <tr class="row-even"><td><a class="reference internal" href="#aria.parser.reading.DefaultReaderSource" title="aria.parser.reading.DefaultReaderSource"><code class="xref py py-obj docutils literal"><span class="pre">DefaultReaderSource</span></code></a></td> |
| <td>The default ARIA reader source will generate a <a class="reference internal" href="#aria.parser.reading.YamlReader" title="aria.parser.reading.YamlReader"><code class="xref py py-class docutils literal"><span class="pre">YamlReader</span></code></a> for locations that end in “.yaml”, a <a class="reference internal" href="#aria.parser.reading.JsonReader" title="aria.parser.reading.JsonReader"><code class="xref py py-class docutils literal"><span class="pre">JsonReader</span></code></a> for locations that end in “.json”, and a <a class="reference internal" href="#aria.parser.reading.JinjaReader" title="aria.parser.reading.JinjaReader"><code class="xref py py-class docutils literal"><span class="pre">JinjaReader</span></code></a> for locations that end in “.jinja”.</td> |
| </tr> |
| <tr class="row-odd"><td><a class="reference internal" href="#aria.parser.reading.YamlReader" title="aria.parser.reading.YamlReader"><code class="xref py py-obj docutils literal"><span class="pre">YamlReader</span></code></a></td> |
| <td>ARIA YAML reader.</td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="exception"> |
| <dt id="aria.parser.reading.ReaderException"> |
| <em class="property">exception </em><code class="descclassname">aria.parser.reading.</code><code class="descname">ReaderException</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.reading.ReaderException" 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 reader exception.</p> |
| </dd></dl> |
| |
| <dl class="exception"> |
| <dt id="aria.parser.reading.ReaderNotFoundError"> |
| <em class="property">exception </em><code class="descclassname">aria.parser.reading.</code><code class="descname">ReaderNotFoundError</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.reading.ReaderNotFoundError" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.exceptions.ReaderException</span></code></p> |
| <p>ARIA reader error: reader not found for source.</p> |
| </dd></dl> |
| |
| <dl class="exception"> |
| <dt id="aria.parser.reading.ReaderSyntaxError"> |
| <em class="property">exception </em><code class="descclassname">aria.parser.reading.</code><code class="descname">ReaderSyntaxError</code><span class="sig-paren">(</span><em>message</em>, <em>cause=None</em>, <em>cause_tb=None</em>, <em>location=None</em>, <em>line=None</em>, <em>column=None</em>, <em>locator=None</em>, <em>snippet=None</em>, <em>level=1</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.ReaderSyntaxError" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.exceptions.ReaderException</span></code></p> |
| <p>ARIA read format error.</p> |
| </dd></dl> |
| |
| <dl class="exception"> |
| <dt id="aria.parser.reading.AlreadyReadException"> |
| <em class="property">exception </em><code class="descclassname">aria.parser.reading.</code><code class="descname">AlreadyReadException</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.reading.AlreadyReadException" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.exceptions.ReaderException</span></code></p> |
| <p>ARIA reader exception: already read.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.Reader"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">Reader</code><span class="sig-paren">(</span><em>context</em>, <em>location</em>, <em>loader</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Reader" 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 readers.</p> |
| <p>Readers provide agnostic raw data by consuming <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">aria.parser.loading.Loader</span></code></a> instances.</p> |
| <dl class="method"> |
| <dt id="aria.parser.reading.Reader.load"> |
| <code class="descname">load</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Reader.load" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.reading.Reader.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Reader.read" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.ReaderSource"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">ReaderSource</code><a class="headerlink" href="#aria.parser.reading.ReaderSource" 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 reader sources.</p> |
| <p>Reader sources provide appropriate <a class="reference internal" href="#aria.parser.reading.Reader" title="aria.parser.reading.Reader"><code class="xref py py-class docutils literal"><span class="pre">Reader</span></code></a> instances for locations.</p> |
| <dl class="staticmethod"> |
| <dt id="aria.parser.reading.ReaderSource.get_reader"> |
| <em class="property">static </em><code class="descname">get_reader</code><span class="sig-paren">(</span><em>context</em>, <em>location</em>, <em>loader</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.ReaderSource.get_reader" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.DefaultReaderSource"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">DefaultReaderSource</code><span class="sig-paren">(</span><em>literal_reader_class=<class 'aria.parser.reading.yaml.YamlReader'></em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.DefaultReaderSource" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.source.ReaderSource</span></code></p> |
| <p>The default ARIA reader source will generate a <a class="reference internal" href="#aria.parser.reading.YamlReader" title="aria.parser.reading.YamlReader"><code class="xref py py-class docutils literal"><span class="pre">YamlReader</span></code></a> for |
| locations that end in “.yaml”, a <a class="reference internal" href="#aria.parser.reading.JsonReader" title="aria.parser.reading.JsonReader"><code class="xref py py-class docutils literal"><span class="pre">JsonReader</span></code></a> for locations that |
| end in “.json”, and a <a class="reference internal" href="#aria.parser.reading.JinjaReader" title="aria.parser.reading.JinjaReader"><code class="xref py py-class docutils literal"><span class="pre">JinjaReader</span></code></a> for locations that end in |
| “.jinja”.</p> |
| <dl class="method"> |
| <dt id="aria.parser.reading.DefaultReaderSource.get_reader"> |
| <code class="descname">get_reader</code><span class="sig-paren">(</span><em>context</em>, <em>location</em>, <em>loader</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.DefaultReaderSource.get_reader" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.ReadingContext"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">ReadingContext</code><a class="headerlink" href="#aria.parser.reading.ReadingContext" 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>Reading 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>reader_source</strong> (<em>ReaderSource</em>) – for finding reader instances</li> |
| <li><strong>reader</strong> (<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#type" title="(in Python v2.7)"><em>type</em></a>) – overrides <code class="docutils literal"><span class="pre">reader_source</span></code> with a specific class</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.RawReader"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">RawReader</code><span class="sig-paren">(</span><em>context</em>, <em>location</em>, <em>loader</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.RawReader" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.reader.Reader</span></code></p> |
| <p>ARIA raw reader.</p> |
| <p>Expects to receive agnostic raw data from the loader, and so does nothing to it.</p> |
| <dl class="method"> |
| <dt id="aria.parser.reading.RawReader.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.RawReader.read" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.Locator"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">Locator</code><span class="sig-paren">(</span><em>location</em>, <em>line</em>, <em>column</em>, <em>children=None</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Locator" 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>Stores location information (line and column numbers) for agnostic raw data.</p> |
| <dl class="method"> |
| <dt id="aria.parser.reading.Locator.dump"> |
| <code class="descname">dump</code><span class="sig-paren">(</span><em>key=None</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Locator.dump" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.reading.Locator.get_child"> |
| <code class="descname">get_child</code><span class="sig-paren">(</span><em>*names</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Locator.get_child" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.reading.Locator.link"> |
| <code class="descname">link</code><span class="sig-paren">(</span><em>raw</em>, <em>path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Locator.link" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="aria.parser.reading.Locator.merge"> |
| <code class="descname">merge</code><span class="sig-paren">(</span><em>locator</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.Locator.merge" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="aria.parser.reading.deepcopy_with_locators"> |
| <code class="descclassname">aria.parser.reading.</code><code class="descname">deepcopy_with_locators</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.deepcopy_with_locators" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Like <code class="xref py py-func docutils literal"><span class="pre">deepcopy()</span></code>, but also copies over locators.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="aria.parser.reading.copy_locators"> |
| <code class="descclassname">aria.parser.reading.</code><code class="descname">copy_locators</code><span class="sig-paren">(</span><em>target</em>, <em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.copy_locators" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Copies over <code class="docutils literal"><span class="pre">_locator</span></code> for all elements, recursively.</p> |
| <p>Assumes that target and source have exactly the same list/dict structure.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.YamlReader"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">YamlReader</code><span class="sig-paren">(</span><em>context</em>, <em>location</em>, <em>loader</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.YamlReader" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.reader.Reader</span></code></p> |
| <p>ARIA YAML reader.</p> |
| <dl class="method"> |
| <dt id="aria.parser.reading.YamlReader.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.YamlReader.read" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.JsonReader"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">JsonReader</code><span class="sig-paren">(</span><em>context</em>, <em>location</em>, <em>loader</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.JsonReader" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.reader.Reader</span></code></p> |
| <p>ARIA JSON reader.</p> |
| <dl class="method"> |
| <dt id="aria.parser.reading.JsonReader.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.JsonReader.read" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.parser.reading.JinjaReader"> |
| <em class="property">class </em><code class="descclassname">aria.parser.reading.</code><code class="descname">JinjaReader</code><span class="sig-paren">(</span><em>context</em>, <em>location</em>, <em>loader</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.JinjaReader" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">aria.parser.reading.reader.Reader</span></code></p> |
| <p>ARIA Jinja reader.</p> |
| <p>Forwards the rendered result to a new reader in the reader source.</p> |
| <dl class="method"> |
| <dt id="aria.parser.reading.JinjaReader.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.parser.reading.JinjaReader.read" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| <div class="articleComments"> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="aria.parser.validation.html" class="btn btn-neutral float-right" title="aria.parser.validation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="aria.parser.presentation.html" class="btn btn-neutral" title="aria.parser.presentation" 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> |
