/usr/share/doc/python-stetl/html/_modules/stetl/outputs/ogroutput.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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | <!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.outputs.ogroutput — 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.outputs.ogroutput</h1><div class="highlight"><pre>
<span></span><span class="ch">#!/usr/bin/env python</span>
<span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Output classes for ETL.</span>
<span class="c1">#</span>
<span class="c1"># Author: Just van den Broecke</span>
<span class="c1">#</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">shutil</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.output</span> <span class="k">import</span> <span class="n">Output</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">gdal</span><span class="p">,</span> <span class="n">ogr</span><span class="p">,</span> <span class="n">osr</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">'ogroutput'</span><span class="p">)</span>
<div class="viewcode-block" id="OgrOutput"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput">[docs]</a><span class="k">class</span> <span class="nc">OgrOutput</span><span class="p">(</span><span class="n">Output</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Direct GDAL OGR output via Python OGR wrapper. Via the Python API http://gdal.org/python</span>
<span class="sd"> OGR Features are written.</span>
<span class="sd"> This output can write almost any geospatial, OGR-defined, dataformat.</span>
<span class="sd"> consumes=FORMAT.ogr_feature or FORMAT.ogr_feature_array</span>
<span class="sd"> """</span>
<span class="c1"># Start attribute config meta</span>
<span class="c1"># Applying Decorator pattern with the Config class to provide</span>
<span class="c1"># read-only config values from the configured properties.</span>
<div class="viewcode-block" id="OgrOutput.append"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.append">[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">append</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Add to destination destination if it extists (ogr2ogr -append option).</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.dest_data_source"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.dest_data_source">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">str</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">dest_data_source</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> String denoting the OGR data destination. Usually a path to a file like "path/rivers.shp" or connection string</span>
<span class="sd"> to PostgreSQL like "PG: host=localhost dbname='rivers' user='postgres'".</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.dest_format"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.dest_format">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">str</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">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">dest_format</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Instructs GDAL to use driver by that name to open data destination. Not required for</span>
<span class="sd"> many standard formats that are self-describing like ESRI Shapefile.</span>
<span class="sd"> Examples: 'PostgreSQL', 'GeoJSON' etc</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.dest_create_options"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.dest_create_options">[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="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">dest_create_options</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Creation options.</span>
<span class="sd"> Examples: ..</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.dest_options"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.dest_options">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">dict</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">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">dest_options</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Custom data destination-specific options. Used in gdal.SetConfigOption().</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.layer_create_options"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.layer_create_options">[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="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">layer_create_options</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Options for newly created layer (-lco).</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.new_layer_name"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.new_layer_name">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">str</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">new_layer_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Layer name for layer created in the destination source.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.overwrite"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.overwrite">[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">overwrite</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Overwrite destination if it extists (ogr2ogr -overwrite option).</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.target_srs"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.target_srs">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">str</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">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">target_srs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> SRS (projection) for the target.</span>
<span class="sd"> """</span>
<span class="k">pass</span></div>
<div class="viewcode-block" id="OgrOutput.sql"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.OgrOutput.sql">[docs]</a> <span class="nd">@Config</span><span class="p">(</span><span class="n">ptype</span><span class="o">=</span><span class="nb">str</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">False</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">sql</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> String with SQL query. Mandatory for PostgreSQL OGR dest.</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">Output</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="p">[</span><span class="n">FORMAT</span><span class="o">.</span><span class="n">ogr_feature</span><span class="p">,</span> <span class="n">FORMAT</span><span class="o">.</span><span class="n">ogr_feature_array</span><span class="p">])</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="bp">self</span><span class="o">.</span><span class="n">ogr</span> <span class="o">=</span> <span class="n">ogr</span>
<span class="c1"># http://trac.osgeo.org/gdal/wiki/PythonGotchas</span>
<span class="bp">self</span><span class="o">.</span><span class="n">gdal</span> <span class="o">=</span> <span class="n">gdal</span>
<span class="bp">self</span><span class="o">.</span><span class="n">gdal</span><span class="o">.</span><span class="n">UseExceptions</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">"Using GDAL/OGR version: </span><span class="si">%d</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">int</span><span class="p">(</span><span class="n">gdal</span><span class="o">.</span><span class="n">VersionInfo</span><span class="p">(</span><span class="s1">'VERSION_NUM'</span><span class="p">)))</span>
<span class="c1"># GDAL error handler function</span>
<span class="c1"># http://pcjericks.github.io/py-gdalogr-cookbook/gdal_general.html</span>
<span class="k">def</span> <span class="nf">gdal_error_handler</span><span class="p">(</span><span class="n">err_class</span><span class="p">,</span> <span class="n">err_num</span><span class="p">,</span> <span class="n">err_msg</span><span class="p">):</span>
<span class="n">err_type</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">gdal</span><span class="o">.</span><span class="n">CE_None</span><span class="p">:</span> <span class="s1">'None'</span><span class="p">,</span>
<span class="n">gdal</span><span class="o">.</span><span class="n">CE_Debug</span><span class="p">:</span> <span class="s1">'Debug'</span><span class="p">,</span>
<span class="n">gdal</span><span class="o">.</span><span class="n">CE_Warning</span><span class="p">:</span> <span class="s1">'Warning'</span><span class="p">,</span>
<span class="n">gdal</span><span class="o">.</span><span class="n">CE_Failure</span><span class="p">:</span> <span class="s1">'Failure'</span><span class="p">,</span>
<span class="n">gdal</span><span class="o">.</span><span class="n">CE_Fatal</span><span class="p">:</span> <span class="s1">'Fatal'</span>
<span class="p">}</span>
<span class="n">err_msg</span> <span class="o">=</span> <span class="n">err_msg</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span>
<span class="n">err_class</span> <span class="o">=</span> <span class="n">err_type</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">err_class</span><span class="p">,</span> <span class="s1">'None'</span><span class="p">)</span>
<span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s1">'Error Number: </span><span class="si">%s</span><span class="s1">, Type: </span><span class="si">%s</span><span class="s1">, Msg: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">err_num</span><span class="p">,</span> <span class="n">err_class</span><span class="p">,</span> <span class="n">err_msg</span><span class="p">))</span>
<span class="c1"># install error handler</span>
<span class="bp">self</span><span class="o">.</span><span class="n">gdal</span><span class="o">.</span><span class="n">PushErrorHandler</span><span class="p">(</span><span class="n">gdal_error_handler</span><span class="p">)</span>
<span class="c1"># Raise a dummy error for testing</span>
<span class="c1"># self.gdal.Error(1, 2, 'test error')</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">overwrite</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">append</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_options</span><span class="p">:</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_options</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">gdal</span><span class="o">.</span><span class="n">SetConfigOption</span><span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_options</span><span class="p">[</span><span class="n">k</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># Loosely based on https://github.com/OSGeo/gdal/blob/trunk/gdal/swig/python/samples/ogr2ogr.py</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="c1"># /* Try opening the output data source as an existing, writable */</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">:</span>
<span class="c1"># Try opening in update mode</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</span> <span class="o">=</span> <span class="n">ogr</span><span class="o">.</span><span class="n">Open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dest_data_source</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dest_create_options</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="n">log</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">"Datasource creation options ignored since an existing datasource being updated."</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</span><span class="o">.</span><span class="n">GetDriver</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">overwrite</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span><span class="o">.</span><span class="n">DeleteDataSource</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dest_data_source</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span> <span class="o">=</span> <span class="kc">False</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="c1"># /* Find the output driver. */</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Open OGR data dest in write-only mode.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span> <span class="o">=</span> <span class="n">ogr</span><span class="o">.</span><span class="n">GetDriverByName</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dest_format</span><span class="p">)</span>
<span class="c1"># Report failure if failed</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</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">error</span><span class="p">(</span><span class="s2">"Cannot open OGR data destination: </span><span class="si">%s</span><span class="s2"> with the following drivers."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_data_source</span><span class="p">)</span>
<span class="k">for</span> <span class="n">iDriver</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ogr</span><span class="o">.</span><span class="n">GetDriverCount</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">" -> "</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">ogr</span><span class="o">.</span><span class="n">GetDriver</span><span class="p">(</span><span class="n">iDriver</span><span class="p">)</span><span class="o">.</span><span class="n">GetName</span><span class="p">())</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span><span class="o">.</span><span class="n">TestCapability</span><span class="p">(</span><span class="n">ogr</span><span class="o">.</span><span class="n">ODrCCreateDataSource</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>
<span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> driver does not support data source creation."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_format</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">()</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="c1"># /* Create the output data source. */</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</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">dest_fd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_driver</span><span class="o">.</span><span class="n">CreateDataSource</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dest_data_source</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dest_create_options</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</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">error</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> driver failed to create </span><span class="si">%s</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">dest_format</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_data_source</span><span class="p">))</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">()</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="c1"># /* Parse the output SRS definition if possible. */</span>
<span class="c1"># /* -------------------------------------------------------------------- */</span>
<span class="n">output_srs_ref</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">target_srs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">output_srs_ref</span> <span class="o">=</span> <span class="n">osr</span><span class="o">.</span><span class="n">SpatialReference</span><span class="p">()</span>
<span class="k">if</span> <span class="n">output_srs_ref</span><span class="o">.</span><span class="n">SetFromUserInput</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">target_srs</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Failed to process SRS definition: </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">target_srs</span><span class="p">)</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layer</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</span><span class="o">.</span><span class="n">CreateLayer</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">new_layer_name</span><span class="p">,</span> <span class="n">output_srs_ref</span><span class="p">,</span> <span class="n">ogr</span><span class="o">.</span><span class="n">wkbUnknown</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layer_create_options</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">feature_def</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Opened OGR dest ok: </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">dest_data_source</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">write</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="c1"># Are we all done?</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="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</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">write_end</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">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">layer</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 Layer, end writing to: </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">dest_data_source</span><span class="p">)</span>
<span class="k">return</span> <span class="n">packet</span>
<span class="c1"># Assume ogr_feature_array input, otherwise convert ogr_feature to list</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">packet</span><span class="o">.</span><span class="n">data</span><span class="p">)</span> <span class="ow">is</span> <span class="nb">list</span><span class="p">:</span>
<span class="c1"># Write feature collection to OGR Layer output</span>
<span class="k">for</span> <span class="n">feature</span> <span class="ow">in</span> <span class="n">packet</span><span class="o">.</span><span class="n">data</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_feature</span><span class="p">(</span><span class="n">feature</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_end</span><span class="p">(</span><span class="n">packet</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Write single feature to OGR Layer output</span>
<span class="k">if</span> <span class="n">packet</span><span class="o">.</span><span class="n">end_of_stream</span> <span class="ow">or</span> <span class="n">packet</span><span class="o">.</span><span class="n">end_of_doc</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_end</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="bp">self</span><span class="o">.</span><span class="n">write_feature</span><span class="p">(</span><span class="n">packet</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
<span class="k">return</span> <span class="n">packet</span>
<span class="k">def</span> <span class="nf">write_feature</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">feature</span><span class="p">):</span>
<span class="c1"># Set the Layer Feature Definition once, using the first feature received</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">feature_def</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">feature_def</span> <span class="o">=</span> <span class="n">feature</span><span class="o">.</span><span class="n">GetDefnRef</span><span class="p">()</span>
<span class="n">field_count</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">feature_def</span><span class="o">.</span><span class="n">GetFieldCount</span><span class="p">()</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">field_count</span><span class="p">):</span>
<span class="n">field_def</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">feature_def</span><span class="o">.</span><span class="n">GetFieldDefn</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layer</span><span class="o">.</span><span class="n">CreateField</span><span class="p">(</span><span class="n">field_def</span><span class="p">)</span>
<span class="c1"># Write Feature to the Layer</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layer</span><span class="o">.</span><span class="n">CreateFeature</span><span class="p">(</span><span class="n">feature</span><span class="p">)</span>
<span class="c1"># Dispose memory</span>
<span class="n">feature</span><span class="o">.</span><span class="n">Destroy</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">write_end</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="c1"># Destroy not required anymore: http://trac.osgeo.org/gdal/wiki/PythonGotchas</span>
<span class="c1"># self.dest_fd.Destroy()</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"End writing to: </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">dest_data_source</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dest_fd</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">layer</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">packet</span></div>
<div class="viewcode-block" id="Ogr2OgrOutput"><a class="viewcode-back" href="../../../code.html#stetl.outputs.ogroutput.Ogr2OgrOutput">[docs]</a><span class="k">class</span> <span class="nc">Ogr2OgrOutput</span><span class="p">(</span><span class="n">Output</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Output from GML etree doc to any OGR2OGR output using the GDAL/OGR ogr2ogr command</span>
<span class="sd"> consumes=FORMAT.etree_doc</span>
<span class="sd"> """</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">Output</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">etree_doc</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">temp_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'temp_file'</span><span class="p">)</span>
<span class="c1"># For creating tables the GFS file needs to be newer than</span>
<span class="c1"># the .gml file. -lco GML_GFS_TEMPLATE somehow does not work</span>
<span class="c1"># so we copy the .gfs file each time with the .gml file with</span>
<span class="c1"># the same base name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">gfs_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'gfs_file'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">lco</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'lco'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">spatial_extent</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'spatial_extent'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ogr2ogr_cmd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cfg</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'ogr2ogr_cmd'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">' '</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">spatial_extent</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ogr2ogr_cmd</span> <span class="o">+=</span> <span class="s1">' -spat '</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">spatial_extent</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first_run</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">save_doc</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="n">file_path</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="k">return</span> <span class="n">packet</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'writing to file </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">file_path</span><span class="p">)</span>
<span class="n">out_file</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">writelines</span><span class="p">(</span><span class="n">packet</span><span class="o">.</span><span class="n">to_string</span><span class="p">())</span>
<span class="n">out_file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="c1"># Copy the .gfs file if required, use the same base name</span>
<span class="c1"># so ogr2ogr will pick it up.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gfs_file</span><span class="p">:</span>
<span class="n">file_ext</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span>
<span class="n">shutil</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">gfs_file</span><span class="p">,</span> <span class="n">file_ext</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="s1">'.gfs'</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">"written to </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">file_path</span><span class="p">)</span>
<span class="k">return</span> <span class="n">packet</span>
<span class="k">def</span> <span class="nf">execute_cmd</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
<span class="n">use_shell</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s1">'nt'</span><span class="p">:</span>
<span class="n">use_shell</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"executing cmd=</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">cmd</span><span class="p">)</span>
<span class="n">subprocess</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="n">use_shell</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">"execute done"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">write</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="k">return</span> <span class="n">packet</span>
<span class="c1"># Save the doc to a temp file</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_doc</span><span class="p">(</span><span class="n">packet</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">temp_file</span><span class="p">)</span>
<span class="c1"># Execute ogr2ogr</span>
<span class="n">ogr2ogr_cmd</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ogr2ogr_cmd</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">lco</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">first_run</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
<span class="n">ogr2ogr_cmd</span> <span class="o">+=</span> <span class="s1">' '</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">lco</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first_run</span> <span class="o">=</span> <span class="kc">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">execute_cmd</span><span class="p">(</span><span class="n">ogr2ogr_cmd</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>
|