weaver.wps.service
¶
Module Contents¶
-
class
weaver.wps.service.
ReferenceStatusLocationStorage
(url_location: weaver.typedefs.SettingsType, settings)[source]¶ Simple storage that simply redirects to a pre-existing status location.
-
store
(self, *_, **__)[source]¶ - Parameters
output – of type IOHandler
- Returns
(type, store, url) where type - is type of STORE_TYPE - number store - string describing storage - file name, database connection url - url, where the data can be downloaded
-
write
(self, *_, **__)[source]¶ - Parameters
data – data to write to storage
destination – identifies the destination to write to storage generally a file name which can be interpreted by the implemented Storage class in a manner of its choosing
data_format – Optional parameter of type pywps.inout.formats.FORMAT describing the format of the data to write.
- Returns
url where the data can be downloaded
-
-
class
weaver.wps.service.
WorkerRequest
(http_request: Optional[weaver.typedefs.AnyHeadersContainer] = None, http_headers: Any = None, **kwargs)[source]¶ Extended
pywps
request with additional handling provided byweaver
.
-
class
weaver.wps.service.
WorkerExecuteResponse
(wps_request: str, uuid: pywps.app.Process, process: str, job_url: weaver.typedefs.SettingsType, settings: Any, *_: Any, **__)[source]¶ XML response generator from predefined job status URL and executed process definition.
constructor
- Parameters
wps_request (pywps.app.WPSRequest.WPSRequest) –
process (pywps.app.Process.Process) –
uuid – string this request uuid
-
class
weaver.wps.service.
WorkerService
(*_, is_worker=False, settings=None, **__)[source]¶ Dispatches PyWPS requests from WPS-1/2 XML endpoint to WPS-REST as appropriate.
Note
For every WPS-Request type, the parsing of XML content is already handled by the PyWPS service for GET/POST. All data must be retrieved from parsed
WPSRequest
to avoid managing argument location and WPS versions.When
GetCapabilities
orDescribeProcess
requests are received, directly return to result as XML based on content (no need to subprocess as Celery task that gets resolved quickly with only the process(es) details). When JSON content is requested, instead return the redirect link to corresponding WPS-REST API endpoint.When receiving
Execute
request, convert the XML payload to corresponding JSON and dispatch it to the Celery Worker to actually process it after job setup for monitoring.-
_get_capabilities_redirect
(self: pywps.app.WPSRequest, wps_request: Any, *_: Any, **__) → Optional[Union[pywps.response.WPSResponse, weaver.typedefs.HTTPValid]][source]¶ Redirects to WPS-REST endpoint if requested
Content-Type
is JSON.
-
get_capabilities
(self: pywps.app.WPSRequest, wps_request: Any, *_: Any, **__) → Union[pywps.response.WPSResponse, weaver.typedefs.HTTPValid][source]¶ Handles the
GetCapabilities
KVP/XML request submitted on the WPS endpoint.Redirects to WPS-REST endpoint if requested
Content-Type
is JSON or handleGetCapabilities
normally.
-
_describe_process_redirect
(self: pywps.app.WPSRequest, wps_request: Any, *_: Any, **__) → Optional[Union[pywps.response.WPSResponse, weaver.typedefs.HTTPValid]][source]¶ Redirects to WPS-REST endpoint if requested
Content-Type
is JSON.
-
describe
(self: pywps.app.WPSRequest, wps_request: Any, *_: Any, **__) → Union[pywps.response.WPSResponse, weaver.typedefs.HTTPValid][source]¶ Handles the
DescribeProcess
KVP/XML request submitted on the WPS endpoint.Redirect to WPS-REST endpoint if requested
Content-Type
is JSON or handleDescribeProcess
normally.
-
_submit_job
(self: pywps.app.WPSRequest, wps_request) → Union[pywps.response.WPSResponse, weaver.typedefs.HTTPValid, weaver.typedefs.JSON][source]¶ Dispatch operation to WPS-REST endpoint, which in turn should call back the real Celery Worker for execution.
Returns the status response as is if XML, or convert it to JSON, according to request
Accept
header.
-
prepare_process_for_execution
(self: str, identifier) → pywps.app.Process[source]¶ Handles dispatched remote provider process preparation during execution request.
-
execute
(self: str, identifier: Union[pywps.app.WPSRequest, WorkerRequest], wps_request: str, uuid) → Union[pywps.response.WPSResponse, weaver.typedefs.HTTPValid][source]¶ Handles the
Execute
KVP/XML request submitted on the WPS endpoint.Submit WPS request to corresponding WPS-REST endpoint and convert back for requested
Accept
content-type.Overrides the original execute operation, that will instead be handled by
execute_job()
following callback from Celery Worker, which handles process job creation and monitoring.If
Accept
is JSON, the result is directly returned from_submit_job()
. IfAccept
is XML or undefined,WorkerExecuteResponse
converts the received JSON with XML template.
-
execute_job
(self: Ellipsis, job: weaver.datatype.Job, wps_inputs: List[weaver.typedefs.WPS_InputData], wps_outputs: List[weaver.typedefs.WPS_OutputRequested], remote_process: Optional[weaver.datatype.Process], headers: Optional[weaver.typedefs.AnyHeadersContainer]) → owslib.wps.WPSExecution[source]¶ Real execution of the process by active Celery Worker.
-