Coverage for pephubclient/modules/sample.py: 100%

56 statements  

« prev     ^ index     » next       coverage.py v7.15.3, created at 2026-08-04 18:15 +0000

1import logging 

2 

3from pephubclient.helpers import RequestManager 

4from pephubclient.constants import PEPHUB_SAMPLE_URL, ResponseStatusCodes 

5from pephubclient.exceptions import ResponseError 

6 

7_LOGGER = logging.getLogger("pephubclient") 

8 

9 

10class PEPHubSample(RequestManager): 

11 """ 

12 Class for managing samples in PEPhub and provides methods for 

13 getting, creating, updating and removing samples. 

14 This class is not related to peppy.Sample class. 

15 """ 

16 

17 def __init__(self, jwt_data: str = None): 

18 """ 

19 :param jwt_data: jwt token for authorization 

20 """ 

21 

22 self.__jwt_data = jwt_data 

23 

24 def get( 

25 self, 

26 namespace: str, 

27 name: str, 

28 tag: str, 

29 sample_name: str = None, 

30 ) -> dict: 

31 """ 

32 Get sample from project in PEPhub. 

33 

34 :param namespace: namespace of project 

35 :param name: name of project 

36 :param tag: tag of project 

37 :param sample_name: sample name 

38 :return: Sample object 

39 """ 

40 url = self._build_sample_request_url( 

41 namespace=namespace, name=name, sample_name=sample_name 

42 ) 

43 

44 url = url + self.parse_query_param(pep_variables={"tag": tag}) 

45 

46 response = self.send_request( 

47 method="GET", url=url, headers=self.parse_header(self.__jwt_data) 

48 ) 

49 if response.status_code == ResponseStatusCodes.OK: 

50 return self.decode_response(response, output_json=True) 

51 if response.status_code == ResponseStatusCodes.NOT_EXIST: 

52 raise ResponseError( 

53 f"Sample does not exist. Project: '{namespace}/{name}:{tag}'. Sample_name: '{sample_name}'" 

54 ) 

55 elif response.status_code == ResponseStatusCodes.INTERNAL_ERROR: 

56 raise ResponseError("Internal server error. Unexpected return value.") 

57 else: 

58 raise ResponseError( 

59 f"Unexpected return value. Error: {response.status_code}" 

60 ) 

61 

62 def create( 

63 self, 

64 namespace: str, 

65 name: str, 

66 tag: str, 

67 sample_name: str, 

68 sample_dict: dict, 

69 overwrite: bool = False, 

70 ) -> None: 

71 """ 

72 Create sample in project in PEPhub. 

73 

74 :param namespace: namespace of project 

75 :param name: name of project 

76 :param tag: tag of project 

77 :param sample_dict: sample dict 

78 :param sample_name: sample name 

79 :param overwrite: overwrite sample if it exists 

80 :return: None 

81 """ 

82 url = self._build_sample_request_url( 

83 namespace=namespace, 

84 name=name, 

85 sample_name=sample_name, 

86 ) 

87 

88 url = url + self.parse_query_param( 

89 pep_variables={"tag": tag, "overwrite": overwrite} 

90 ) 

91 

92 # add sample name to sample_dict if it is not there 

93 if sample_name not in sample_dict.values(): 

94 sample_dict["sample_name"] = sample_name 

95 

96 response = self.send_request( 

97 method="POST", 

98 url=url, 

99 headers=self.parse_header(self.__jwt_data), 

100 json=sample_dict, 

101 ) 

102 if response.status_code == ResponseStatusCodes.ACCEPTED: 

103 _LOGGER.info( 

104 f"Sample '{sample_name}' added to project '{namespace}/{name}:{tag}' successfully." 

105 ) 

106 return None 

107 elif response.status_code == ResponseStatusCodes.NOT_EXIST: 

108 raise ResponseError(f"Project '{namespace}/{name}:{tag}' does not exist.") 

109 elif response.status_code == ResponseStatusCodes.CONFLICT: 

110 raise ResponseError( 

111 f"Sample '{sample_name}' already exists. Set overwrite to True to overwrite sample." 

112 ) 

113 else: 

114 raise ResponseError( 

115 f"Unexpected return value. Error: {response.status_code}" 

116 ) 

117 

118 def update( 

119 self, 

120 namespace: str, 

121 name: str, 

122 tag: str, 

123 sample_name: str, 

124 sample_dict: dict, 

125 ): 

126 """ 

127 Update sample in project in PEPhub. 

128 

129 :param namespace: namespace of project 

130 :param name: name of project 

131 :param tag: tag of project 

132 :param sample_name: sample name 

133 :param sample_dict: sample dict, that contain elements to update, or 

134 :return: None 

135 """ 

136 

137 url = self._build_sample_request_url( 

138 namespace=namespace, name=name, sample_name=sample_name 

139 ) 

140 

141 url = url + self.parse_query_param(pep_variables={"tag": tag}) 

142 

143 response = self.send_request( 

144 method="PATCH", 

145 url=url, 

146 headers=self.parse_header(self.__jwt_data), 

147 json=sample_dict, 

148 ) 

149 if response.status_code == ResponseStatusCodes.ACCEPTED: 

150 _LOGGER.info( 

151 f"Sample '{sample_name}' updated in project '{namespace}/{name}:{tag}' successfully." 

152 ) 

153 return None 

154 elif response.status_code == ResponseStatusCodes.NOT_EXIST: 

155 raise ResponseError( 

156 f"Sample '{sample_name}' or project {namespace}/{name}:{tag} does not exist. Error: {response.status_code}" 

157 ) 

158 else: 

159 raise ResponseError( 

160 f"Unexpected return value. Error: {response.status_code}" 

161 ) 

162 

163 def remove(self, namespace: str, name: str, tag: str, sample_name: str): 

164 """ 

165 Remove sample from project in PEPhub. 

166 

167 :param namespace: namespace of project 

168 :param name: name of project 

169 :param tag: tag of project 

170 :param sample_name: sample name 

171 :return: None 

172 """ 

173 url = self._build_sample_request_url( 

174 namespace=namespace, name=name, sample_name=sample_name 

175 ) 

176 

177 url = url + self.parse_query_param(pep_variables={"tag": tag}) 

178 

179 response = self.send_request( 

180 method="DELETE", 

181 url=url, 

182 headers=self.parse_header(self.__jwt_data), 

183 ) 

184 if response.status_code == ResponseStatusCodes.ACCEPTED: 

185 _LOGGER.info( 

186 f"Sample '{sample_name}' removed from project '{namespace}/{name}:{tag}' successfully." 

187 ) 

188 return None 

189 elif response.status_code == ResponseStatusCodes.NOT_EXIST: 

190 raise ResponseError( 

191 f"Sample '{sample_name}' or project {namespace}/{name}:{tag} does not exist. Error: {response.status_code}" 

192 ) 

193 else: 

194 raise ResponseError( 

195 f"Unexpected return value. Error: {response.status_code}" 

196 ) 

197 

198 @staticmethod 

199 def _build_sample_request_url(namespace: str, name: str, sample_name: str) -> str: 

200 """ 

201 Build url for sample request. 

202 

203 :param namespace: namespace where project will be uploaded 

204 :return: url string 

205 """ 

206 return PEPHUB_SAMPLE_URL.format( 

207 namespace=namespace, project=name, sample_name=sample_name 

208 )