/usr/lib/python2.7/dist-packages/macsypy/system.py is in macsyfinder 1.0.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 | # -*- coding: utf-8 -*-
################################################################################
# MacSyFinder - Detection of macromolecular systems in protein datasets #
# using systems modelling and similarity search. #
# Authors: Sophie Abby, Bertrand Néron #
# Copyright © 2014 Institut Pasteur (Paris) and CNRS. #
# See the COPYRIGHT file for details #
# #
# MacsyFinder is distributed under the terms of the GNU General Public License #
# (GPLv3). See the COPYING file for details. #
################################################################################
import logging
_log = logging.getLogger('macsyfinder.' + __name__)
from macsypy_error import SystemInconsistencyError
class SystemBank(object):
"""
Build and store all Systems objects. Systems must not be instanciated directly.
This system factory must be used. It ensures there is a unique instance
of a system for a given system name.
To get a system, use the method __getitem__ via the "[]". If the System is already cached in the SystemBank, it is returned.
Otherwise a new system is built, stored and then returned.
"""
_system_bank = {}
def __getitem__(self, name):
"""
:param name: the name of the system
:type name: string
:return: the system corresponding to the name.
If the system already exists, return it, otherwise build it and return it.
:rtype: :class:`macsypy.system.System` object
"""
if name in self._system_bank:
return self._system_bank[name]
else:
raise KeyError(name)
def __contains__(self, system):
"""
Implement the membership test operator
:param system: the system to test
:type system: :class:`macsypy.system.System` object
:return: True if the system is in the System factory, False otherwise
:rtype: boolean
"""
return system in self._system_bank.values()
def __iter__(self):
"""
Return an iterator object on the systems contained in the bank
"""
return self._system_bank.itervalues()
def __len__(self):
"""
:return: the number of systems stored in the bank
:rtype: integer
"""
return len(self._system_bank)
def add_system(self, system):
"""
:param system: the system to add
:type system: :class:`macsypy.system.System` object
:raise: KeyError if a system with the same name is already registered.
"""
if system in self._system_bank:
raise KeyError, "a system named %s is already registered in the systems' bank" % system.name
else:
self._system_bank[system.name] = system
system_bank = SystemBank()
class System(object):
"""
Handle a secretion system.
"""
def __init__(self, cfg, name, inter_gene_max_space, min_mandatory_genes_required = None, min_genes_required = None, max_nb_genes = None, multi_loci = False):
"""
:param cfg: the configuration object
:type cfg: :class:`macsypy.config.Config` object
:param name: the name of the system
:type name: string
:param inter_gene_max_space: the maximum distance between two genes (**co-localization** parameter)
:type inter_gene_max_space: integer
:param min_mandatory_genes_required: the quorum of mandatory genes to define this system
:type min_mandatory_genes_required: integer
:param min_genes_required: the quorum of genes to define this system
:type min_genes_required: integer
:param max_nb_genes:
:type max_nb_genes: integer
:param multi_loci:
:type multi_loci: boolean
"""
self.cfg = cfg
self.name = name
self._inter_gene_max_space = inter_gene_max_space
self._min_mandatory_genes_required = min_mandatory_genes_required
self._min_genes_required = min_genes_required
if self._min_mandatory_genes_required is not None and self._min_genes_required is not None:
if self._min_genes_required < self._min_mandatory_genes_required:
raise SystemInconsistencyError("min_genes_required must be greater or equal than min_mandatory_genes_required")
self._max_nb_genes = max_nb_genes
self._multi_loci = multi_loci
self._mandatory_genes = []
self._accessory_genes = []
self._forbidden_genes = []
@property
def inter_gene_max_space(self):
"""
:return: set the maximum distance allowed between 2 genes for this system
:rtype: integer
"""
cfg_inter_gene_max_space = self.cfg.inter_gene_max_space(self.name)
if cfg_inter_gene_max_space is not None:
return cfg_inter_gene_max_space
return self._inter_gene_max_space
@property
def min_mandatory_genes_required(self):
"""
:return: get the quorum of mandatory genes required for this system
:rtype: integer
"""
cfg_min_mandatory_genes_required = self.cfg.min_mandatory_genes_required(self.name)
if cfg_min_mandatory_genes_required is not None:
return cfg_min_mandatory_genes_required
elif self._min_mandatory_genes_required is None:
return len(self._mandatory_genes)
else:
return self._min_mandatory_genes_required
@property
def min_genes_required(self):
"""
:return: get the minimum number of genes to assess for the system presence.
:rtype: integer
"""
cfg_min_genes_requireds = self.cfg.min_genes_required(self.name)
if cfg_min_genes_requireds is not None:
return cfg_min_genes_requireds
elif self._min_genes_required is None:
return len(self._mandatory_genes)
else:
return self._min_genes_required
@property
def max_nb_genes(self):
"""
:return: the maximum number of genes to assess the system presence.
:rtype: int (or None)
"""
cfg_max_nb_genes = self.cfg.max_nb_genes(self.name)
if cfg_max_nb_genes:
return cfg_max_nb_genes
else:
return self._max_nb_genes
@property
def multi_loci(self):
"""
:return: True if the system is authorized to be inferred from multiple loci, False otherwise
:rtype: boolean
"""
cfg_multi_loci = self.cfg.multi_loci(self.name)
if cfg_multi_loci:
return cfg_multi_loci
else:
return self._multi_loci
def add_mandatory_gene(self, gene):
"""
Add a gene to the list of mandatory genes
:param gene: gene that is mandatory for this system
:type gene: :class:`macsypy.gene.Gene` object
"""
self._mandatory_genes.append(gene)
def add_accessory_gene(self, gene):
"""
Add a gene to the list of accessory genes
:param gene: gene that is allowed to be present in this system
:type gene: :class:`macsypy.gene.Gene` object
"""
self._accessory_genes.append(gene)
def add_forbidden_gene(self, gene):
"""
Add a gene to the list of forbidden genes
:param gene: gene that must not be found in this system
:type gene: :class:`macsypy.genen.Gene` object
"""
self._forbidden_genes.append(gene)
@property
def mandatory_genes(self):
"""
:return: the list of genes that are mandatory in this secretion system
:rtype: list of :class:`macsypy.gene.Gene` objects
"""
return self._mandatory_genes
@property
def accessory_genes(self):
"""
:return: the list of genes that are allowed in this secretion system
:rtype: list of :class:`macsypy.gene.Gene` objects
"""
return self._accessory_genes
@property
def forbidden_genes(self):
"""
:return: the list of genes that are forbidden in this secretion system
:rtype: list of :class:`macsypy.gene.Gene` objects
"""
return self._forbidden_genes
def get_gene(self, gene_name):
"""
:param gene_name: the name of the gene to get
:type gene_name: string
:return: the gene corresponding to gene_name.
:rtype: a :class:`macsypy.gene.Gene` object.
:raise: KeyError the system does not contain any gene with name gene_name.
"""
all_genes = (self.mandatory_genes, self.accessory_genes, self.forbidden_genes)
for g_list in all_genes:
for g in g_list:
if g.name == gene_name:
return g
else:
homolgs = g.get_homologs()
analogs = g.get_analogs()
for ex in homolgs + analogs:
if ex.name == gene_name:
return ex
raise KeyError("System {0} does not contain gene {1}".format(self.name, gene_name))
def get_gene_ref(self, gene):
"""
:param gene: the gene to get the gene reference.
:type gene: a :class:`macsypy.gene.Gene` or macsypy.gene.Homolog` or macsypy.gene.Analog` object.
:return: the gene reference of the gene if exists (if the gene is an Homolog or an Analog), otherwise return None.
:rtype: :class:`macsypy.gene.Gene` object or None
:raise: KeyError if gene is not in the system
"""
g = self.get_gene(gene.name)
try:
return g.gene_ref
except AttributeError:
return None
|