birdy.client.notebook module

class birdy.client.notebook.Form(func)

Bases: object

Create notebook form to launch WPS process.

build_ui(input_widgets, of_widgets, go)

Create the form.

get(asobj=False)

Return the process response outputs.

Parameters:

asobj (bool) – If True, object_converters will be used.

input_widget_values(widgets)

Return values from input widgets.

input_widgets(inputs)

Return input parameter widgets.

output_format_widget_values(widgets)

Return the output_formats dict from output_formats widgets.

output_formats_widgets(outputs)

Return output formats parameter widgets for ComplexData outputs that have multiple supported formats.

birdy.client.notebook.gui(func)

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

birdy.client.notebook.input2widget(inpt)

Return a Notebook widget to enter values for the input.

birdy.client.notebook.is_notebook()

Return whether or not this function is executed in a notebook environment.

birdy.client.notebook.monitor(execution, sleep=3)

Monitor the execution of a process using a notebook progress bar widget.

Parameters:

• execution (WPSExecution instance) – The execute response to monitor.

• sleep (float) – Number of seconds to wait before each status check.

birdy.client.notebook.output2widget(output)

Return notebook widget based on output mime-type.