Changeset 1736:b3b664abcfdd in orange-bioinformatics for _bioinformatics/obiKEGG/pathway.py


Ignore:
Timestamp:
04/05/13 19:43:36 (13 months ago)
Author:
Ales Erjavec <ales.erjavec@…>
Branch:
default
Message:

Added sphinx rst documentation for obiKEGG.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _bioinformatics/obiKEGG/pathway.py

    r1734 r1736  
    11""" 
    2 KEGG Pathway (from kgml file) 
     2============ 
     3KEGG Pathway 
     4============ 
    35 
    46""" 
     
    3234 
    3335class Pathway(object): 
     36    """ 
     37    Class representing a KEGG Pathway (parsed from a "kgml" file) 
     38 
     39    :param str pathway_id: A KEGG pathway id (e.g. 'path:hsa05130') 
     40 
     41    """ 
    3442    KGML_URL_FORMAT = "http://www.genome.jp/kegg-bin/download?entry={pathway_id}&format=kgml" 
    3543 
     
    5563 
    5664    def _get_kgml(self): 
    57         """ Return an open kgml file for the pathway. 
     65        """ 
     66        Return an open kgml file for the pathway. 
    5867        """ 
    5968        from datetime import datetime, timedelta 
     
    8796 
    8897    def _get_image_filename(self): 
    89         """ Return a filename of a local copy of the pathway image 
     98        """ 
     99        Return a filename of a local copy of the pathway image 
    90100        """ 
    91101        # TODO: keep-alive (using httplib if it supports it) 
     
    126136 
    127137    def _local_kgml_filename(self): 
    128         """ Return the local kgml xml filename for the pathway. 
     138        """ 
     139        Return the local kgml xml filename for the pathway. 
    129140        """ 
    130141        local_filename = os.path.join(self.local_cache, 
     
    137148            self.graphics = () 
    138149            self.components = [] 
    139             self.graphics = dict(dom_element.getElementsByTagName("graphics")[0].attributes.items()) 
    140             self.components = [node.getAttribute("id") for node in dom_element.getElementsByTagName("component")] 
     150 
     151            graphics = dom_element.getElementsByTagName("graphics")[0] 
     152            self.graphics = dict(graphics.attributes.items()) 
     153 
     154            components = dom_element.getElementsByTagName("component") 
     155            self.components = [node.getAttribute("id") for node in components] 
    141156 
    142157    class reaction(object): 
    143158        def __init__(self, dom_element): 
    144159            self.__dict__.update(dom_element.attributes.items()) 
    145             self.substrates = [node.getAttribute("name") for node in dom_element.getElementsByTagName("substrate")] 
    146             self.products = [node.getAttribute("name") for node in dom_element.getElementsByTagName("product")] 
     160            self.substrates = [node.getAttribute("name") for node in 
     161                               dom_element.getElementsByTagName("substrate")] 
     162            self.products = [node.getAttribute("name") for node in 
     163                             dom_element.getElementsByTagName("product")] 
    147164 
    148165    class relation(object): 
    149166        def __init__(self, dom_element): 
    150167            self.__dict__.update(dom_element.attributes.items()) 
    151             self.subtypes = [node.attributes.items() for node in dom_element.getElementsByTagName("subtype")] 
     168            self.subtypes = [node.attributes.items() for node in 
     169                             dom_element.getElementsByTagName("subtype")] 
    152170 
    153171    @cached_method 
     
    157175    @property 
    158176    def name(self): 
     177        """ 
     178        Pathway name/id (e.g. "path:hsa05130") 
     179        """ 
    159180        return self.pathway_attributes().get("name") 
    160181 
    161182    @property 
    162183    def org(self): 
     184        """ 
     185        Pathway organism code (e.g. 'hsa') 
     186        """ 
    163187        return self.pathway_attributes().get("org") 
    164188 
    165189    @property 
    166190    def number(self): 
     191        """ 
     192        Pathway number as a string (e.g. '05130') 
     193        """ 
    167194        return self.pathway_attributes().get("number") 
    168195 
    169196    @property 
    170197    def title(self): 
     198        """ 
     199        Pathway title string. 
     200        """ 
    171201        return self.pathway_attributes().get("title") 
    172202 
    173203    @property 
    174204    def image(self): 
     205        """ 
     206        URL of the pathway image. 
     207        """ 
    175208        return self.pathway_attributes().get("image") 
    176209 
    177210    @property 
    178211    def link(self): 
     212        """ 
     213        URL to a pathway on the KEGG web site. 
     214        """ 
    179215        return self.pathway_attributes().get("link") 
    180216 
     
    214250 
    215251    def __iter__(self): 
    216         """ Iterate over all elements in the pathway 
     252        """ 
     253        Iterate over all elements in the pathway. 
    217254        """ 
    218255        return iter(self.all_elements()) 
    219256 
    220257    def __contains__(self, element): 
    221         """ Retrurn true if element in the pathway 
     258        """ 
     259        Return ``True`` if element in the pathway. 
    222260        """ 
    223261        return element in self.all_elements() 
     
    231269    @cached_method 
    232270    def all_elements(self): 
    233         """ Return all elements 
     271        """ 
     272        Return all elements 
    234273        """ 
    235274        return reduce(list.__add__, 
     
    246285    @cached_method 
    247286    def genes(self): 
    248         """ Return all genes on the pathway 
     287        """ 
     288        Return all genes on the pathway. 
    249289        """ 
    250290        return self._get_entries_by_type("gene") 
     
    252292    @cached_method 
    253293    def compounds(self): 
    254         """ Return all compounds on the pathway 
     294        """ 
     295        Return all compounds on the pathway. 
    255296        """ 
    256297        return self._get_entries_by_type("compound") 
     
    258299    @cached_method 
    259300    def enzymes(self): 
    260         """ Return all enzymes on the pathway 
     301        """ 
     302        Return all enzymes on the pathway. 
    261303        """ 
    262304        return self._get_entries_by_type("enzyme") 
     
    264306    @cached_method 
    265307    def orthologs(self): 
    266         """ Return all orthologs on the pathway 
     308        """ 
     309        Return all orthologs on the pathway. 
    267310        """ 
    268311        return self._get_entries_by_type("ortholog") 
     
    270313    @cached_method 
    271314    def maps(self): 
    272         """ Return all linked maps on the pathway 
     315        """ 
     316        Return all linked maps on the pathway. 
    273317        """ 
    274318        return self._get_entries_by_type("map") 
     
    276320    @cached_method 
    277321    def groups(self): 
    278         """ Return all groups on the pathway 
     322        """ 
     323        Return all groups on the pathway. 
    279324        """ 
    280325        return self._get_entries_by_type("ortholog") 
    281326 
    282327    def get_image(self): 
    283         """ Return an image of the pathway 
     328        """ 
     329        Return an local filesystem path to an image of the pathway. The image 
     330        will be downloaded if not already cached. 
    284331        """ 
    285332        return self._get_image_filename() 
     
    287334    @classmethod 
    288335    def list(cls, organism): 
     336        """ 
     337        List all pathways for KEGG organism code `organism`. 
     338        """ 
    289339        kegg = api.CachedKeggApi() 
    290340        return kegg.list_pathways(organism) 
Note: See TracChangeset for help on using the changeset viewer.