Source code for cobra_component_models.orm.compound_name

# Copyright (c) 2019, Moritz E. Beber.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


"""Provide a compound name ORM model."""


from sqlalchemy import Column, ForeignKey, Integer, UniqueConstraint

from .base import Base
from .mixin import NameMixin


class CompoundName(NameMixin, Base):
    """
    Define a compound name ORM model.

    Attributes
    ----------
    compound_id : int
        The compound being named.

    """

    __tablename__ = "compound_names"

    compound_id: int = Column(Integer, ForeignKey("compounds.id"), nullable=False)

    __table_args__ = (UniqueConstraint("compound_id", "namespace_id", "name"),)

    def __repr__(self):
        """Return a string representation of the object."""
        return (
            f"{type(self).__name__}(compound={self.compound_id}, "
            f"name={self.name}, "
            f"namespace={self.namespace_id})"
        )