compartment.py

# -*- coding: utf-8 -*-

from __future__ import absolute_import

from copy import deepcopy
from cobra.util.util import format_long_string

from cobra.core.object import Object


class Compartment(Object):
    """Compartment is a class for holding information regarding
        a compartment in a cobra.Model object

        Parameters
        ----------
        id : string
           An identifier for the compartment
        name : string
           A human readable name.
        """
    def __init__(self, id=None, name=""):
        Object.__init__(self, id, name)

    def copy(self):
        return deepcopy(self)

    def _repr_html_(self):
        return """
        <table>
            <tr>
                <td><strong>Compartment identifier</strong></td><td>{id}</td>
            </tr><tr>
                <td><strong>Name</strong></td><td>{name}</td>
            </tr><tr>
                <td><strong>Memory address</strong></td>
                <td>{address}</td>
            </tr>
        </table>""".format(id=self.id, name=format_long_string(self.name),
                           address='0x0%x' % id(self))