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
|
#############
PyWPS API Doc
#############
.. module:: pywps
Process
=======
.. autoclass:: Process
Exceptions you can raise in the process implementation to show a user-friendly error message.
.. autoclass:: pywps.app.exceptions.ProcessError
Inputs and outputs
==================
.. autoclass:: pywps.validator.mode.MODE
:members:
:undoc-members:
Most of the inputs nad outputs are derived from the `IOHandler` class
.. autoclass:: pywps.inout.basic.IOHandler
LiteralData
-----------
.. autoclass:: LiteralInput
.. autoclass:: LiteralOutput
.. autoclass:: pywps.inout.literaltypes.AnyValue
.. autoclass:: pywps.inout.literaltypes.AllowedValue
.. autoclass:: pywps.inout.literaltypes.ValuesReference
.. autodata:: pywps.inout.literaltypes.LITERAL_DATA_TYPES
ComplexData
-----------
.. autoclass:: ComplexInput
.. autoclass:: ComplexOutput
.. autoclass:: Format
.. autodata:: pywps.inout.formats.FORMATS
:annotation:
List of out of the box supported formats. User can add custom formats to the
array.
.. autofunction:: pywps.validator.complexvalidator.validategml
BoundingBoxData
---------------
.. autoclass:: BoundingBoxInput
.. autoclass:: BoundingBoxOutput
Request and response objects
----------------------------
.. autodata:: pywps.response.status.WPS_STATUS
:annotation:
Process status information
.. autoclass:: pywps.app.WPSRequest
:members:
.. attribute:: operation
Type of operation requested by the client. Can be
`getcapabilities`, `describeprocess` or `execute`.
.. attribute:: http_request
.. TODO link to werkzeug docs
Original Werkzeug HTTPRequest object.
.. attribute:: inputs
.. TODO link to werkzeug docs
A MultiDict object containing input values sent by the client.
.. autoclass:: pywps.response.basic.WPSResponse
:members:
.. attribute:: status
Information about currently running process status
:class:`pywps.response.status.STATUS`
Processing
----------
.. autofunction:: pywps.processing.Process
.. autoclass:: pywps.processing.Processing
:members:
.. autoclass:: pywps.processing.Job
:members:
Refer :ref:`exceptions` for their description.
|