pythermodb-settings 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

pythermodb_settings/configs/about.py

@@ -1,5 +1,5 @@
 # NOTE: app info
-__version__ = "0.1.1"
+__version__ = "0.1.2"
 __description__ = """PyThermoDB Settings is a Python package that acts as an interface between pythermdb and other applications, providing robust, Pydantic-based data models and configuration structures for managing thermodynamic database (ThermoDB) settings."""
 __author__ = "Sina Gilassi"
 __author_email__ = "sina.gilassi@gmail.com"

pythermodb_settings/models/__init__.py

@@ -1,5 +1,5 @@
 # export
-from .components import Component
+from .components import Component, ComponentIdentity
 from .conditions import Temperature, Pressure
 from .configs import ComponentConfig
 from .references import (
@@ -13,6 +13,7 @@ from .source import ComponentThermoDBSource
 
 __all__ = [
     "Component",
+    "ComponentIdentity",
     "Temperature",
     "Pressure",
     "ComponentConfig",

pythermodb_settings/models/components.py

@@ -39,3 +39,24 @@ class Component(BaseModel):
         arbitrary_types_allowed=True,
         extra="allow"
     )
+
+
+class ComponentIdentity(BaseModel):
+    """
+    Model for component identity.
+
+    Attributes
+    ----------
+    name_state : str
+        Component name-state identifier.
+    formula_state : str
+        Component formula-state identifier.
+    """
+    name_state: str = Field(
+        ...,
+        description="Component name-state identifier"
+    )
+    formula_state: str = Field(
+        ...,
+        description="Component formula-state identifier"
+    )

pythermodb_settings/utils/__init__.py

@@ -0,0 +1,7 @@
+# export
+from .component_utils import create_component_id, set_component_id
+
+__all__ = [
+    "create_component_id",
+    "set_component_id"
+]

pythermodb_settings/utils/component_utils.py

@@ -0,0 +1,107 @@
+# import libs
+import logging
+from typing import Literal
+from pythermodb_settings.models import Component
+# local
+from ..models import ComponentIdentity
+
+# NOTE: logger
+logger = logging.getLogger(__name__)
+
+
+def create_component_id(
+    component: Component,
+    separator_symbol: str = '-'
+) -> ComponentIdentity:
+    '''
+    Create component name-state and formula-state identifiers.
+
+    Parameters
+    ----------
+    component : Component
+        The component for which to create the identifiers.
+    separator_symbol : str, optional
+        The symbol to use as a separator between the name/formula and
+
+    Returns
+    -------
+    ComponentIdentity
+        The component identity containing name-state and formula-state
+        identifiers.
+    '''
+    try:
+        # NOTE: extract component name
+        component_name = component.name.strip()
+        component_formula = component.formula.strip()
+        component_state = component.state.strip().lower()
+
+        # >> separator
+        separator_symbol = separator_symbol.strip()
+
+        # SECTION: create component identifiers
+        name_state = f"{component_name}{separator_symbol}{component_state}"
+        formula_state = f"{component_formula}{separator_symbol}{component_state}"
+
+        return ComponentIdentity(
+            name_state=name_state,
+            formula_state=formula_state
+        )
+    except Exception as e:
+        logger.error(
+            f"Failed to create component identifiers for "
+            f"'{component}': {e}"
+        )
+        raise e
+
+
+def set_component_id(
+    component: Component,
+    component_key: Literal[
+        'Name-State', 'Formula-State'
+    ],
+    separator_symbol: str = '-',
+) -> str:
+    '''
+    Set component identifier based on the specified key.
+
+    Parameters
+    ----------
+    component : Component
+        The component for which to set the identifier.
+    component_key : str
+        The key to determine which identifier to use.
+        Options are:
+            - 'Name-State': Use the name-state identifier.
+            - 'Formula-State': Use the formula-state identifier.
+    separator_symbol : str, optional
+        The symbol to use as a separator between the name/formula and state.
+        Default is '-'.
+
+    Returns
+    -------
+    str
+        The component identifier based on the specified key.
+    '''
+    try:
+        # NOTE: create component id
+        component_idx: ComponentIdentity = create_component_id(
+            component=component,
+            separator_symbol=separator_symbol
+        )
+
+        # set component id
+        if component_key == "Name-State":
+            return component_idx.name_state
+        elif component_key == "Formula-State":
+            return component_idx.formula_state
+        else:
+            raise ValueError(
+                f"Invalid component_key '{component_key}'. "
+                f"Must be 'Name-State' or 'Formula-State'."
+            )
+    except Exception as e:
+        logger.error(
+            f"Failed to set component identifier for "
+            f"'{component}': {e}"
+        )
+        raise e

{pythermodb_settings-0.1.1.dist-info → pythermodb_settings-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythermodb-settings
-Version: 0.1.1
+Version: 0.1.2
 Summary: Add your description here
 Author-email: Sina Gilassi <sina.gilassi@gmail.com>
 License-Expression: MIT

{pythermodb_settings-0.1.1.dist-info → pythermodb_settings-0.1.2.dist-info}/RECORD

@@ -1,16 +1,18 @@
 pythermodb_settings/__init__.py,sha256=VzJSYgJJNw_j5NmnIbq0pJhBd_9Kp-bbfOsRLepplSw,229
 pythermodb_settings/app.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pythermodb_settings/configs/__init__.py,sha256=QR38PBCzgoFwYqcViR9bFT2YIR5m9s7q8C7cV4fZjz4,211
-pythermodb_settings/configs/about.py,sha256=u2mzTrfBlAFtmioyFqeqD-ZylIlDApw_ShREQfxbgnU,379
-pythermodb_settings/models/__init__.py,sha256=wnGQvIfLS80epMf_MtTVlnz-RojxHci7qpkxm4phRpY,604
-pythermodb_settings/models/components.py,sha256=baeEklB9ULoIx_iSkPSWty85TK912ZDX4RAa64qje0k,1194
+pythermodb_settings/configs/about.py,sha256=vOAWpWG2BtmC2n4vqLEpLmZeytlYxk4WMGk0CQhMbXA,379
+pythermodb_settings/models/__init__.py,sha256=N0zptTFnWTNEcQQ00WFXXF5i3Xxq_zjbpSdIyhGRu7g,649
+pythermodb_settings/models/components.py,sha256=4CwZcGpbm1PiEBQUpEmo6T6mP4y3S3LIiHCM0y9C7XU,1674
 pythermodb_settings/models/conditions.py,sha256=Zm5JcM2kyMlS6b8hPbs6awa_6ps3xFoCVA4zwNPc5eg,1083
 pythermodb_settings/models/configs.py,sha256=57nXShSbtiVo9fP2OFIbzRqS87oT4ITRLYJi_bp5cFI,674
 pythermodb_settings/models/references.py,sha256=_MicXRkUdmZLMiuQEhMm2kJzmApHvz_CnjLaxxnueLg,5399
 pythermodb_settings/models/rules.py,sha256=1a9CyTHwpQkZQXFJWDMrEcKQAOTOwquepoOQPGznTlc,74
 pythermodb_settings/models/source.py,sha256=liN4v1o8mqxclz8khca4anTOzLHO-5gCnK0MsfVgxGY,533
-pythermodb_settings-0.1.1.dist-info/licenses/LICENSE,sha256=pHRAx3wjVKpt2ec3NyhntY6_bGgJqV2SyE8xNUJ7MYE,1090
-pythermodb_settings-0.1.1.dist-info/METADATA,sha256=7wCHXxfKXcyGQFhKQZ52_WK0M6cWnDAQdGXz0lCHigE,4894
-pythermodb_settings-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pythermodb_settings-0.1.1.dist-info/top_level.txt,sha256=6IdVIbW__wHFsKQYx7DDnXArm10qiJVIyaoSEFQylK4,20
-pythermodb_settings-0.1.1.dist-info/RECORD,,
+pythermodb_settings/utils/__init__.py,sha256=Vc3UjM42beWALBoqNV6Vx71ofC2CjYNxUUvFgR44lvk,148
+pythermodb_settings/utils/component_utils.py,sha256=uL-_WWl8Wat1LEFMpodmQe1BklzY7yI8enguWYeSWwo,3196
+pythermodb_settings-0.1.2.dist-info/licenses/LICENSE,sha256=pHRAx3wjVKpt2ec3NyhntY6_bGgJqV2SyE8xNUJ7MYE,1090
+pythermodb_settings-0.1.2.dist-info/METADATA,sha256=SDi6-9y2tSUaG6d2azVYan79R_767aGA009AU-nMwt0,4894
+pythermodb_settings-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pythermodb_settings-0.1.2.dist-info/top_level.txt,sha256=6IdVIbW__wHFsKQYx7DDnXArm10qiJVIyaoSEFQylK4,20
+pythermodb_settings-0.1.2.dist-info/RECORD,,