Source code for silvio.extensions.modules.metabolic_flux
"""
GenomeLibrary is a more complex version of GenomeList:
- support for genome sequences
- genes are located inside the sequence
"""
from __future__ import annotations
from typing import Optional, List, NamedTuple
from math import copysign
from copy import copy
from numpy.random import Generator
from cobra.core import Model as CobraModel
from cobra.core.solution import Solution as CobraSolution
from cobra.manipulation import delete_model_genes
from ...host import Host
from ...module import Module, ModuleException
from ...events import EventEmitter, EventLogger
from ..records.gene.stub_gene import StubGene
from ..all_events import InsertGeneEvent, RemoveGeneEvent, AlterGeneExpressionEvent
[docs]class MetabolicFlux (Module) :
"""
MetabolicFlux can handle cobrapy models and interfaces them with module events.
This module can start with an non-existing model, which can then be integrated as an event.
TODO: Its probably not elegant to allow non-existing models, but this makes it easier to add
all genes in that model later on (as events). If we would be really pedantic and needed a
strictly-existinging model we could implement an initialization step where a module calls
multiple events on the host in order to "initialize" the module properly. To achieve that,
modules themselves need to be able to generate events (right now only a Host can send events
down to modules, events never go up the chain) and prevent infinite event loops. But maybe
there are better alternatives altogether.
"""
model: CobraModel
# Since cobra models have limited methods to manage knocked-out genes, we need to keep track
# of them in this list. A set of gene names.
koed_genes: Set[str]
[docs] def copy ( self, ref:'MetabolicFlux' ) -> None :
self.model = ref.model.copy()
self.koed_genes = ref.koed_genes.copy()
[docs] def bind ( self, host:Host ) -> None :
host.observe( InsertGeneEvent, self.listen_insert_gene )
host.observe( RemoveGeneEvent, self.listen_remove_gene )
host.observe( AlterGeneExpressionEvent, self.listen_alter_gene_expression )
[docs] def sync ( self, emit:EventEmitter, log:EventLogger ) -> None :
log("MetabolicFlux: share model genes")
for gene in self.model.genes : # Add all genes from the metabolic model.
stub = StubGene( name=gene.name )
emit( InsertGeneEvent(stub,locus=None) )
[docs] def listen_insert_gene ( self, event:InsertGeneEvent, emit:EventEmitter, log:EventLogger ) -> None :
if event.gene.name in self.koed_genes :
self.koed_genes.remove( event.gene.name )
delete_model_genes( self.model, list(self.koed_genes), cumulative_deletions=False )
log( "MetabolicFlux: reinserted gene={}".format(event.gene.name) )
[docs] def listen_remove_gene ( self, event:RemoveGeneEvent, emit:EventEmitter, log:EventLogger ) -> None :
"""
When a gene is removed we perform a knockout in the model.
"""
found_genes = [ gene for gene in self.model.genes if gene.name == event.gene.name ]
if len(found_genes) > 0 :
self.koed_genes.add( event.gene.name )
delete_model_genes( self.model, list(self.koed_genes), cumulative_deletions=False )
log( "MetabolicFlux: knocked out gene={}".format(event.gene.name) )
[docs] def listen_alter_gene_expression ( self, event:AlterGeneExpressionEvent, emit:EventEmitter, log:EventLogger ) -> None :
"""
When a gene expression changes, we adapt the bounds.
TODO: This method should be wrong. Please rewrite logic on how gene expression affects the
metabolic model.
"""
found_genes = [ gene for gene in self.model.genes if gene.name == event.gene.name ]
if len(found_genes) > 0 :
for gene in found_genes :
for rct in gene.reactions :
rct.upper_bound = event.new_expression * copysign(1,rct.upper_bound)
log( "MetabolicFlux: changed upper_bound on reaction={} to {}".format(rct.id,rct.upper_bound) )