birdy.client.notebook module

Client Notebook Module.

class birdy.client.notebook.Form(func)[source]

Bases: object

Create notebook form to launch WPS process.

Parameters

funcfunction

A function.

build_ui(input_widgets, of_widgets, go)[source]

Create the form.

Parameters

input_widgetsdict

Input widgets.

of_widgetsdict

Output form widgets.

gostr

Footer.

Returns

AppLayout

An instance of the UI.

get(asobj: bool = False)[source]

Return the process response outputs.

Parameters

asobjbool

If True, object_converters will be used.

input_widget_values(widgets: dict) → dict[source]

Return values from input widgets.

Parameters

widgetsdict

A dictionary of input widgets.

Returns

dict

A dictionary of input values.

input_widgets(inputs: dict) → dict[source]

Return input parameter widgets.

Parameters

inputsdict

A dictionary of input parameters.

Returns

dict

A dictionary of input widgets.

output_format_widget_values(widgets: dict) → dict[source]

Return the output_formats dict from output_formats widgets.

Parameters

widgetsdict

output_formats widgets.

Returns

dict

A dictionary of output_formats.

output_formats_widgets(outputs: dict) → dict[source]

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

Parameters

outputsdict

A dictionary of output parameters.

Returns

dict

A dictionary of output format widgets.

birdy.client.notebook.gui(func)[source]

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

Parameters

funcfunction

A function.

Returns

Form

A form to enter input values and launch the process.

birdy.client.notebook.input2widget(inpt: Input)[source]

Return a Notebook widget to enter values for the input.

Parameters

inptInput

A WPS Input instance.

Returns

Any

Widget.

birdy.client.notebook.is_notebook()[source]

Return whether this function is executed in a notebook environment.

birdy.client.notebook.monitor(execution: WPSExecution, sleep: int = 3)[source]

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

Parameters

executionWPSExecution instance

The execute response to monitor.

sleepint

Number of seconds to wait before each status check.

birdy.client.notebook.output2widget(output)[source]

Return notebook widget based on output mime-type.

Parameters

outputAny

Unused.