Source code for cobra_component_models.io.compound_model

# 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 pydantic compound data model."""


from typing import Optional

from pydantic import Field

from .abstract_base_model import AbstractBaseModel


class CompoundModel(AbstractBaseModel):
    """Define a pydantic compound data model."""

    id: str
    charge: Optional[float] = Field(None)
    chemical_formula: Optional[str] = Field(None, alias="chemicalFormula")