Warning

This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.forms package

Submodules

galaxy.forms.forms module

FormDefinition and field factories

class galaxy.forms.forms.FormDefinitionFactory(form_types, field_type_factories)[source]

Bases: object

__init__(form_types, field_type_factories)[source]

Initialize self. See help(type(self)) for accurate signature.

new(form_type, name, description=None, fields=None, layout=None, form_definition_current=None)[source]

Return new FormDefinition.

from_elem(elem, form_definition_current=None)[source]

Return FormDefinition created from an xml element.

class galaxy.forms.forms.FormDefinitionFieldFactory[source]

Bases: object

type: str
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition created from an xml element.

class galaxy.forms.forms.FormDefinitionTextFieldFactory[source]

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type: str = 'text'
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None, area=False)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionPasswordFieldFactory[source]

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type: str = 'password'
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None, area=False)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionAddressFieldFactory[source]

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type: str = 'address'
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionWorkflowFieldFactory[source]

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type: str = 'workflow'
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionWorkflowMappingFieldFactory[source]

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type: str = 'workflowmapping'
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionHistoryFieldFactory[source]

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type: str = 'history'
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionSelectFieldFactory[source]

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type: str = 'select'
new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None, options=None, checkboxes=False)[source]

Return new FormDefinition field.

from_elem(elem, layout=None)[source]

Return FormDefinition field created from an xml element.