Coverage for biobb_io/api/pdb_cluster_zip.py: 82%

57 statements  

« prev     ^ index     » next       coverage.py v7.3.1, created at 2023-09-07 10:41 +0000

1#!/usr/bin/env python 

2 

3"""PdbClusterZip Module""" 

4import os 

5import argparse 

6from biobb_common.generic.biobb_object import BiobbObject 

7from biobb_common.configuration import settings 

8from biobb_common.tools import file_utils as fu 

9from biobb_common.tools.file_utils import launchlogger 

10from biobb_io.api.common import check_mandatory_property, check_output_path, get_cluster_pdb_codes, download_pdb, write_pdb 

11 

12 

13class PdbClusterZip(BiobbObject): 

14 """ 

15 | biobb_io PdbClusterZip 

16 | This class is a wrapper for downloading a PDB cluster from the Protein Data Bank. 

17 | Wrapper for the `Protein Data Bank in Europe <https://www.ebi.ac.uk/pdbe/>`_, the `Protein Data Bank <https://www.rcsb.org/>`_ and the `MMB PDB mirror <http://mmb.irbbarcelona.org/api/>`_ for downloading a PDB cluster. 

18 

19 Args: 

20 output_pdb_zip_path (str): Path to the ZIP file containing the output PDB files. File type: output. `Sample file <https://github.com/bioexcel/biobb_io/raw/master/biobb_io/test/reference/api/output_pdb_cluster.zip>`_. Accepted formats: zip (edam:format_3987). 

21 properties (dic - Python dictionary object containing the tool parameters, not input/output files): 

22 * **pdb_code** (*str*) - (None) RSCB PDB code. 

23 * **filter** (*str*) - (["ATOM", "MODEL", "ENDMDL"]) Array of groups to be kept. If value is None or False no filter will be applied. All the possible values are defined in the official PDB specification (http://www.wwpdb.org/documentation/file-format-content/format33/v3.3.html) 

24 * **cluster** (*int*) - (90) Sequence Similarity Cutoff. Values: 50 (structures having less than 50% sequence identity to each other), 70 (structures having less than 70% sequence identity to each other), 90 (structures having less than 90% sequence identity to each other), 95 (structures having less than 95% sequence identity to each other). 

25 * **api_id** (*str*) - ("pdbe") Identifier of the PDB REST API from which the PDB structure will be downloaded. Values: pdbe (`PDB in Europe REST API <https://www.ebi.ac.uk/pdbe/pdbe-rest-api>`_), pdb (`RCSB PDB REST API <https://data.rcsb.org/>`_), mmb (`MMB PDB mirror API <http://mmb.irbbarcelona.org/api/>`_). 

26 * **remove_tmp** (*bool*) - (True) [WF property] Remove temporal files. 

27 * **restart** (*bool*) - (False) [WF property] Do not execute if output files exist. 

28 

29 Examples: 

30 This is a use example of how to use the building block from Python:: 

31 

32 from biobb_io.api.pdb_cluster_zip import pdb_cluster_zip 

33 prop = { 

34 'pdb_code': '2VGB', 

35 'filter': ['ATOM', 'MODEL', 'ENDMDL'], 

36 'cluster': 90, 

37 'api_id': 'pdbe' 

38 } 

39 pdb_cluster_zip(output_pdb_zip_path='/path/to/newStructures.zip', 

40 properties=prop) 

41 

42 Info: 

43 * wrapped_software: 

44 * name: Protein Data Bank 

45 * license: Apache-2.0 

46 * ontology: 

47 * name: EDAM 

48 * schema: http://edamontology.org/EDAM.owl 

49 

50 """ 

51 

52 def __init__(self, output_pdb_zip_path, 

53 properties=None, **kwargs) -> None: 

54 properties = properties or {} 

55 

56 # Call parent class constructor 

57 super().__init__(properties) 

58 self.locals_var_dict = locals().copy() 

59 

60 # Input/Output files 

61 self.io_dict = { 

62 "out": {"output_pdb_zip_path": output_pdb_zip_path} 

63 } 

64 

65 # Properties specific for BB 

66 self.api_id = properties.get('api_id', 'pdbe') 

67 self.pdb_code = properties.get('pdb_code', None) 

