birdy.client.utils module

birdy.client.utils.add_output_format(output_dictionary, output_identifier, as_ref=None, mimetype=None)[source]

Add an output format to an already existing dictionary.

Parameters:

  • output_dictionary (dict) – The dictionary (created with create_output_dictionary()) to which this output format will be added.

  • output_identifier (str) – Identifier of the output.

  • as_ref (True, False or None) – Determines if this output will be returned as a reference or not. None for process default.

  • mimetype (str or None) – If the process supports multiple MIME types, it can be specified with this argument. None for process default.

birdy.client.utils.build_process_doc(process)[source]

Create docstring from process metadata.

birdy.client.utils.build_wps_client_doc(wps, processes)[source]

Create WPSClient docstring.

Parameters:

  • wps (owslib.wps.WebProcessingService)

  • processes (Dict[str, owslib.wps.Process])

Returns:

The formatted docstring for this WPSClient

Return type:

str

birdy.client.utils.create_output_dictionary(output_identifier, as_ref=None, mimetype=None)[source]

Create an output format dictionary.

Parameters:

  • output_identifier (str) – Identifier of the output.

  • as_ref (True, False or None) – Determines if this output will be returned as a reference or not. None for process default.

  • mimetype (str or None) – If the process supports multiple MIME types, it can be specified with this argument. None for process default.

Returns:

output_dictionary

Return type:

dict

birdy.client.utils.extend_instance(obj, cls)[source]

Apply mixins to a class instance after creation.

birdy.client.utils.filter_case_insensitive(names, complete_list)[source]

Filter a sequence of process names into a known and unknown list.

birdy.client.utils.format_type(obj)[source]

Create docstring entry for input parameter from an OWSlib object.

birdy.client.utils.from_owslib(value, data_type)[source]

Convert a string into another data type.

birdy.client.utils.is_embedded_in_request(url, value)[source]

Whether or not to encode the value as raw data content.

Returns True if

  • value is a file:/// URI or a local path

  • value is a File-like instance

  • url is not localhost

  • value is a File object

  • value is already the string content

birdy.client.utils.pretty_repr(obj, linebreaks=True)[source]

Output pretty repr for an Output.

Parameters:

  • obj (any type)

  • linebreaks (bool) – If True, split attributes with linebreaks

birdy.client.utils.py_type(data_type)[source]

Return the python data type matching the WPS dataType.

birdy.client.utils.to_owslib(value, data_type, encoding=None, mimetype=None, schema=None)[source]

Convert value into OWSlib objects.