1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
"""
Contains possible interactions with the Galaxy Forms
"""
from typing import (
Any,
Dict,
List,
TYPE_CHECKING,
)
from bioblend.galaxy.client import Client
if TYPE_CHECKING:
from bioblend.galaxy import GalaxyInstance
class FormsClient(Client):
module = "forms"
def __init__(self, galaxy_instance: "GalaxyInstance") -> None:
super().__init__(galaxy_instance)
def get_forms(self) -> List[Dict[str, Any]]:
"""
Get the list of all forms.
:rtype: list
:return: Displays a collection (list) of forms.
For example::
[{'id': 'f2db41e1fa331b3e',
'model_class': 'FormDefinition',
'name': 'First form',
'url': '/api/forms/f2db41e1fa331b3e'},
{'id': 'ebfb8f50c6abde6d',
'model_class': 'FormDefinition',
'name': 'second form',
'url': '/api/forms/ebfb8f50c6abde6d'}]
"""
return self._get()
def show_form(self, form_id: str) -> Dict[str, Any]:
"""
Get details of a given form.
:type form_id: str
:param form_id: Encoded form ID
:rtype: dict
:return: A description of the given form.
For example::
{'desc': 'here it is ',
'fields': [],
'form_definition_current_id': 'f2db41e1fa331b3e',
'id': 'f2db41e1fa331b3e',
'layout': [],
'model_class': 'FormDefinition',
'name': 'First form',
'url': '/api/forms/f2db41e1fa331b3e'}
"""
return self._get(id=form_id)
def create_form(self, form_xml_text: str) -> List[Dict[str, Any]]:
"""
Create a new form.
:type form_xml_text: str
:param form_xml_text: Form xml to create a form on galaxy instance
:rtype: list of dicts
:return: List with a single dictionary describing the created form
"""
payload = {
"xml_text": form_xml_text,
}
return self._post(payload=payload)
|
