/usr/lib/python2.7/dist-packages/macsypy/gene.py is in macsyfinder 1.0.5-1.
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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 | # -*- 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 os
import logging
_log = logging.getLogger('macsyfinder.' + __name__)
from subprocess import Popen
from threading import Lock
from .report import GembaseHMMReport, GeneralHMMReport, OrderedHMMReport
from .macsypy_error import MacsypyError
class GeneBank(object):
"""
Store all Gene objects. Ensure that genes are instanciated only once.
"""
_genes_bank = {}
def __getitem__(self, name):
"""
:param name: the name of the Gene
:type name: string
:return: return the Gene corresponding to the name.
If the Gene already exists, return it, otherwise, build it and return it
:rtype: :class:`macsypy.gene.Gene` object
"""
if name in self._genes_bank:
return self._genes_bank[name]
else:
raise KeyError(name)
def __contains__(self, gene):
"""
Implement the membership test operator
:param gene: the gene to test
:type gene: :class:`macsypy.gene.Gene` object
:return: True if the gene is in, False otherwise
:rtype: boolean
"""
return gene in self._genes_bank.values()
def __iter__(self):
"""
Return an iterator object on the genes contained in the bank
"""
return self._genes_bank.itervalues()
def add_gene(self, gene):
"""
Add a gene in the bank
:param gene: the gene to add
:type gene: :class:`macsypy.gene.Gene` object
:raise: KeyError if a gene with the same name is already registered
"""
if gene in self._genes_bank:
raise KeyError("a gene named {0} is already registered".format(gene.name))
else:
self._genes_bank[gene.name] = gene
gene_bank = GeneBank()
class Gene(object):
"""
Handle Gene of a (secretion) System
"""
def __init__(self, cfg, name,
system,
profiles_registry,
loner=False,
exchangeable=False,
multi_system=False,
inter_gene_max_space=None):
"""
handle gene
:param cfg: the configuration object.
:type cfg: :class:`macsypy.config.Config` object
:param name: the name of the Gene.
:type name: string.
:param system: the system that owns this Gene
:type system: :class:`macsypy.system.System` object.
:param profiles_registry: where all the paths profiles where register.
:type profiles_registry: :class:`macsypy.registries.ProfilesRegistry` object.
:param loner: True if the Gene can be isolated on the genome (with no contiguous genes), False otherwise.
:type loner: boolean.
:param exchangeable: True if this Gene can be replaced with one of its homologs or analogs
without any effects on the system assessment, False otherwise.
:type exchangeable: boolean.
:param multi_system: True if this Gene can belong to different occurrences of this System.
:type multi_system: boolean.
:param inter_gene_max_space: the maximum space between this Gene and another gene of the System.
:type inter_gene_max_space: integer
"""
self.name = name
self.profile = profile_factory.get_profile(self, cfg, profiles_registry)
""":ivar profile: The HMM protein Profile corresponding to this gene :class:`macsypy.gene.Profile` object"""
self.homologs = []
self.analogs = []
self._system = system
self._loner = loner
self._exchangeable = exchangeable
self._multi_system = multi_system
self._inter_gene_max_space = inter_gene_max_space
def __str__(self):
"""
Print the name of the gene and of its homologs/analogs.
"""
s = "name : {0}".format(self.name)
s += "\ninter_gene_max_space: {:d}".format(self.inter_gene_max_space)
if self.loner:
s += "\nloner"
if self.multi_system:
s += "\nmulti_system"
if self.exchangeable:
s += "\nexchangeable"
if self.homologs:
s += "\n homologs: "
for h in self.homologs:
s += h.name + ", "
s = s[:-2]
if self.analogs:
s += "\n analogs: "
for a in self.analogs:
s += a.name + ", "
s = s[:-2]
return s
@property
def system(self):
"""
:return: the System that owns this Gene
:rtype: :class:`macsypy.system.System` object
"""
return self._system
@property
def loner(self):
"""
:return: True if the gene can be isolated on the genome, False otherwise
:rtype: boolean
"""
return self._loner
@property
def exchangeable(self):
"""
:return: True if this gene can be replaced with one of its homologs or analogs whithout any effects on the system, False otherwise.
:rtype: boolean.
"""
return self._exchangeable
@property
def multi_system(self):
"""
:return: True if this Gene can belong to different occurrences of **this System** (and can be used for multiple System assessments), False otherwise.
:rtype: boolean.
"""
return self._multi_system
@property
def inter_gene_max_space(self):
"""
:return: The maximum distance allowed between this gene and another gene for them to be considered co-localized.
If the value is not set at the Gene level, return the value set at the System level.
:rtype: integer.
"""
if self._inter_gene_max_space is not None:
return self._inter_gene_max_space
else:
return self._system.inter_gene_max_space
def add_homolog(self, homolog):
"""
Add a homolog gene to the Gene
:param homolog: homolog to add
:type homolog: :class:`macsypy.gene.Homolog` object
"""
self.homologs.append(homolog)
def get_homologs(self):
"""
:return: the Gene homologs
:type: list of :class:`macsypy.gene.Homolog` object
"""
return self.homologs
def add_analog(self, analog):
"""
Add an analogous gene to the Gene
:param analog: analog to add
:type analog: :class:`macsypy.gene.Analog` object
"""
self.analogs.append(analog)
def get_analogs(self):
"""
:return: the Gene analogs
:type: list of :class:`macsypy.gene.Analog` object
"""
return self.analogs
def __eq__(self, gene):
"""
:return: True if the gene names (gene.name) are the same, False otherwise.
:param gene: the query of the test
:type gene: :class:`macsypy.gene.Gene` object.
:rtype: boolean.
"""
return self.name == gene.name
def is_homolog(self, gene):
"""
:return: True if the two genes are homologs, False otherwise.
:param gene: the query of the test
:type gene: :class:`macsypy.gene.Gene` object.
:rtype: boolean.
"""
if self == gene:
return True
else:
for h in self.homologs:
if gene == h.gene:
return True
return False
def is_analog(self, gene):
"""
:return: True if the two genes are analogs, False otherwise.
:param gene: the query of the test
:type gene: :class:`macsypy.gene.Gene` object.
:rtype: boolean.
"""
if self == gene:
return True
else:
for h in self.analogs:
if gene == h.gene:
return True
return False
def is_mandatory(self, system):
"""
:return: True if the gene is within the *mandatory* genes of the system, False otherwise.
:param system: the query of the test
:type system: :class:`macsypy.system.System` object.
:rtype: boolean.
"""
if self in system.mandatory_genes:
return True
else:
return False
def is_accessory(self, system):
"""
:return: True if the gene is within the *accessory* genes of the system, False otherwise.
:param system: the query of the test
:type system: :class:`macsypy.system.System` object.
:rtype: boolean.
"""
if self in system.accessory_genes:
return True
else:
return False
def is_forbidden(self, system):
"""
:return: True if the gene is within the *forbidden* genes of the system, False otherwise.
:param system: the query of the test
:type system: :class:`macsypy.system.System` object.
:rtype: boolean.
"""
if self in system.forbidden_genes:
return True
else:
return False
def is_authorized(self, system, include_forbidden=True):
"""
:return: True if the genes are found in the System definition file (.xml), False otherwise.
:param system: the query of the test
:type system: :class:`macsypy.system.System` object.
:param include_forbidden: tells if forbidden genes should be considered as "authorized" or not
:type include_forbidden: boolean
:rtype: boolean.
"""
if include_forbidden:
for m in (system.mandatory_genes+system.accessory_genes+system.forbidden_genes):
if self == m:
return True
if (m.exchangeable and m.is_homolog(self)) or (m.exchangeable and m.is_analog(self)):
return True
else:
for m in (system.mandatory_genes+system.accessory_genes):
if self == m:
return True
if (m.exchangeable and m.is_homolog(self)) or (m.exchangeable and m.is_analog(self)):
return True
return False
def get_compatible_systems(self, system_list, include_forbidden=True):
"""
Test every system in system_list for compatibility with the gene using the is_authorized function.
:param system_list: a list of system names to test
:type system_list: list of strings
:param include_forbidden: tells if forbidden genes should be considered as defining a compatible systems or not
:type include_forbidden: boolean
:return: the list of compatible systems
:rtype: list of string, or void list if none compatible
"""
compatibles = []
for s in system_list:
if self.is_authorized(s, include_forbidden):
compatibles.append(s)
return compatibles
class Homolog(object):
"""
Handle homologs, encapsulate a Gene
"""
def __init__(self, gene, gene_ref, aligned=False):
"""
:param gene: the gene
:type gene: :class:`macsypy.gene.Gene` object.
:param gene_ref: the gene to which the current is homolog.
:type gene_ref: :class:`macsypy.gene.Gene` object.
:param aligned: if True, the profile of this gene overlaps totally the sequence of the reference gene profile.
Otherwise, only partial overlapping between the profiles.
:type aligned: boolean
"""
self.gene = gene
""":ivar gene: gene """
self.ref = gene_ref
self.aligned = aligned
def __getattr__(self, name):
return getattr(self.gene, name)
def is_aligned(self):
"""
:return: True if this gene homolog is aligned to its homolog, False otherwise.
:rtype: boolean
"""
return self.aligned
@property
def gene_ref(self):
"""
:return: the gene to which this one is homolog to (reference gene)
:rtype: :class:`macsypy.gene.Gene` object
"""
return self.ref
class Analog(object):
"""
Handle analogs, encapsulate a Gene
"""
def __init__(self, gene, gene_ref):
"""
:param gene: the gene
:type gene: :class:`macsypy.gene.Gene` object.
:param gene_ref: the gene to which the current is analog.
:type gene_ref: :class:`macsypy.gene.Gene` object.
"""
self.gene = gene
""":ivar gene: gene """
self.ref = gene_ref
def __getattr__(self, name):
return getattr(self.gene, name)
@property
def gene_ref(self):
"""
:return: the gene to which this one is analog to (reference gene)
:rtype: :class:`macsypy.gene.Gene` object
"""
return self.ref
class ProfileFactory(object):
"""
Build and store all Profile objects. Profiles must not be instanciated directly.
The profile_factory must be used. The profile_factory ensures there is only one instance
of profile for a given name.
To get a profile, use the method get_profile. If the profile is already cached, this instance is returned.
Otherwise a new profile is built, stored in the profile_factory and then returned.
"""
_profiles = {}
def get_profile(self, gene, cfg, profiles_registry):
"""
:param gene: the gene associated to this profile
:type gene: :class:`macsypy.gene.Gene` or :class:`macsypy.gene.Homolog` or :class:`macsypy.gene.Analog` object
:param profiles_registry: the registry where are stored the path of the profiles
:type profiles_registry: the registry of profiles
:param profiles_registry: :class:`macsypy.registries.ProfilesRegistry` instance.
:return: the profile corresponding to the name.
If the profile already exists, return it. Otherwise build it, store it and return it.
:rtype: :class:`macsypy.gene.Profile` object
"""
if gene.name in self._profiles:
profile = self._profiles[gene.name]
else:
path = profiles_registry.get(gene.name)
if path is None:
raise MacsypyError("{0}: No such profile".format(gene.name))
profile = Profile(gene, cfg, path)
self._profiles[gene.name] = profile
return profile
profile_factory = ProfileFactory()
class Profile(object):
"""
Handle a HMM protein profile
"""
def __init__(self, gene, cfg, path):
"""
:param gene: the gene corresponding to this profile
:type gene_name: :class:`macsypy.secretion.Gene` object
:param cfg: the configuration
:type cfg: :class:`macsypy.config.Config` object
:param path: the path to the hmm profile.
:type path: string
"""
self.gene = gene
self.path = path
self.len = self._len()
self.cfg = cfg
self.hmm_raw_output = None
self._report = None
self._lock = Lock()
def __len__(self):
"""
:return: the length of the HMM protein profile
:rtype: int
"""
return self.len
def _len(self):
"""
Parse the HMM profile file to get and store the length.
This private method is called at the Profile init.
"""
length = None
with open(self.path) as f:
for l in f:
if l.startswith("LENG"):
length = int(l.split()[1])
break
return length
def __str__(self):
"""
Print the name of the corresponding gene and the path to the HMM profile.
"""
return "{0} : {1}".format(self.gene.name, self.path)
def execute(self):
"""
Launch the Hmmer search (hmmsearch executable) with this profile
:return: an object storing information on th results of the HMM search (HMMReport)
:rtype: :class:`macsypy.report.HMMReport` object
"""
with self._lock:
# the results of HMM is cached
# so HMMsearch is executed only once per run
# if this method is called several times,
# the first call induce the execution of HMMsearch and generate a report
# the other calls return directly this report
if self._report is not None:
return self._report
output_path = os.path.join(self.cfg.working_dir, self.cfg.hmmer_dir,
self.gene.name + self.cfg.res_search_suffix)
err_path = os.path.join(self.cfg.working_dir, self.cfg.hmmer_dir,
self.gene.name + os.path.splitext(self.cfg.res_search_suffix)[0] + ".err")
with open(err_path, 'w') as err_file:
options = {"hmmer_exe": self.cfg.hmmer_exe,
"output_file": output_path,
"e_value_res": self.cfg.e_value_res,
"profile": self.path,
"sequence_db": self.cfg.sequence_db,
}
command = "{hmmer_exe} --cpu 0 -o {output_file} -E {e_value_res:f} {profile} {sequence_db} ".format(**options)
_log.info("{0} Hmmer command line : {1}".format(self.gene.name, command))
try:
hmmer = Popen(command,
shell=True,
stdout=None,
stdin=None,
stderr=err_file,
close_fds=False,
)
except Exception as err:
msg = "Hmmer execution failed: command = {0} : {1}".format(command, err)
_log.critical(msg, exc_info=True)
raise err
hmmer.wait()
if hmmer.returncode != 0:
if hmmer.returncode == -15:
msg = "the Hmmer execution was aborted: command = {0} : return code = {1:d} check {2}".format(command, hmmer.returncode, err_path)
_log.critical(msg)
return
else:
msg = "an error occurred during Hmmer execution: command = {0} : return code = {1:d} check {2}".format(command, hmmer.returncode, err_path)
_log.debug(msg, exc_info=True)
_log.critical(msg)
raise RuntimeError(msg)
self.hmm_raw_output = output_path
if self.cfg.db_type == 'gembase':
report = GembaseHMMReport(self.gene, output_path, self.cfg)
elif self.cfg.db_type == 'ordered_replicon':
report = OrderedHMMReport(self.gene, output_path, self.cfg)
else:
report = GeneralHMMReport(self.gene, output_path, self.cfg)
self._report = report
return report
|