/usr/share/doc/pywps/html/api.html is in pywps-doc 4.0.0-5.
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 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 | <!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>PyWPS API Doc — PyWPS 4.0.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '4.0.0',
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/mathjax/MathJax.js?config=tex-ams-mml_htmlormml"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Developers Guide" href="development.html" />
<link rel="prev" title="PyWPS and external tools" href="external-tools.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pywps">
<span id="pywps-api-doc"></span><h1>PyWPS API Doc<a class="headerlink" href="#module-pywps" title="Permalink to this headline">¶</a></h1>
<div class="section" id="process">
<h2>Process<a class="headerlink" href="#process" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="pywps.Process">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">Process</code><span class="sig-paren">(</span><em>handler</em>, <em>identifier</em>, <em>title</em>, <em>abstract=''</em>, <em>profile=[]</em>, <em>metadata=[]</em>, <em>inputs=[]</em>, <em>outputs=[]</em>, <em>version='None'</em>, <em>store_supported=False</em>, <em>status_supported=False</em>, <em>grass_location=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/Process.html#Process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.Process" title="Permalink to this definition">¶</a></dt>
<dd><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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>handler</strong> – A callable that gets invoked for each incoming
request. It should accept a single
<a class="reference internal" href="#pywps.app.WPSRequest" title="pywps.app.WPSRequest"><code class="xref py py-class docutils literal"><span class="pre">pywps.app.WPSRequest</span></code></a> argument and return a
<a class="reference internal" href="#pywps.app.WPSResponse" title="pywps.app.WPSResponse"><code class="xref py py-class docutils literal"><span class="pre">pywps.app.WPSResponse</span></code></a> object.</li>
<li><strong>identifier</strong> – Name of this process.</li>
<li><strong>inputs</strong> – List of inputs accepted by this process. They
should be <a class="reference internal" href="#pywps.LiteralInput" title="pywps.LiteralInput"><code class="xref py py-class docutils literal"><span class="pre">LiteralInput</span></code></a> and <a class="reference internal" href="#pywps.ComplexInput" title="pywps.ComplexInput"><code class="xref py py-class docutils literal"><span class="pre">ComplexInput</span></code></a>
and <a class="reference internal" href="#pywps.BoundingBoxInput" title="pywps.BoundingBoxInput"><code class="xref py py-class docutils literal"><span class="pre">BoundingBoxInput</span></code></a>
objects.</li>
<li><strong>outputs</strong> – List of outputs returned by this process. They
should be <a class="reference internal" href="#pywps.LiteralOutput" title="pywps.LiteralOutput"><code class="xref py py-class docutils literal"><span class="pre">LiteralOutput</span></code></a> and <a class="reference internal" href="#pywps.ComplexOutput" title="pywps.ComplexOutput"><code class="xref py py-class docutils literal"><span class="pre">ComplexOutput</span></code></a>
and <a class="reference internal" href="#pywps.BoundingBoxOutput" title="pywps.BoundingBoxOutput"><code class="xref py py-class docutils literal"><span class="pre">BoundingBoxOutput</span></code></a>
objects.</li>
<li><strong>metadata</strong> – List of metadata advertised by this process. They
should be <code class="xref py py-class docutils literal"><span class="pre">pywps.app.Common.Metadata</span></code> objects.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="inputs-and-outputs">
<h2>Inputs and outputs<a class="headerlink" href="#inputs-and-outputs" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="pywps.validator.mode.MODE">
<em class="property">class </em><code class="descclassname">pywps.validator.mode.</code><code class="descname">MODE</code><a class="reference internal" href="_modules/pywps/validator/mode.html#MODE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.validator.mode.MODE" title="Permalink to this definition">¶</a></dt>
<dd><p>Validation mode enumeration</p>
<dl class="attribute">
<dt id="pywps.validator.mode.MODE.NONE">
<code class="descname">NONE</code><em class="property"> = 0</em><a class="headerlink" href="#pywps.validator.mode.MODE.NONE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pywps.validator.mode.MODE.SIMPLE">
<code class="descname">SIMPLE</code><em class="property"> = 1</em><a class="headerlink" href="#pywps.validator.mode.MODE.SIMPLE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pywps.validator.mode.MODE.STRICT">
<code class="descname">STRICT</code><em class="property"> = 2</em><a class="headerlink" href="#pywps.validator.mode.MODE.STRICT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="pywps.validator.mode.MODE.VERYSTRICT">
<code class="descname">VERYSTRICT</code><em class="property"> = 3</em><a class="headerlink" href="#pywps.validator.mode.MODE.VERYSTRICT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<p>Most of the inputs nad outputs are derived from the <cite>IOHandler</cite> class</p>
<dl class="class">
<dt id="pywps.inout.basic.IOHandler">
<em class="property">class </em><code class="descclassname">pywps.inout.basic.</code><code class="descname">IOHandler</code><span class="sig-paren">(</span><em>workdir=None</em>, <em>mode=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/basic.html#IOHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.inout.basic.IOHandler" title="Permalink to this definition">¶</a></dt>
<dd><p>Basic IO class. Provides functions, to accept input data in file,
memory object and stream object and give them out in all three types</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># setting up</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">os</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">io</span> <span class="k">import</span> <span class="n">RawIOBase</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">io</span> <span class="k">import</span> <span class="n">FileIO</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">types</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="n">ioh_file</span> <span class="o">=</span> <span class="n">IOHandler</span><span class="p">(</span><span class="n">workdir</span><span class="o">=</span><span class="n">tmp</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ioh_file</span><span class="p">,</span> <span class="n">IOHandler</span><span class="p">)</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="c1"># Create test file input</span>
<span class="gp">>>> </span><span class="n">fileobj</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tmp</span><span class="p">,</span> <span class="s1">'myfile.txt'</span><span class="p">),</span> <span class="s1">'w'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">fileobj</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'ASDF ASFADSF ASF ASF ASDF ASFASF'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">fileobj</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="c1"># testing file object on input</span>
<span class="gp">>>> </span><span class="n">ioh_file</span><span class="o">.</span><span class="n">file</span> <span class="o">=</span> <span class="n">fileobj</span><span class="o">.</span><span class="n">name</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">ioh_file</span><span class="o">.</span><span class="n">source_type</span> <span class="o">==</span> <span class="n">SOURCE_TYPE</span><span class="o">.</span><span class="n">FILE</span>
<span class="gp">>>> </span><span class="n">file</span> <span class="o">=</span> <span class="n">ioh_file</span><span class="o">.</span><span class="n">file</span>
<span class="gp">>>> </span><span class="n">stream</span> <span class="o">=</span> <span class="n">ioh_file</span><span class="o">.</span><span class="n">stream</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">file</span> <span class="o">==</span> <span class="n">fileobj</span><span class="o">.</span><span class="n">name</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">RawIOBase</span><span class="p">)</span>
<span class="gp">>>> </span><span class="c1"># skipped assert isinstance(ioh_file.memory_object, POSH)</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="c1"># testing stream object on input</span>
<span class="gp">>>> </span><span class="n">ioh_stream</span> <span class="o">=</span> <span class="n">IOHandler</span><span class="p">(</span><span class="n">workdir</span><span class="o">=</span><span class="n">tmp</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">ioh_stream</span><span class="o">.</span><span class="n">workdir</span> <span class="o">==</span> <span class="n">tmp</span>
<span class="gp">>>> </span><span class="n">ioh_stream</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="n">FileIO</span><span class="p">(</span><span class="n">fileobj</span><span class="o">.</span><span class="n">name</span><span class="p">,</span><span class="s1">'r'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="n">ioh_stream</span><span class="o">.</span><span class="n">source_type</span> <span class="o">==</span> <span class="n">SOURCE_TYPE</span><span class="o">.</span><span class="n">STREAM</span>
<span class="gp">>>> </span><span class="n">file</span> <span class="o">=</span> <span class="n">ioh_stream</span><span class="o">.</span><span class="n">file</span>
<span class="gp">>>> </span><span class="n">stream</span> <span class="o">=</span> <span class="n">ioh_stream</span><span class="o">.</span><span class="n">stream</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">open</span><span class="p">(</span><span class="n">file</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> <span class="o">==</span> <span class="n">ioh_file</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="gp">>>> </span><span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">RawIOBase</span><span class="p">)</span>
<span class="gp">>>> </span><span class="c1"># skipped assert isinstance(ioh_stream.memory_object, POSH)</span>
<span class="go">>>></span>
<span class="gp">>>> </span><span class="c1"># testing in memory object object on input</span>
<span class="gp">>>> </span><span class="c1"># skipped ioh_mo = IOHandler(workdir=tmp)</span>
<span class="gp">>>> </span><span class="c1"># skipped ioh_mo.memory_object = POSH</span>
<span class="gp">>>> </span><span class="c1"># skipped assert ioh_mo.source_type == SOURCE_TYPE.MEMORY</span>
<span class="gp">>>> </span><span class="c1"># skipped file = ioh_mo.file</span>
<span class="gp">>>> </span><span class="c1"># skipped stream = ioh_mo.stream</span>
<span class="gp">>>> </span><span class="c1"># skipped posh = ioh_mo.memory_object</span>
<span class="gp">>>> </span><span class="c1">#</span>
<span class="gp">>>> </span><span class="c1"># skipped assert open(file).read() == ioh_file.stream.read()</span>
<span class="gp">>>> </span><span class="c1"># skipped assert isinstance(ioh_mo.stream, RawIOBase)</span>
<span class="gp">>>> </span><span class="c1"># skipped assert isinstance(ioh_mo.memory_object, POSH)</span>
</pre></div>
</div>
</dd></dl>
<div class="section" id="literaldata">
<h3>LiteralData<a class="headerlink" href="#literaldata" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="pywps.LiteralInput">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">LiteralInput</code><span class="sig-paren">(</span><em>identifier</em>, <em>title</em>, <em>data_type='integer'</em>, <em>abstract=''</em>, <em>metadata=[]</em>, <em>uoms=None</em>, <em>default=None</em>, <em>min_occurs=1</em>, <em>max_occurs=1</em>, <em>mode=1</em>, <em>allowed_values=<class 'pywps.inout.literaltypes.AnyValue'></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/inputs.html#LiteralInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.LiteralInput" title="Permalink to this definition">¶</a></dt>
<dd><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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>identifier</strong> (<em>str</em>) – The name of this input.</li>
<li><strong>title</strong> (<em>str</em>) – Title of the input</li>
<li><strong>data_type</strong> (<a class="reference internal" href="#pywps.inout.literaltypes.LITERAL_DATA_TYPES" title="pywps.inout.literaltypes.LITERAL_DATA_TYPES"><em>pywps.inout.literaltypes.LITERAL_DATA_TYPES</em></a>) – data type</li>
<li><strong>abstract</strong> (<em>str</em>) – Input abstract</li>
<li><strong>metadata</strong> (<em>list</em>) – TODO</li>
<li><strong>uoms</strong> (<em>str</em>) – units</li>
<li><strong>min_occurs</strong> (<em>int</em>) – minimum occurence</li>
<li><strong>max_occurs</strong> (<em>int</em>) – maximum occurence</li>
<li><strong>mode</strong> (<a class="reference internal" href="#pywps.validator.mode.MODE" title="pywps.validator.mode.MODE"><em>pywps.validator.mode.MODE</em></a>) – validation mode (none to strict)</li>
<li><strong>allowed_values</strong> (<a class="reference internal" href="#pywps.inout.literaltypes.AnyValue" title="pywps.inout.literaltypes.AnyValue"><em>pywps.inout.literaltypes.AnyValue</em></a>) – or <a class="reference internal" href="#pywps.inout.literaltypes.AllowedValue" title="pywps.inout.literaltypes.AllowedValue"><code class="xref py py-class docutils literal"><span class="pre">pywps.inout.literaltypes.AllowedValue</span></code></a> object</li>
<li><strong>metadata</strong> – List of metadata advertised by this process. They
should be <code class="xref py py-class docutils literal"><span class="pre">pywps.app.Common.Metadata</span></code> objects.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pywps.LiteralOutput">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">LiteralOutput</code><span class="sig-paren">(</span><em>identifier</em>, <em>title</em>, <em>data_type='string'</em>, <em>abstract=''</em>, <em>metadata=[]</em>, <em>uoms=[]</em>, <em>mode=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/outputs.html#LiteralOutput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.LiteralOutput" title="Permalink to this definition">¶</a></dt>
<dd><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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>identifier</strong> – The name of this output.</li>
<li><strong>title</strong> (<em>str</em>) – Title of the input</li>
<li><strong>data_type</strong> (<a class="reference internal" href="#pywps.inout.literaltypes.LITERAL_DATA_TYPES" title="pywps.inout.literaltypes.LITERAL_DATA_TYPES"><em>pywps.inout.literaltypes.LITERAL_DATA_TYPES</em></a>) – data type</li>
<li><strong>abstract</strong> (<em>str</em>) – Input abstract</li>
<li><strong>uoms</strong> (<em>str</em>) – units</li>
<li><strong>mode</strong> (<a class="reference internal" href="#pywps.validator.mode.MODE" title="pywps.validator.mode.MODE"><em>pywps.validator.mode.MODE</em></a>) – validation mode (none to strict)</li>
<li><strong>metadata</strong> – List of metadata advertised by this process. They
should be <code class="xref py py-class docutils literal"><span class="pre">pywps.app.Common.Metadata</span></code> objects.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pywps.inout.literaltypes.AnyValue">
<em class="property">class </em><code class="descclassname">pywps.inout.literaltypes.</code><code class="descname">AnyValue</code><a class="reference internal" href="_modules/pywps/inout/literaltypes.html#AnyValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.inout.literaltypes.AnyValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Any value for literal input</p>
</dd></dl>
<dl class="class">
<dt id="pywps.inout.literaltypes.AllowedValue">
<em class="property">class </em><code class="descclassname">pywps.inout.literaltypes.</code><code class="descname">AllowedValue</code><span class="sig-paren">(</span><em>allowed_type='value'</em>, <em>value=None</em>, <em>minval=None</em>, <em>maxval=None</em>, <em>spacing=None</em>, <em>range_closure='closed'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/literaltypes.html#AllowedValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.inout.literaltypes.AllowedValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Allowed value parameters
the values are evaluated in literal validator functions</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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>allowed_type</strong> (<em>pywps.validator.allowed_value.ALLOWEDVALUETYPE</em>) – VALUE or RANGE</li>
<li><strong>value</strong> – single value</li>
<li><strong>minval</strong> – minimal value in case of Range</li>
<li><strong>maxval</strong> – maximal value in case of Range</li>
<li><strong>spacing</strong> – spacing in case of Range</li>
<li><strong>range_closure</strong> (<em>pywps.input.literaltypes.RANGECLOSURETYPE</em>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="data">
<dt id="pywps.inout.literaltypes.LITERAL_DATA_TYPES">
<code class="descclassname">pywps.inout.literaltypes.</code><code class="descname">LITERAL_DATA_TYPES</code><em class="property"> = ('float', 'boolean', 'integer', 'string', 'positiveInteger', 'anyURI', 'time', 'date', 'dateTime', 'scale', 'angle', 'nonNegativeInteger')</em><a class="headerlink" href="#pywps.inout.literaltypes.LITERAL_DATA_TYPES" title="Permalink to this definition">¶</a></dt>
<dd><p>tuple() -> empty tuple
tuple(iterable) -> tuple initialized from iterable’s items</p>
<p>If the argument is a tuple, the return value is the same object.</p>
</dd></dl>
</div>
<div class="section" id="complexdata">
<h3>ComplexData<a class="headerlink" href="#complexdata" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="pywps.ComplexInput">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">ComplexInput</code><span class="sig-paren">(</span><em>identifier</em>, <em>title</em>, <em>supported_formats=None</em>, <em>data_format=None</em>, <em>abstract=''</em>, <em>metadata=[]</em>, <em>min_occurs=1</em>, <em>max_occurs=1</em>, <em>mode=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/inputs.html#ComplexInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.ComplexInput" title="Permalink to this definition">¶</a></dt>
<dd><p>Complex data input</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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>identifier</strong> (<em>str</em>) – The name of this input.</li>
<li><strong>title</strong> (<em>str</em>) – Title of the input</li>
<li><strong>supported_formats</strong> (<em>pywps.inout.formats.Format</em>) – List of supported formats</li>
<li><strong>data_format</strong> (<em>pywps.inout.formats.Format</em>) – default data format</li>
<li><strong>abstract</strong> (<em>str</em>) – Input abstract</li>
<li><strong>metada</strong> (<em>list</em>) – TODO</li>
<li><strong>min_occurs</strong> (<em>int</em>) – minimum occurence</li>
<li><strong>max_occurs</strong> (<em>int</em>) – maximum occurence</li>
<li><strong>mode</strong> (<a class="reference internal" href="#pywps.validator.mode.MODE" title="pywps.validator.mode.MODE"><em>pywps.validator.mode.MODE</em></a>) – validation mode (none to strict)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pywps.ComplexOutput">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">ComplexOutput</code><span class="sig-paren">(</span><em>identifier</em>, <em>title</em>, <em>supported_formats=None</em>, <em>abstract=''</em>, <em>metadata=None</em>, <em>as_reference=False</em>, <em>mode=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/outputs.html#ComplexOutput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.ComplexOutput" title="Permalink to this definition">¶</a></dt>
<dd><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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>identifier</strong> – The name of this output.</li>
<li><strong>title</strong> – Readable form of the output name.</li>
<li><strong>supported_formats</strong> (<em>pywps.inout.formats.Format</em>) – List of supported
formats. The first format in the list will be used as the default.</li>
<li><strong>abstract</strong> (<em>str</em>) – Description of the output</li>
<li><strong>mode</strong> (<a class="reference internal" href="#pywps.validator.mode.MODE" title="pywps.validator.mode.MODE"><em>pywps.validator.mode.MODE</em></a>) – validation mode (none to strict)</li>
<li><strong>metadata</strong> – List of metadata advertised by this process. They
should be <code class="xref py py-class docutils literal"><span class="pre">pywps.app.Common.Metadata</span></code> objects.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pywps.Format">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">Format</code><span class="sig-paren">(</span><em>mime_type</em>, <em>schema=None</em>, <em>encoding=None</em>, <em>validate=<function emptyvalidator></em>, <em>mode=1</em>, <em>extension=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/formats.html#Format"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.Format" title="Permalink to this definition">¶</a></dt>
<dd><p>Input/output format specification</p>
<p>Predefined Formats are stored in <a class="reference internal" href="#pywps.inout.formats.FORMATS" title="pywps.inout.formats.FORMATS"><code class="xref py py-class docutils literal"><span class="pre">pywps.inout.formats.FORMATS</span></code></a></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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>mime_type</strong> (<em>str</em>) – mimetype definition</li>
<li><strong>schema</strong> (<em>str</em>) – xml schema definition</li>
<li><strong>encoding</strong> (<em>str</em>) – base64 or not</li>
<li><strong>validate</strong> (<em>function</em>) – function, which will perform validation. e.g.</li>
<li><strong>mode</strong> (<em>number</em>) – validation mode</li>
<li><strong>extension</strong> (<em>str</em>) – file extension</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="data">
<dt id="pywps.inout.formats.FORMATS">
<code class="descclassname">pywps.inout.formats.</code><code class="descname">FORMATS</code><a class="headerlink" href="#pywps.inout.formats.FORMATS" title="Permalink to this definition">¶</a></dt>
<dd><p>FORMATS(GEOJSON, JSON, SHP, GML, GEOTIFF, WCS, WCS100, WCS110, WCS20, WFS, WFS100, WFS110, WFS20, WMS, WMS130, WMS110, WMS100, TEXT, NETCDF)</p>
<p>List of out of the box supported formats. User can add custom formats to the
array.</p>
</dd></dl>
<dl class="function">
<dt id="pywps.validator.complexvalidator.validategml">
<code class="descclassname">pywps.validator.complexvalidator.</code><code class="descname">validategml</code><span class="sig-paren">(</span><em>data_input</em>, <em>mode</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/validator/complexvalidator.html#validategml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.validator.complexvalidator.validategml" title="Permalink to this definition">¶</a></dt>
<dd><p>GML validation function</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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>data_input</strong> – <code class="xref py py-class docutils literal"><span class="pre">ComplexInput</span></code></li>
<li><strong>mode</strong> (<a class="reference internal" href="#pywps.validator.mode.MODE" title="pywps.validator.mode.MODE"><em>pywps.validator.mode.MODE</em></a>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>This function validates GML input based on given validation mode. Following
happens, if <cite>mode</cite> parameter is given:</p>
<dl class="docutils">
<dt><cite>MODE.NONE</cite></dt>
<dd>it will return always <cite>True</cite></dd>
<dt><cite>MODE.SIMPLE</cite></dt>
<dd>the mimetype will be checked</dd>
<dt><cite>MODE.STRICT</cite></dt>
<dd><a class="reference external" href="http://gdal.org/">GDAL/OGR</a> is used for getting the propper format.</dd>
<dt><cite>MODE.VERYSTRICT</cite></dt>
<dd>the <code class="xref py py-class docutils literal"><span class="pre">lxml.etree</span></code> is used along with given input <cite>schema</cite> and the
GML file is properly validated against given schema.</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="boundingboxdata">
<h3>BoundingBoxData<a class="headerlink" href="#boundingboxdata" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="pywps.BoundingBoxInput">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">BoundingBoxInput</code><span class="sig-paren">(</span><em>identifier</em>, <em>title</em>, <em>crss</em>, <em>abstract=''</em>, <em>dimensions=2</em>, <em>metadata=[]</em>, <em>min_occurs=1</em>, <em>max_occurs=1</em>, <em>mode=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/inputs.html#BoundingBoxInput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.BoundingBoxInput" title="Permalink to this definition">¶</a></dt>
<dd><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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>identifier</strong> (<em>string</em>) – The name of this input.</li>
<li><strong>title</strong> (<em>string</em>) – Human readable title</li>
<li><strong>abstract</strong> (<em>string</em>) – Longer text description</li>
<li><strong>crss</strong> – List of supported coordinate reference system (e.g. [‘EPSG:4326’])</li>
<li><strong>dimensions</strong> (<em>int</em>) – 2 or 3</li>
<li><strong>min_occurs</strong> (<em>int</em>) – how many times this input occurs</li>
<li><strong>max_occurs</strong> (<em>int</em>) – how many times this input occurs</li>
<li><strong>metadata</strong> – List of metadata advertised by this process. They
should be <code class="xref py py-class docutils literal"><span class="pre">pywps.app.Common.Metadata</span></code> objects.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="pywps.BoundingBoxOutput">
<em class="property">class </em><code class="descclassname">pywps.</code><code class="descname">BoundingBoxOutput</code><span class="sig-paren">(</span><em>identifier</em>, <em>title</em>, <em>crss</em>, <em>abstract=''</em>, <em>dimensions=2</em>, <em>metadata=[]</em>, <em>min_occurs='1'</em>, <em>max_occurs='1'</em>, <em>as_reference=False</em>, <em>mode=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/inout/outputs.html#BoundingBoxOutput"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.BoundingBoxOutput" title="Permalink to this definition">¶</a></dt>
<dd><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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>identifier</strong> – The name of this input.</li>
<li><strong>title</strong> (<em>str</em>) – Title of the input</li>
<li><strong>abstract</strong> (<em>str</em>) – Input abstract</li>
<li><strong>crss</strong> – List of supported coordinate reference system (e.g. [‘EPSG:4326’])</li>
<li><strong>dimensions</strong> (<em>int</em>) – number of dimensions (2 or 3)</li>
<li><strong>min_occurs</strong> (<em>int</em>) – minimum occurence</li>
<li><strong>max_occurs</strong> (<em>int</em>) – maximum occurence</li>
<li><strong>mode</strong> (<a class="reference internal" href="#pywps.validator.mode.MODE" title="pywps.validator.mode.MODE"><em>pywps.validator.mode.MODE</em></a>) – validation mode (none to strict)</li>
<li><strong>metadata</strong> – List of metadata advertised by this process. They
should be <code class="xref py py-class docutils literal"><span class="pre">pywps.app.Common.Metadata</span></code> objects.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="request-and-response-objects">
<h3>Request and response objects<a class="headerlink" href="#request-and-response-objects" title="Permalink to this headline">¶</a></h3>
<dl class="data">
<dt id="pywps.app.WPSResponse.STATUS">
<code class="descclassname">pywps.app.WPSResponse.</code><code class="descname">STATUS</code><a class="headerlink" href="#pywps.app.WPSResponse.STATUS" title="Permalink to this definition">¶</a></dt>
<dd><p>Status(ERROR_STATUS, NO_STATUS, STORE_STATUS, STORE_AND_UPDATE_STATUS, DONE_STATUS)</p>
<p>Process status information</p>
</dd></dl>
<dl class="class">
<dt id="pywps.app.WPSRequest">
<em class="property">class </em><code class="descclassname">pywps.app.</code><code class="descname">WPSRequest</code><span class="sig-paren">(</span><em>http_request=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/WPSRequest.html#WPSRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.app.WPSRequest" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="pywps.app.WPSRequest.operation">
<code class="descname">operation</code><a class="headerlink" href="#pywps.app.WPSRequest.operation" title="Permalink to this definition">¶</a></dt>
<dd><p>Type of operation requested by the client. Can be
<cite>getcapabilities</cite>, <cite>describeprocess</cite> or <cite>execute</cite>.</p>
</dd></dl>
<dl class="attribute">
<dt id="pywps.app.WPSRequest.http_request">
<code class="descname">http_request</code><a class="headerlink" href="#pywps.app.WPSRequest.http_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Original Werkzeug HTTPRequest object.</p>
</dd></dl>
<dl class="attribute">
<dt id="pywps.app.WPSRequest.inputs">
<code class="descname">inputs</code><a class="headerlink" href="#pywps.app.WPSRequest.inputs" title="Permalink to this definition">¶</a></dt>
<dd><p>A MultiDict object containing input values sent by the client.</p>
</dd></dl>
<dl class="method">
<dt id="pywps.app.WPSRequest.check_accepted_versions">
<code class="descname">check_accepted_versions</code><span class="sig-paren">(</span><em>acceptedversions</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/WPSRequest.html#WPSRequest.check_accepted_versions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.app.WPSRequest.check_accepted_versions" title="Permalink to this definition">¶</a></dt>
<dd><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">Parameters:</th><td class="field-body"><strong>acceptedversions</strong> – string</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pywps.app.WPSRequest.check_and_set_language">
<code class="descname">check_and_set_language</code><span class="sig-paren">(</span><em>language</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/WPSRequest.html#WPSRequest.check_and_set_language"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.app.WPSRequest.check_and_set_language" title="Permalink to this definition">¶</a></dt>
<dd><p>set this.language</p>
</dd></dl>
<dl class="method">
<dt id="pywps.app.WPSRequest.check_and_set_version">
<code class="descname">check_and_set_version</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/WPSRequest.html#WPSRequest.check_and_set_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.app.WPSRequest.check_and_set_version" title="Permalink to this definition">¶</a></dt>
<dd><p>set this.version</p>
</dd></dl>
<dl class="attribute">
<dt id="pywps.app.WPSRequest.json">
<code class="descname">json</code><a class="headerlink" href="#pywps.app.WPSRequest.json" title="Permalink to this definition">¶</a></dt>
<dd><p>Return JSON encoded representation of the request</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="pywps.app.WPSResponse">
<em class="property">class </em><code class="descclassname">pywps.app.</code><code class="descname">WPSResponse</code><span class="sig-paren">(</span><em>process</em>, <em>wps_request</em>, <em>uuid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/WPSResponse.html#WPSResponse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.app.WPSResponse" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="pywps.app.WPSResponse.status">
<code class="descname">status</code><a class="headerlink" href="#pywps.app.WPSResponse.status" title="Permalink to this definition">¶</a></dt>
<dd><p>Information about currently running process status
<a class="reference internal" href="#pywps.app.WPSResponse.STATUS" title="pywps.app.WPSResponse.STATUS"><code class="xref py py-class docutils literal"><span class="pre">pywps.app.WPSResponse.STATUS</span></code></a></p>
</dd></dl>
<dl class="method">
<dt id="pywps.app.WPSResponse.call_on_close">
<code class="descname">call_on_close</code><span class="sig-paren">(</span><em>function</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/WPSResponse.html#WPSResponse.call_on_close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.app.WPSResponse.call_on_close" title="Permalink to this definition">¶</a></dt>
<dd><p>Custom implementation of call_on_close of werkzeug
TODO: rewrite this using werkzeug’s tools</p>
</dd></dl>
<dl class="method">
<dt id="pywps.app.WPSResponse.update_status">
<code class="descname">update_status</code><span class="sig-paren">(</span><em>message=None</em>, <em>status_percentage=None</em>, <em>status=None</em>, <em>clean=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pywps/app/WPSResponse.html#WPSResponse.update_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pywps.app.WPSResponse.update_status" title="Permalink to this definition">¶</a></dt>
<dd><p>Update status report of currently running process instance</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">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>message</strong> (<em>str</em>) – Message you need to share with the client</li>
<li><strong>status_percentage</strong> (<em>int</em>) – Percent done (number betwen <0-100>)</li>
<li><strong>status</strong> (<a class="reference internal" href="#pywps.app.WPSResponse.STATUS" title="pywps.app.WPSResponse.STATUS"><em>pywps.app.WPSResponse.STATUS</em></a>) – process status - user should usually
ommit this parameter</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<p>Refer <a class="reference internal" href="exceptions.html#exceptions"><span class="std std-ref">Exceptions</span></a> for their description.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo">
<a href="index.html">
<img class="logo" src="_static/pywps.png" alt="Logo"/>
</a>
</p>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="wps.html">OGC Web Processing Service (OGC WPS)</a></li>
<li class="toctree-l1"><a class="reference internal" href="pywps.html">PyWPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="process.html">Processes</a></li>
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment to a production server</a></li>
<li class="toctree-l1"><a class="reference internal" href="migration.html">Migrating from PyWPS 3.x to 4.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="external-tools.html">PyWPS and external tools</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">PyWPS API Doc</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#process">Process</a></li>
<li class="toctree-l2"><a class="reference internal" href="#inputs-and-outputs">Inputs and outputs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#literaldata">LiteralData</a></li>
<li class="toctree-l3"><a class="reference internal" href="#complexdata">ComplexData</a></li>
<li class="toctree-l3"><a class="reference internal" href="#boundingboxdata">BoundingBoxData</a></li>
<li class="toctree-l3"><a class="reference internal" href="#request-and-response-objects">Request and response objects</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Developers Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
</ul>
<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="footer">
©Copyright (C) 2014-2016 PyWPS Development Team, represented by Jachym Cepicky.This work is licensed under a Creative Commons Attribution 4.0 International License.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/api.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|