68 self.filter = properties.get('filter', ['ATOM', 'MODEL', 'ENDMDL']) 

69 self.cluster = properties.get('cluster', 90) 

70 self.properties = properties 

71 

72 # Check the properties 

73 self.check_properties(properties) 

74 self.check_arguments() 

75 

76 def check_data_params(self, out_log, err_log): 

77 """ Checks all the input/output paths and parameters """ 

78 self.output_pdb_zip_path = check_output_path(self.io_dict["out"]["output_pdb_zip_path"], "output_pdb_zip_path", False, out_log, self.__class__.__name__) 

79 

80 @launchlogger 

81 def launch(self) -> int: 

82 """Execute the :class:`PdbClusterZip <api.pdb_cluster_zip.PdbClusterZip>` api.pdb_cluster_zip.PdbClusterZip object.""" 

83 

84 # check input/output paths and parameters 

85 self.check_data_params(self.out_log, self.err_log) 

86 

87 # Setup Biobb 

88 if self.check_restart(): 

89 return 0 

90 

91 check_mandatory_property(self.pdb_code, 'pdb_code', self.out_log, self.__class__.__name__) 

92 

93 self.pdb_code = self.pdb_code.strip().lower() 

94 

95 file_list = [] 

96 # Downloading PDB_files 

97 pdb_code_list = get_cluster_pdb_codes(pdb_code=self.pdb_code, cluster=self.cluster, out_log=self.out_log, global_log=self.global_log) 

98 unique_dir = fu.create_unique_dir() 

99 for pdb_code in pdb_code_list: 

100 pdb_file = os.path.join(unique_dir, pdb_code+".pdb") 

101 pdb_string = download_pdb(pdb_code=pdb_code, api_id=self.api_id, out_log=self.out_log, global_log=self.global_log) 

102 write_pdb(pdb_string, pdb_file, self.filter, self.out_log, self.global_log) 

103 file_list.append(os.path.abspath(pdb_file)) 

104 

105 # Zipping files 

106 fu.log("Zipping the pdb files to: %s" % self.output_pdb_zip_path) 

107 fu.zip_list(self.output_pdb_zip_path, file_list, out_log=self.out_log) 

108 

109 self.tmp_files.extend([ 

110 self.stage_io_dict.get("unique_dir"), 

111 unique_dir 

112 ]) 

113 self.remove_tmp_files() 

114 

115 self.check_arguments(output_files_created=True, raise_exception=False) 

116 

117 return 0 

118 

119 

120def pdb_cluster_zip(output_pdb_zip_path: str, properties: dict = None, **kwargs) -> int: 

121 """Execute the :class:`PdbClusterZip <api.pdb_cluster_zip.PdbClusterZip>` class and 

122 execute the :meth:`launch() <api.pdb_cluster_zip.PdbClusterZip.launch>` method.""" 

123 

124 return PdbClusterZip(output_pdb_zip_path=output_pdb_zip_path, 

125 properties=properties, **kwargs).launch() 

126 

127 

128def main(): 

129 """Command line execution of this building block. Please check the command line documentation.""" 

130 parser = argparse.ArgumentParser(description="Wrapper for the Protein Data Bank in Europe (https://www.ebi.ac.uk/pdbe/), the Protein Data Bank (https://www.rcsb.org/) and the MMB PDB mirror (http://mmb.irbbarcelona.org/api/) for downloading a PDB cluster.", formatter_class=lambda prog: argparse.RawTextHelpFormatter(prog, width=99999)) 

131 parser.add_argument('-c', '--config', required=False, help="This file can be a YAML file, JSON file or JSON string") 

132 

133 # Specific args of each building block 

134 required_args = parser.add_argument_group('required arguments') 

135 required_args.add_argument('-o', '--output_pdb_zip_path', required=True, help="Path to the ZIP or PDB file containing the output PDB files. Accepted formats: pdb, zip.") 

136 

137 args = parser.parse_args() 

138 config = args.config if args.config else None 

139 properties = settings.ConfReader(config=config).get_prop_dic() 

140 

141 # Specific call of each building block 

142 pdb_cluster_zip(output_pdb_zip_path=args.output_pdb_zip_path, 

143 properties=properties) 

144 

145 

146if __name__ == '__main__': 

147 main()