pythermodb-settings 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

pythermodb_settings/configs/about.py

@@ -1,5 +1,5 @@
 # NOTE: app info
-__version__ = "0.1.7"
+__version__ = "0.1.9"
 __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/utils/component_utils.py

@@ -57,9 +57,15 @@ def create_component_id(
 def set_component_id(
     component: Component,
     component_key: Literal[
-        'Name-State', 'Formula-State'
+        'Name-State',
+        'Formula-State',
+        'Name',
+        'Formula',
+        'Name-Formula-State',
+        'Formula-Name-State'
     ],
     separator_symbol: str = '-',
+    case: Literal['lower', 'upper', None] = None
 ) -> str:
     '''
     Set component identifier based on the specified key.
@@ -73,9 +79,15 @@ def set_component_id(
         Options are:
             - 'Name-State': Use the name-state identifier.
             - 'Formula-State': Use the formula-state identifier.
+            - 'Name': Use the component name.
+            - 'Formula': Use the component formula.
+            - 'Name-Formula-State': Use the name, formula, and state.
+            - 'Formula-Name-State': Use the formula, name, and state.
     separator_symbol : str, optional
         The symbol to use as a separator between the name/formula and state.
         Default is '-'.
+    case : Literal['lower', 'upper', None], optional
+        Convert the identifier to lower or upper case.
 
     Returns
     -------
@@ -89,16 +101,43 @@ def set_component_id(
             separator_symbol=separator_symbol
         )
 
-        # set component id
+        # init component id
+        component_id: str = ""
+
+        # NOTE: set component id
         if component_key == "Name-State":
-            return component_idx.name_state
+            component_id = component_idx.name_state.strip()
         elif component_key == "Formula-State":
-            return component_idx.formula_state
+            component_id = component_idx.formula_state.strip()
+        elif component_key == "Name":
+            component_id = component.name.strip()
+        elif component_key == "Formula":
+            component_id = component.formula.strip()
+        elif component_key == "Name-Formula-State":
+            component_id = f"{component.name.strip()}{separator_symbol}{component.formula.strip()}{separator_symbol}{component.state.strip().lower()}"
+        elif component_key == "Formula-Name-State":
+            component_id = f"{component.formula.strip()}{separator_symbol}{component.name.strip()}{separator_symbol}{component.state.strip().lower()}"
         else:
             raise ValueError(
                 f"Invalid component_key '{component_key}'. "
                 f"Must be 'Name-State' or 'Formula-State'."
             )
+
+        # NOTE: apply conversion
+        if case == 'lower':
+            component_id = component_id.lower()
+        elif case == 'upper':
+            component_id = component_id.upper()
+        elif case is None:
+            pass
+        else:
+            raise ValueError(
+                f"Invalid case '{case}'. "
+                f"Must be 'lower', 'upper', or None."
+            )
+
+        # result
+        return component_id
     except Exception as e:
         logger.error(
             f"Failed to set component identifier for "
@@ -192,9 +231,15 @@ def create_binary_mixture_id(
 def create_mixture_id(
     components: list[Component],
     mixture_key: Literal[
-        'Name', 'Formula', 'Name-State', 'Formula-State',
+        'Name',
+        'Formula',
+        'Name-State',
+        'Formula-State',
+        'Name-Formula-State',
+        'Formula-Name-State'
     ] = 'Name',
-    delimiter: str = "|"
+    delimiter: str = "|",
+    case: Literal['lower', 'upper', None] = None
 ) -> str:
     """Create a unique mixture ID based on a list of components (sorted alphabetically).
 
@@ -202,10 +247,12 @@ def create_mixture_id(
     ----------
     components : list[Component]
         List of components in the mixture.
-    component_key : Literal['Name', 'Formula'], optional
+    component_key : Literal['Name', 'Formula', 'Name-State', 'Formula-State', 'Name-Formula-State', 'Formula-Name-State'], optional
         The key to use for identifying the components, by default 'Name'.
     delimiter : str, optional
         Delimiter to separate the components in the ID, by default "|".
+    case : Literal['lower', 'upper', None], optional
+        Convert the identifier to lower or upper case, by default 'lower'.
 
     Returns
     -------
@@ -248,25 +295,38 @@ def create_mixture_id(
         component_ids = []
         for comp in components:
             if mixture_key == 'Name':
-                comp_id = comp.name.strip().lower()
+                comp_id = comp.name.strip()
             elif mixture_key == 'Formula':
-                comp_id = comp.formula.strip().lower()
+                comp_id = comp.formula.strip()
             elif mixture_key == 'Name-State':
-                comp_id = f"{comp.name.strip().lower()}-{comp.state.strip().lower()}"
+                comp_id = f"{comp.name.strip()}-{comp.state.strip()}"
             elif mixture_key == 'Formula-State':
-                comp_id = f"{comp.formula.strip().lower()}-{comp.state.strip().lower()}"
+                comp_id = f"{comp.formula.strip()}-{comp.state.strip()}"
+            elif mixture_key == 'Name-Formula-State':
+                comp_id = f"{comp.name.strip()}-{comp.formula.strip()}-{comp.state.strip()}"
+            elif mixture_key == 'Formula-Name-State':
+                comp_id = f"{comp.formula.strip()}-{comp.name.strip()}-{comp.state.strip()}"
             else:
                 raise ValueError(
-                    "component_key must be either 'Name' or 'Formula'"
+                    "component_key must be one of the following: Name, Formula, Name-State, Formula-State, Name-Formula-State, Formula-Name-State"
                 )
             component_ids.append(comp_id)
 
         # SECTION: create unique mixture ID (sorted to ensure uniqueness)
+        # ! sorted alphabetically
         mixture_id = delimiter.join(sorted(component_ids))
 
         # strip
         mixture_id = mixture_id.strip()
 
+        # NOTE: apply conversion
+        if case == 'lower':
+            mixture_id = mixture_id.lower()
+        elif case == 'upper':
+            mixture_id = mixture_id.upper()
+        elif case is None:
+            pass
+
         # return
         return mixture_id
     except Exception as e:

{pythermodb_settings-0.1.7.dist-info → pythermodb_settings-0.1.9.dist-info}/METADATA

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

{pythermodb_settings-0.1.7.dist-info → pythermodb_settings-0.1.9.dist-info}/RECORD

@@ -1,7 +1,7 @@
 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=UQmiOmXUpKxumKocGKuOOw-1scVmKCLf_A8X72geHqI,379
+pythermodb_settings/configs/about.py,sha256=4ztRhYUuPC_hC5TgOIXZ2Rbr05AQrg69VbHRG25jT5s,379
 pythermodb_settings/models/__init__.py,sha256=4qi2Gut42auzeEpK4Gw0UkbALYlQ-kLnes0blSu_UFs,766
 pythermodb_settings/models/components.py,sha256=4CwZcGpbm1PiEBQUpEmo6T6mP4y3S3LIiHCM0y9C7XU,1674
 pythermodb_settings/models/conditions.py,sha256=Zm5JcM2kyMlS6b8hPbs6awa_6ps3xFoCVA4zwNPc5eg,1083
@@ -10,9 +10,9 @@ pythermodb_settings/models/references.py,sha256=A27Y-7L8X-g2m-pxuDk0ateFScPE1MME
 pythermodb_settings/models/rules.py,sha256=1a9CyTHwpQkZQXFJWDMrEcKQAOTOwquepoOQPGznTlc,74
 pythermodb_settings/models/source.py,sha256=0yU21YpYSqnew8rjTrlRuoWAuSAlUvMOebC5X0Sr8X4,1325
 pythermodb_settings/utils/__init__.py,sha256=j3MYKYv7nx5u356J82cacKBzC-CBUJ8GPI4J3c5ss_U,277
-pythermodb_settings/utils/component_utils.py,sha256=MrqqcFCb0ksQu4Q3gm2UtuKpnCMYjJ21nM5baB1KaGs,8675
-pythermodb_settings-0.1.7.dist-info/licenses/LICENSE,sha256=pHRAx3wjVKpt2ec3NyhntY6_bGgJqV2SyE8xNUJ7MYE,1090
-pythermodb_settings-0.1.7.dist-info/METADATA,sha256=DBbhLyQS7QEmZVm7Hyja8zAl_rdtAdfFX5Ils3Dm9lA,4894
-pythermodb_settings-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pythermodb_settings-0.1.7.dist-info/top_level.txt,sha256=6IdVIbW__wHFsKQYx7DDnXArm10qiJVIyaoSEFQylK4,20
-pythermodb_settings-0.1.7.dist-info/RECORD,,
+pythermodb_settings/utils/component_utils.py,sha256=T8xKuYRiqHEWfHNAcEXPI-l6nTCYkX0pU_FehRVOYcA,11268
+pythermodb_settings-0.1.9.dist-info/licenses/LICENSE,sha256=pHRAx3wjVKpt2ec3NyhntY6_bGgJqV2SyE8xNUJ7MYE,1090
+pythermodb_settings-0.1.9.dist-info/METADATA,sha256=AudDdrfkg66Q9FDZ160J4Bc-ETgsIZY6Ea1-M-53hN8,4894
+pythermodb_settings-0.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pythermodb_settings-0.1.9.dist-info/top_level.txt,sha256=6IdVIbW__wHFsKQYx7DDnXArm10qiJVIyaoSEFQylK4,20
+pythermodb_settings-0.1.9.dist-info/RECORD,,