Coverage for pephubclient/modules/view.py: 82%
79 statements
« prev ^ index » next coverage.py v7.15.3, created at 2026-08-04 18:15 +0000
« prev ^ index » next coverage.py v7.15.3, created at 2026-08-04 18:15 +0000
1from typing import Union
2import peppy
3import logging
5from pephubclient.helpers import RequestManager
6from pephubclient.constants import (
7 PEPHUB_VIEW_URL,
8 PEPHUB_VIEW_SAMPLE_URL,
9 ResponseStatusCodes,
10)
11from pephubclient.exceptions import ResponseError
12from pephubclient.models import ProjectDict
14_LOGGER = logging.getLogger("pephubclient")
17class PEPHubView(RequestManager):
18 """
19 Class for managing views in PEPhub and provides methods for
20 getting, creating, updating and removing views.
22 This class aims to warp the Views API for easier maintenance and
23 better user experience.
24 """
26 def __init__(self, jwt_data: str = None):
27 """
28 :param jwt_data: jwt token for authorization
29 """
31 self.__jwt_data = jwt_data
33 def get(
34 self, namespace: str, name: str, tag: str, view_name: str, raw: bool = False
35 ) -> Union[peppy.Project, dict]:
36 """
37 Get view from project in PEPhub.
39 :param namespace: namespace of project
40 :param name: name of project
41 :param tag: tag of project
42 :param view_name: name of the view
43 :param raw: if True, return raw response
44 :return: peppy.Project object or dictionary of the project (view)
45 """
46 url = self._build_view_request_url(
47 namespace=namespace, name=name, view_name=view_name
48 )
50 url = url + self.parse_query_param(pep_variables={"tag": tag})
52 response = self.send_request(
53 method="GET", url=url, headers=self.parse_header(self.__jwt_data)
54 )
55 if response.status_code == ResponseStatusCodes.OK:
56 output = self.decode_response(response, output_json=True)
57 if raw:
58 return output
59 output = ProjectDict(**output).model_dump(by_alias=True)
60 return peppy.Project.from_dict(output)
61 elif response.status_code == ResponseStatusCodes.NOT_EXIST:
62 raise ResponseError("View does not exist, or you are unauthorized.")
63 else:
64 raise ResponseError(
65 f"Internal server error. Unexpected return value. Error: {response.status_code}"
66 )
68 def create(
69 self,
70 namespace: str,
71 name: str,
72 tag: str,
73 view_name: str,
74 description: str = None,
75 sample_list: list = None,
76 no_fail: bool = False,
77 ):
78 """
79 Create view in project in PEPhub.
81 :param namespace: namespace of project
82 :param name: name of project
83 :param tag: tag of project
84 :param description: description of the view
85 :param view_name: name of the view
86 :param sample_list: list of sample names
87 :param no_fail: whether to raise an error if view was not added to the project
88 """
90 if not sample_list or not isinstance(sample_list, list):
91 raise ValueError("Sample list must be a list of sample names.")
93 url = self._build_view_request_url(
94 namespace=namespace, name=name, view_name=view_name
95 )
97 url = url + self.parse_query_param(pep_variables={"tag": tag})
99 response = self.send_request(
100 method="POST",
101 url=url,
102 headers=self.parse_header(self.__jwt_data),
103 params={"description": description, "no_fail": no_fail},
104 json=sample_list,
105 )
106 if response.status_code == ResponseStatusCodes.ACCEPTED:
107 _LOGGER.info(
108 f"View '{view_name}' created in project '{namespace}/{name}:{tag}' successfully."
109 )
110 return None
111 elif response.status_code == ResponseStatusCodes.NOT_EXIST:
112 raise ResponseError(
113 f"Project '{namespace}/{name}:{tag}' or one of the samples does not exist."
114 )
115 elif response.status_code == ResponseStatusCodes.CONFLICT:
116 raise ResponseError(f"View '{view_name}' already exists in the project.")
117 else:
118 raise ResponseError(f"Unexpected return value.{response.status_code}")
120 def delete(self, namespace: str, name: str, tag: str, view_name: str) -> None:
121 """
122 Delete view from project in PEPhub.
124 :param namespace: namespace of project
125 :param name: name of project
126 :param tag: tag of project
127 :param view_name: name of the view
128 :return: None
129 """
130 url = self._build_view_request_url(
131 namespace=namespace, name=name, view_name=view_name
132 )
134 url = url + self.parse_query_param(pep_variables={"tag": tag})
136 response = self.send_request(
137 method="DELETE", url=url, headers=self.parse_header(self.__jwt_data)
138 )
140 if response.status_code == ResponseStatusCodes.ACCEPTED:
141 _LOGGER.info(
142 f"View '{view_name}' deleted from project '{namespace}/{name}:{tag}' successfully."
143 )
144 return None
145 elif response.status_code == ResponseStatusCodes.NOT_EXIST:
146 raise ResponseError("View does not exists, or you are unauthorized.")
147 elif response.status_code == ResponseStatusCodes.UNAUTHORIZED:
148 raise ResponseError("You are unauthorized to delete this view.")
149 else:
150 raise ResponseError("Unexpected return value. ")
152 def add_sample(
153 self,
154 namespace: str,
155 name: str,
156 tag: str,
157 view_name: str,
158 sample_name: str,
159 ):
160 """
161 Add sample to view in project in PEPhub.
163 :param namespace: namespace of project
164 :param name: name of project
165 :param tag: tag of project
166 :param view_name: name of the view
167 :param sample_name: name of the sample
168 """
169 url = self._build_view_request_url(
170 namespace=namespace,
171 name=name,
172 view_name=view_name,
173 sample_name=sample_name,
174 )
176 url = url + self.parse_query_param(pep_variables={"tag": tag})
178 response = self.send_request(
179 method="POST",
180 url=url,
181 headers=self.parse_header(self.__jwt_data),
182 )
183 if response.status_code == ResponseStatusCodes.ACCEPTED:
184 _LOGGER.info(
185 f"Sample '{sample_name}' added to view '{view_name}' in project '{namespace}/{name}:{tag}' successfully."
186 )
187 return None
188 elif response.status_code == ResponseStatusCodes.NOT_EXIST:
189 raise ResponseError(
190 f"Sample '{sample_name}' or project {namespace}/{name}:{tag} does not exist."
191 )
192 elif response.status_code == ResponseStatusCodes.CONFLICT:
193 raise ResponseError(f"Sample '{sample_name}' already exists in the view.")
194 else:
195 raise ResponseError(
196 f"Unexpected return value. Error: {response.status_code}"
197 )
199 def remove_sample(
200 self,
201 namespace: str,
202 name: str,
203 tag: str,
204 view_name: str,
205 sample_name: str,
206 ):
207 """
208 Remove sample from view in project in PEPhub.
210 :param namespace: namespace of project
211 :param name: name of project
212 :param tag: tag of project
213 :param view_name: name of the view
214 :param sample_name: name of the sample
215 :return: None
216 """
217 url = self._build_view_request_url(
218 namespace=namespace,
219 name=name,
220 view_name=view_name,
221 sample_name=sample_name,
222 )
224 url = url + self.parse_query_param(pep_variables={"tag": tag})
226 response = self.send_request(
227 method="DELETE",
228 url=url,
229 headers=self.parse_header(self.__jwt_data),
230 )
231 if response.status_code == ResponseStatusCodes.ACCEPTED:
232 _LOGGER.info(
233 f"Sample '{sample_name}' removed from view '{view_name}' in project '{namespace}/{name}:{tag}' successfully."
234 )
235 return None
236 elif response.status_code == ResponseStatusCodes.NOT_EXIST:
237 raise ResponseError(
238 f"Sample '{sample_name}' or project {namespace}/{name}:{tag} does not exist. "
239 )
240 elif response.status_code == ResponseStatusCodes.UNAUTHORIZED:
241 raise ResponseError(
242 "You are unauthorized to remove this sample from the view."
243 )
244 else:
245 raise ResponseError(
246 f"Unexpected return value. Error: {response.status_code}"
247 )
249 @staticmethod
250 def _build_view_request_url(
251 namespace: str, name: str, view_name: str, sample_name: str = None
252 ):
253 """
254 Build URL for view request.
256 :param namespace: namespace of project
257 :param name: name of project
258 :param view_name: name of view
259 :return: URL
260 """
261 if sample_name:
262 return PEPHUB_VIEW_SAMPLE_URL.format(
263 namespace=namespace,
264 project=name,
265 view_name=view_name,
266 sample_name=sample_name,
267 )
268 return PEPHUB_VIEW_URL.format(
269 namespace=namespace,
270 project=name,
271 view_name=view_name,
272 )