#!/usr/bin/env python
"""Module containing the AlphaFold class and the command line interface."""
from typing import Optional
from biobb_common.generic.biobb_object import BiobbObject
from biobb_common.tools.file_utils import launchlogger
from biobb_io.api.common import (
check_mandatory_property,
check_output_path,
check_uniprot_code,
download_af,
write_pdb,
)
[docs]
class AlphaFold(BiobbObject):
"""
| biobb_io AlphaFold
| This class is a wrapper for downloading a PDB structure from the AlphaFold Protein Structure Database.
| Wrapper for the `AlphaFold Protein Structure Database <https://alphafold.ebi.ac.uk/>`_ for downloading a single PDB structure from its corresponding Uniprot code.
Args:
output_pdb_path (str): Path to the output PDB file. File type: output. `Sample file <https://github.com/bioexcel/biobb_io/raw/master/biobb_io/test/reference/api/output_alphafold.pdb>`_. Accepted formats: pdb (edam:format_1476).
properties (dic - Python dictionary object containing the tool parameters, not input/output files):
* **uniprot_code** (*str*) - (None) Uniprot code.
* **remove_tmp** (*bool*) - (True) [WF property] Remove temporal files.
* **restart** (*bool*) - (False) [WF property] Do not execute if output files exist.
* **sandbox_path** (*str*) - ("./") [WF property] Parent path to the sandbox directory.
Examples:
This is a use example of how to use the building block from Python::
from biobb_io.api.alphafold import alphafold
prop = {
'uniprot_code': 'P00489'
}
alphafold(output_pdb_path='/path/to/newStructure.pdb',
properties=prop)
Info:
* wrapped_software:
* name: AlphaFold Protein Structure Database
* license: Apache-2.0
* ontology:
* name: EDAM
* schema: http://edamontology.org/EDAM.owl
"""
def __init__(self, output_pdb_path, properties=None, **kwargs) -> None:
properties = properties or {}
# Call parent class constructor
super().__init__(properties)
self.locals_var_dict = locals().copy()
# Input/Output files
self.io_dict = {"out": {"output_pdb_path": output_pdb_path}}
# Properties specific for BB
self.uniprot_code = properties.get("uniprot_code", None)
self.properties = properties
# Check the properties
self.check_properties(properties)
self.check_arguments()
[docs]
def check_data_params(self, out_log, err_log):
"""Checks all the input/output paths and parameters"""
self.output_pdb_path = check_output_path(
self.io_dict["out"]["output_pdb_path"],
"output_pdb_path",
False,
out_log,
self.__class__.__name__,
)
[docs]
@launchlogger
def launch(self) -> int:
"""Execute the :class:`AlphaFold <api.alphafold.AlphaFold>` api.alphafold.AlphaFold object."""
# check input/output paths and parameters
self.check_data_params(self.out_log, self.err_log)
# Setup Biobb
if self.check_restart():
return 0
check_mandatory_property(
self.uniprot_code, "uniprot_code", self.out_log, self.__class__.__name__
)
self.uniprot_code = self.uniprot_code.strip().upper()
check_uniprot_code(self.uniprot_code, self.out_log, self.__class__.__name__)
# Downloading PDB file
pdb_string = download_af(
self.uniprot_code, self.out_log, self.global_log, self.__class__.__name__
)
write_pdb(pdb_string, self.output_pdb_path, None, self.out_log, self.global_log)
self.check_arguments(output_files_created=True, raise_exception=False)
return 0
[docs]
def alphafold(output_pdb_path: str, properties: Optional[dict] = None, **kwargs) -> int:
"""Execute the :class:`AlphaFold <api.alphafold.AlphaFold>` class and
execute the :meth:`launch() <api.alphafold.AlphaFold.launch>` method."""
return AlphaFold(**dict(locals())).launch()
alphafold.__doc__ = AlphaFold.__doc__
main = AlphaFold.get_main(alphafold, "This class is a wrapper for downloading a PDB structure from the Protein Data Bank.")
if __name__ == "__main__":
main()