/usr/share/doc/python-stetl/html/_modules/stetl/filters/xmlelementreader.html is in python-stetl 1.1+ds-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>stetl.filters.xmlelementreader — Stetl 1.1 documentation</title>
<link rel="stylesheet" href="../../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '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>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">Stetl 1.1 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for stetl.filters.xmlelementreader</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Reads an XML file and returns XML elements.</span>
<span class="c1"># Based on inputs.fileinput.XmlElementStreamFileInput.</span>
<span class="c1">#</span>
<span class="c1"># Author: Frank Steggink</span>
<span class="c1">#</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="k">import</span> <span class="n">deepcopy</span>
<span class="kn">from</span> <span class="nn">stetl.component</span> <span class="k">import</span> <span class="n">Config</span>
<span class="kn">from</span> <span class="nn">stetl.filter</span> <span class="k">import</span> <span class="n">Filter</span>
<span class="kn">from</span> <span class="nn">stetl.util</span> <span class="k">import</span> <span class="n">Util</span><span class="p">,</span> <span class="n">etree</span>
<span class="kn">from</span> <span class="nn">stetl.packet</span> <span class="k">import</span> <span class="n">FORMAT</span>
<span class="n">log</span> <span class="o">=</span> <span class="n">Util</span><span class="o">.</span><span class="n">get_log</span><span class="p">(</span><span class="s1">'xmlelementreader'</span><span class="p">)</span>
<div class="viewcode-block" id="XmlElementReader"><a class="viewcode-back" href="../../../code.html#stetl.filters.xmlelementreader.XmlElementReader">[docs]</a><span class="k">class</span> <span class="nc">XmlElementReader</span><span class="p">(</span><span class="n">Filter</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Extracts XML elements from a file, outputs each feature element in Packet.</span>
<span class="sd"> Parsing is streaming (no internal DOM buildup) so any file size can be handled.</span>
<span class="sd"> Use this class for your big GML files!</span>
<span class="sd"> consumes=FORMAT.string, produces=FORMAT.etree_element</span>
<span class="sd"> """</span>
<span class="c1"># Start attribute config meta</span>
<div class="viewcode-block" id="XmlElementReader.element_tags"><a class="viewcode-back" href="../../../code.html#stetl.filters.xmlelementreader.XmlElementReader.element_tags">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">list</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">element_tags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Comma-separated string of XML (feature) element tag names of the elements that should be extracted</span>
<span class="sd"> and added to the output element stream.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="XmlElementReader.strip_namespaces"><a class="viewcode-back" href="../../../code.html#stetl.filters.xmlelementreader.XmlElementReader.strip_namespaces">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">bool</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">required</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">strip_namespaces</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> should namespaces be removed from the input document and thus not be present in the output element stream?</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<span class="c1"># End attribute config meta</span>
<span class="c1"># Constructor</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">configdict</span><span class="p">,</span> <span class="n">section</span><span class="p">):</span>
<span class="n">Filter</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">configdict</span><span class="p">,</span> <span class="n">section</span><span class="p">,</span> <span class="n">consumes</span><span class="o">=</span><span class="n">FORMAT</span><span class="o">.</span><span class="n">string</span><span class="p">,</span> <span class="n">produces</span><span class="o">=</span><span class="n">FORMAT</span><span class="o">.</span><span class="n">etree_element</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cur_file_path</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">elem_count</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Element tags to be matched: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">element_tags</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">invoke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packet</span><span class="p">):</span>
<span class="k">if</span> <span class="n">packet</span><span class="o">.</span><span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"No XML file given"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">packet</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cur_file_path</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cur_file_path</span> <span class="o">=</span> <span class="n">packet</span><span class="o">.</span><span class="n">data</span>
<span class="n">event</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">packet</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Open file</span>
<span class="n">fd</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cur_file_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">elem_count</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"file opened : </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">cur_file_path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="o">=</span> <span class="n">etree</span><span class="o">.</span><span class="n">iterparse</span><span class="p">(</span><span class="n">fd</span><span class="p">,</span> <span class="n">events</span><span class="o">=</span><span class="p">(</span><span class="s2">"start"</span><span class="p">,</span> <span class="s2">"end"</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span>
<span class="n">event</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
<span class="n">packet</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">process_xml</span><span class="p">(</span><span class="n">packet</span><span class="p">)</span>
<span class="k">return</span> <span class="n">packet</span>
<span class="k">def</span> <span class="nf">process_xml</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packet</span><span class="p">):</span>
<span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># while not packet.is_end_of_doc():</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">event</span><span class="p">,</span> <span class="n">elem</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
<span class="k">except</span> <span class="p">(</span><span class="n">etree</span><span class="o">.</span><span class="n">XMLSyntaxError</span><span class="p">,</span> <span class="ne">StopIteration</span><span class="p">):</span>
<span class="c1"># workaround for etree.XMLSyntaxError https://bugs.launchpad.net/lxml/+bug/1185701</span>
<span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Always end of doc</span>
<span class="c1"># TODO: is this still useful for a non-input component?</span>
<span class="n">packet</span><span class="o">.</span><span class="n">set_end_of_doc</span><span class="p">()</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"End of doc: </span><span class="si">%s</span><span class="s2"> elem_count=</span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cur_file_path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">elem_count</span><span class="p">))</span>
<span class="k">return</span> <span class="n">packet</span>
<span class="c1"># Filter out Namespace from the tag</span>
<span class="c1"># this is the easiest way to go for now</span>
<span class="n">tag</span> <span class="o">=</span> <span class="n">elem</span><span class="o">.</span><span class="n">tag</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'}'</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="c1"># Namespaced tag: 2nd is tag</span>
<span class="n">tag</span> <span class="o">=</span> <span class="n">tag</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Non-namespaced tag: first</span>
<span class="n">tag</span> <span class="o">=</span> <span class="n">tag</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">tag</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">element_tags</span><span class="p">:</span>
<span class="k">if</span> <span class="n">event</span> <span class="o">==</span> <span class="s2">"start"</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">elif</span> <span class="n">event</span> <span class="o">==</span> <span class="s2">"end"</span><span class="p">:</span>
<span class="n">packet</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">elem_count</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">strip_namespaces</span><span class="p">:</span>
<span class="n">packet</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">Util</span><span class="o">.</span><span class="n">stripNamespaces</span><span class="p">(</span><span class="n">elem</span><span class="p">)</span><span class="o">.</span><span class="n">getroot</span><span class="p">()</span>
<span class="c1"># Clear the root element, since iterparse still builds a tree</span>
<span class="c1"># See http://effbot.org/zone/element-iterparse.htm</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
<span class="c1"># If there is a next component, let it process</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">:</span>
<span class="c1"># Hand-over data (line, doc whatever) to the next component</span>
<span class="n">packet</span><span class="o">.</span><span class="n">format</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_output_format</span>
<span class="n">packet</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">packet</span><span class="p">)</span>
<span class="k">return</span> <span class="n">packet</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">Stetl 1.1 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013+, Just van den Broecke.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
</div>
</body>
</html>
|