birdy.client.base module

Client Base Module.

class birdy.client.base.WPSClient(url, processes=None, converters=None, username=None, password=None, headers=None, auth=None, verify=True, cert=None, progress=False, version='1.0.0', caps_xml=None, desc_xml=None, language=None, lineage=False, **kwds)[source]

Bases: object

Returns a class where every public method is a WPS process available at the given url.

Parameters

urlstr

Link to WPS provider. config (Config): an instance.

processesany, optional

Specify a subset of processes to bind. Defaults to all processes.

convertersdict, optional

Correspondence of {mimetype: class} to convert this mimetype to a python object.

usernamestr, optional

Passed to owslib.wps.WebProcessingService.

passwordstr, optional

Passed to owslib.wps.WebProcessingService.

headersstr, optional

Passed to owslib.wps.WebProcessingService.

authrequests.auth.AuthBase

Requests-style auth class to authenticate. See https://2.python-requests.org/en/master/user/authentication/.

verifybool

Passed to owslib.wps.WebProcessingService.

certstr

Passed to owslib.wps.WebProcessingService.

progressbool

If True, enable interactive user mode.

versionstr

WPS version to use.

caps_xmlstr

A WPS GetCapabilities response for testing.

desc_xmlstr

A WPS DescribeProcess response with “identifier=all” for testing.

languagestr

Passed to owslib.wps.WebProcessingService (e.g. ‘fr-CA’, ‘en_US’).

lineagebool

If True, the Execute operation includes lineage information.

**kwdsdict

Passed to owslib.wps.WebProcessingService.

Examples

>>> emu = WPSClient(url="<server url>")
>>> emu.hello("stranger")
'Hello stranger'
property language
property languages
birdy.client.base.nb_form(wps: WPSClient, pid: str) → None[source]

Return a Notebook form to enter input values and launch process.

Parameters

wpsWPSClient

The WPS client.

pidstr

The process identifier.

birdy.client.base.sort_inputs_key(i: Input)[source]

Key function for sorting process inputs.

The order is:

  • Inputs that have minOccurs >= 1 and no default value

  • Inputs that have minOccurs >= 1 and a default value

  • Every other input

Parameters

iowslib.wps.Input

An owslib Input.

Notes

The defaultValue for ComplexData is ComplexData instance specifying mimetype, encoding and schema.