[PNE-6610] Expose more candidate attributes.

Expose the pinned metadata, hidden attribubte, and name of each candidate
as read-only properties.

Author: anoto-moniz

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = "3.15.1"
+__version__ = "3.16.0"

src/citrine/informatics/design_candidate.py

@@ -177,6 +177,14 @@ class DesignCandidate(Serializable["DesignCandidate"]):
     and constraints (higher is better)"""
     material = properties.Object(DesignMaterial, 'material')
     """:DesignMaterial: the material returned by the design workflow"""
+    name = properties.String('name')
+    """:str: the name of the candidate"""
+    hidden = properties.Boolean('hidden')
+    """:str: whether the candidate is marked hidden"""
+    pinned_by = properties.Optional(properties.UUID, 'pinned.user')
+    """:Optional[UUID]: id of the user who pinned the candidate, if it's been pinned"""
+    pinned_time = properties.Optional(properties.Datetime, 'pinned.time')
+    """:Optional[datetime]: date and time at which the candidate was pinned, if it's been pinned"""
 
 
 class HierarchicalDesignCandidate(Serializable["HierarchicalDesignCandidate"]):

tests/conftest.py

@@ -849,7 +849,9 @@ def example_candidates(example_design_material):
             "material_id": str(uuid.uuid4()),
             "identifiers": [],
             "primary_score": 0,
-            "material": example_design_material
+            "material": example_design_material,
+            "name": "Example candidate",
+            "hidden": True
         }]
     }
 

tests/resources/test_design_executions.py

@@ -1,5 +1,7 @@
 import pytest
 import uuid
+from copy import deepcopy
+from datetime import datetime
 
 from citrine.informatics.executions.design_execution import DesignExecution
 from citrine.resources.design_execution import DesignExecutionCollection
@@ -99,6 +101,31 @@ def test_workflow_execution_results(workflow_execution: DesignExecution, session
     assert session.last_call == FakeCall(method='GET', path=expected_path, params={"per_page": 4, 'page': 1})
 
 
+def test_workflow_execution_results_pinned(workflow_execution: DesignExecution, session, example_candidates):
+    # Given
+    pinned_by = uuid.uuid4()
+    pinned_time = datetime.now()
+    example_candidates_pinned = deepcopy(example_candidates)
+    example_candidates_pinned["response"][0]["pinned"] = {
+        "user": pinned_by,
+        "time": pinned_time
+    }
+    session.set_response(example_candidates_pinned)
+
+    # When
+    candidates = list(workflow_execution.candidates(per_page=4))
+
+    # Then
+    expected_path = '/projects/{}/design-workflows/{}/executions/{}/candidates'.format(
+        workflow_execution.project_id,
+        workflow_execution.workflow_id,
+        workflow_execution.uid,
+    )
+    assert session.last_call == FakeCall(method='GET', path=expected_path, params={"per_page": 4, 'page': 1})
+    assert candidates[0].pinned_by == pinned_by
+    assert candidates[0].pinned_time == pinned_time
+
+
 def test_list(collection: DesignExecutionCollection, session):
     session.set_response({"per_page": 4, "next": "", "response": []})
     lst = list(collection.list(per_page=4))