Merge pull request #887 from CitrineInformatics/PLA-13279/template-names

Author: sfriedowitz

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = '2.35.1'
+__version__ = '2.36.0'

src/citrine/informatics/design_spaces/hierarchical_design_space.py

@@ -1,6 +1,9 @@
+import warnings
 from typing import Optional, List
 from uuid import UUID
 
+from deprecation import deprecated
+
 from citrine._rest.engine_resource import ModuleEngineResource
 from citrine._serialization import properties
 from citrine._serialization.serializable import Serializable
@@ -25,26 +28,46 @@ class TemplateLink(Serializable["TemplateLink"]):
         Citrine ID referencing an on-platform material template.
     process_template: UUID
         Citrine ID referencing an on-platform process template.
-    template_name: Optional[str]
-        Optional name describing the combination of templates for display purposes.
-        The Citrine Platform by default uses the name of the material template.
+    material_template_name: Optional[str]
+        Optional name of the material template.
+    process_template_name: Optional[str]
+        Optional name of the process template.
 
     """
 
     material_template = properties.UUID("material_template")
     process_template = properties.UUID("process_template")
-    template_name = properties.Optional(properties.String, "name")
+    material_template_name = properties.Optional(properties.String, "material_template_name")
+    process_template_name = properties.Optional(properties.String, "process_template_name")
 
     def __init__(
             self,
             *,
             material_template: UUID,
             process_template: UUID,
+            material_template_name: Optional[str] = None,
+            process_template_name: Optional[str] = None,
             template_name: Optional[str] = None
     ):
         self.material_template: UUID = material_template
         self.process_template: UUID = process_template
-        self.template_name: Optional[str] = template_name
+        self.material_template_name: Optional[str] = material_template_name
+        self.process_template_name: Optional[str] = process_template_name
+
+        if template_name is not None:
+            warnings.warn(
+                "The field 'template_name' has been deprecated in v2.36.0 and will be removed "
+                "in v3.0.0. Please use the field 'material_template_name' instead.",
+                DeprecationWarning
+            )
+
+    @property
+    @deprecated(
+        deprecated_in="2.36.0", removed_in="3.0.0", details="Use material_template_name instead."
+    )
+    def template_name(self) -> str:
+        """Return the name of the material template."""
+        return self.material_template_name
 
 
 class MaterialNodeDefinition(Serializable["MaterialNodeDefinition"]):

tests/informatics/test_design_spaces.py

@@ -75,7 +75,8 @@ def material_node_definition(formulation_design_space) -> MaterialNodeDefinition
     link = TemplateLink(
         material_template=uuid.uuid4(),
         process_template=uuid.uuid4(),
-        template_name="Template Name"
+        material_template_name="Material Template Name",
+        process_template_name="Process Template Name"
     )
 
     return MaterialNodeDefinition(
@@ -120,6 +121,17 @@ def test_hierarchical_initialization(hierarchical_design_space):
     assert "formulation_descriptor" in fds_data
 
 
+def test_template_link_deprecations():
+    with pytest.warns(DeprecationWarning):
+        link = TemplateLink(
+            material_template=uuid.uuid4(),
+            process_template=uuid.uuid4(),
+            template_name="I am deprecated",
+            material_template_name="I am not deprecated"
+        )
+        assert link.template_name == link.material_template_name
+
+
 def test_data_source_build(valid_data_source_design_space_dict):
     ds = DesignSpace.build(valid_data_source_design_space_dict)
     assert ds.name == valid_data_source_design_space_dict["data"]["instance"]["name"]