Warning
This document is for an in-development version 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.tool_util.toolbox.views package¶
Submodules¶
galaxy.tool_util.toolbox.views.definitions module¶
- class galaxy.tool_util.toolbox.views.definitions.StaticToolBoxViewTypeEnum(value)[source]¶
-
An enumeration.
- generic = 'generic'¶
- activity = 'activity'¶
- publication = 'publication'¶
- training = 'training'¶
- class galaxy.tool_util.toolbox.views.definitions.ExcludeTool(*, tool_id: str)[source]¶
Bases:
BaseModel
- class galaxy.tool_util.toolbox.views.definitions.ExcludeToolRegex(*, tool_id_regex: str)[source]¶
Bases:
BaseModel
- class galaxy.tool_util.toolbox.views.definitions.ExcludeTypes(*, types: List[str])[source]¶
Bases:
BaseModel
- class galaxy.tool_util.toolbox.views.definitions.Tool(*, type: typing_extensions.Literal[tool] = 'tool', id: str)[source]¶
Bases:
BaseModel
- content_type: typing_extensions.Literal[tool]¶
- class galaxy.tool_util.toolbox.views.definitions.Label(*, type: typing_extensions.Literal[label] = 'label', id: Optional[str] = None, text: str)[source]¶
Bases:
BaseModel
- content_type: typing_extensions.Literal[label]¶
- class galaxy.tool_util.toolbox.views.definitions.LabelShortcut(*, label: str, content_type: str = 'simple_label')[source]¶
Bases:
BaseModel
- class galaxy.tool_util.toolbox.views.definitions.Workflow(*, type: typing_extensions.Literal[workflow] = 'workflow', id: str)[source]¶
Bases:
BaseModel
- content_type: typing_extensions.Literal[workflow]¶
- class galaxy.tool_util.toolbox.views.definitions.ItemsFrom(*, items_from: str, excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]] = None, content_type: str = 'items_from')[source]¶
Bases:
BaseModel
- excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]]¶
- class galaxy.tool_util.toolbox.views.definitions.Section(*, type: typing_extensions.Literal[section], id: Optional[str] = None, name: Optional[str] = None, items: Optional[List[Union[Tool, Label, LabelShortcut, Workflow, ItemsFrom]]] = None, excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]] = None)[source]¶
Bases:
BaseModel
,HasItems
- content_type: typing_extensions.Literal[section]¶
- excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]]¶
- class galaxy.tool_util.toolbox.views.definitions.SectionAlias(*, section: str, excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]] = None, content_type: str = 'section_alias')[source]¶
Bases:
BaseModel
- excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]]¶
- class galaxy.tool_util.toolbox.views.definitions.SectionAliases(*, sections: List[str], excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]] = None, content_type: str = 'section_aliases')[source]¶
Bases:
BaseModel
- excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]]¶
- class galaxy.tool_util.toolbox.views.definitions.StaticToolBoxView(*, id: str, name: str, description: Optional[str] = None, type: StaticToolBoxViewTypeEnum, items: Optional[List[Union[Section, SectionAlias, SectionAliases, Tool, Label, LabelShortcut, Workflow, ItemsFrom]]] = None, excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]] = None)[source]¶
Bases:
BaseModel
,HasItems
- view_type: StaticToolBoxViewTypeEnum¶
- items: Optional[List[Union[Section, SectionAlias, SectionAliases, Tool, Label, LabelShortcut, Workflow, ItemsFrom]]]¶
- excludes: Optional[List[Union[ExcludeTool, ExcludeToolRegex, ExcludeTypes]]]¶
galaxy.tool_util.toolbox.views.edam module¶
- class galaxy.tool_util.toolbox.views.edam.EdamPanelMode(value)[source]¶
-
An enumeration.
- merged = 'merged'¶
- topics = 'topics'¶
- operations = 'operations'¶
- class galaxy.tool_util.toolbox.views.edam.EdamToolPanelView(edam: Dict[str, Dict], mode: EdamPanelMode = EdamPanelMode.merged)[source]¶
Bases:
ToolPanelView
- apply_view(base_tool_panel: ToolPanelElements, toolbox_registry: ToolBoxRegistry) ToolPanelElements [source]¶
Consume tool panel state and return custom tool panel view.
- to_model() ToolPanelViewModel [source]¶
Convert abstract description to dictionary description to emit via the API.
galaxy.tool_util.toolbox.views.interface module¶
- class galaxy.tool_util.toolbox.views.interface.ToolPanelViewModelType(value)[source]¶
-
An enumeration.
- default_type = 'default'¶
- generic = 'generic'¶
- activity = 'activity'¶
- ontology = 'ontology'¶
- publication = 'publication'¶
- training = 'training'¶
- class galaxy.tool_util.toolbox.views.interface.ToolPanelViewModel(*, id: str, model_class: str, name: str, description: Optional[str] = None, view_type: ToolPanelViewModelType, searchable: bool)[source]¶
Bases:
BaseModel
A view of ToolPanelView objects serialized for the API.
- view_type: ToolPanelViewModelType¶
- class galaxy.tool_util.toolbox.views.interface.ToolBoxRegistry[source]¶
Bases:
object
View of ToolBox provided to ToolPanelView to reason about tools loaded.
- abstract has_tool(tool_id: str) bool [source]¶
Return bool indicating if tool with specified id is loaded.
- abstract add_tool_to_tool_panel_view(tool, tool_panel_component: HasPanelItems) None [source]¶
Add tool to the tool panel view component (root or section).
- class galaxy.tool_util.toolbox.views.interface.ToolPanelView[source]¶
Bases:
object
- abstract apply_view(base_tool_panel: ToolPanelElements, toolbox_registry: ToolBoxRegistry) ToolPanelElements [source]¶
Consume tool panel state and return custom tool panel view.
- abstract to_model() ToolPanelViewModel [source]¶
Convert abstract description to dictionary description to emit via the API.
- galaxy.tool_util.toolbox.views.interface.walk_loaded_tools(tool_panel: ToolPanelElements, toolbox_registry: ToolBoxRegistry)[source]¶
galaxy.tool_util.toolbox.views.sources module¶
galaxy.tool_util.toolbox.views.static module¶
- class galaxy.tool_util.toolbox.views.static.StaticToolPanelView(definition: StaticToolBoxView)[source]¶
Bases:
ToolPanelView
- __init__(definition: StaticToolBoxView)[source]¶
- apply_view(base_tool_panel: ToolPanelElements, toolbox_registry: ToolBoxRegistry) ToolPanelElements [source]¶
Consume tool panel state and return custom tool panel view.
- to_model() ToolPanelViewModel [source]¶
Convert abstract description to dictionary description to emit via the API.