Merge remote-tracking branch 'origin/master' into users/rbell/query-steps-perf

Richard Bell · Richard Bell · commit 9f149321d4f5 · 2025-04-10T15:59:45.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,34 @@
 
 <!--next-version-placeholder-->
 
+## v2.8.0 (2025-03-26)
+
+### Feature
+
+* Update TestMonitorClient, ProductClient, and SpecsClient with retry handling ([#124](https://github.com/ni/nisystemlink-clients-python/issues/124)) ([`4714ec1`](https://github.com/ni/nisystemlink-clients-python/commit/4714ec139fbc224263c392286383895100c86583))
+
+### Fix
+
+* Make condition type optional while querying specs ([#123](https://github.com/ni/nisystemlink-clients-python/issues/123)) ([`9d0d923`](https://github.com/ni/nisystemlink-clients-python/commit/9d0d9239bc769801590ba8a507c0e3cd5f87e12d))
+
+## v2.7.4 (2025-03-25)
+
+### Fix
+
+* Handle none values and column grouping in results/steps dataframe utility ([#119](https://github.com/ni/nisystemlink-clients-python/issues/119)) ([`9eb2087`](https://github.com/ni/nisystemlink-clients-python/commit/9eb20876ffc4bfc02ce5b4712b65a56085b70029))
+
+## v2.7.3 (2025-03-24)
+
+### Fix
+
+* Make testmonitor step examples show up in docs and fix `update_results` example ([#120](https://github.com/ni/nisystemlink-clients-python/issues/120)) ([`dacfdfb`](https://github.com/ni/nisystemlink-clients-python/commit/dacfdfb6864473fd935986edc8d2562df1e28f9a))
+
+## v2.7.2 (2025-03-21)
+
+### Fix
+
+* Error in converting results/steps to dataframe when status is none ([#115](https://github.com/ni/nisystemlink-clients-python/issues/115)) ([`e67d935`](https://github.com/ni/nisystemlink-clients-python/commit/e67d935586f7d2e58c49b865bd8cc3c0d74ead08))
+
 ## v2.7.1 (2025-03-19)
 
 ### Fix
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -286,7 +286,7 @@ Create, update, query, and delete steps
 
 .. literalinclude:: ../examples/testmonitor/steps.py
    :language: python
-   :linenos
+   :linenos:
 
 Notebook API
 -------
diff --git a/examples/general/disable_cert_verify.py b/examples/general/disable_cert_verify.py
@@ -0,0 +1,11 @@
+"""Example to demonstrate disabling TLS/SSL certificate verification for connections"""
+
+from nisystemlink.clients.core import HttpConfigurationManager
+from nisystemlink.clients.file import FileClient
+
+# explicitly get the http config and set the verify option
+http_config = HttpConfigurationManager.get_configuration()
+http_config.verify = False
+
+client = FileClient(configuration=http_config)
+print(client.api_info())
diff --git a/examples/testmonitor/results.py b/examples/testmonitor/results.py
@@ -6,6 +6,7 @@
     ResultField,
     Status,
     StatusType,
+    UpdateResultRequest,
 )
 
 program_name = "Example Name"
@@ -70,9 +71,12 @@ def create_some_results():
 
 # Update the first result that you just created and replace the keywords
 updated_result = create_response.results[0]
-updated_result.keywords = ["new keyword"]
-updated_result.properties = {"new property key": "new value"}
-update_response = client.update_results([create_response.results[0]], replace=True)
+updated_result = UpdateResultRequest(
+    id=create_response.results[0].id,
+    keywords=["new keyword"],
+    properties={"new property key": "new value"},
+)
+update_response = client.update_results([updated_result], replace=True)
 
 # Query for just the ids of results that match the family
 values_query = QueryResultValuesRequest(
diff --git a/nisystemlink/clients/core/_http_configuration.py b/nisystemlink/clients/core/_http_configuration.py
@@ -23,6 +23,7 @@ def __init__(
         password: Optional[str] = None,
         cert_path: Optional[pathlib.Path] = None,
         workspace: Optional[str] = None,
+        verify: bool = True,
     ) -> None:
         """Initialize a configuration.
 
@@ -40,6 +41,7 @@ def __init__(
             password: The user's password to use when authorization is required.
             cert_path: Local path to an SSL certificate file.
             workspace: ID of workspace to use for client operations.
+            verify: Verify the security certificate for connection
 
         Raises:
             ValueError: if ``server_uri`` is missing scheme or host information.
@@ -73,6 +75,17 @@ def __init__(
 
         self._workspace = workspace
 
+        self._verify = verify
+
+    @property
+    def verify(self) -> bool:
+        """Verify the security certificate for connection."""
+        return self._verify
+
+    @verify.setter
+    def verify(self, value: bool) -> None:
+        self._verify = value
+
     @property
     def timeout_milliseconds(self) -> int:  # noqa: D401
         """The number of milliseconds before a request times out with an error.
diff --git a/nisystemlink/clients/core/_uplink/_base_client.py b/nisystemlink/clients/core/_uplink/_base_client.py
@@ -3,6 +3,7 @@
 from json import loads
 from typing import Any, Callable, Dict, List, get_origin, Optional, Type, Union
 
+import requests
 from nisystemlink.clients import core
 from pydantic import TypeAdapter
 from requests import JSONDecodeError, Response
@@ -93,10 +94,14 @@ def __init__(self, configuration: core.HttpConfiguration, base_path: str = ""):
             configuration: Defines the web server to connect to and information about how to connect.
             base_path: The base path for all API calls.
         """
+        session = requests.Session()
+        session.verify = configuration.verify
+
         super().__init__(
             base_url=configuration.server_uri + base_path,
             converter=_JsonModelConverter(),
             hooks=[_handle_http_status],
+            client=session,
         )
         if configuration.api_keys:
             self.session.headers.update(configuration.api_keys)
diff --git a/nisystemlink/clients/product/_product_client.py b/nisystemlink/clients/product/_product_client.py
@@ -11,7 +11,9 @@
 
 
 @retry(
-    when=retry.when.status([408, 429, 502, 503, 504]), stop=retry.stop.after_attempt(5)
+    when=retry.when.status([408, 429, 502, 503, 504]),
+    stop=retry.stop.after_attempt(5),
+    on_exception=retry.CONNECTION_ERROR,
 )
 class ProductClient(BaseClient):
     def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
diff --git a/nisystemlink/clients/spec/_spec_client.py b/nisystemlink/clients/spec/_spec_client.py
@@ -11,7 +11,9 @@
 
 
 @retry(
-    when=retry.when.status([408, 429, 502, 503, 504]), stop=retry.stop.after_attempt(5)
+    when=retry.when.status([408, 429, 502, 503, 504]),
+    stop=retry.stop.after_attempt(5),
+    on_exception=retry.CONNECTION_ERROR,
 )
 class SpecClient(BaseClient):
     def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
diff --git a/nisystemlink/clients/spec/models/_condition.py b/nisystemlink/clients/spec/models/_condition.py
@@ -30,7 +30,7 @@ class ConditionRange(JsonModel):
 class ConditionValueBase(JsonModel):
     """The base type for conditions that can be represented in several styles."""
 
-    condition_type: ConditionType
+    condition_type: Optional[ConditionType]
     """Type of the Condition."""
 
 
diff --git a/nisystemlink/clients/testmonitor/_test_monitor_client.py b/nisystemlink/clients/testmonitor/_test_monitor_client.py
@@ -15,7 +15,9 @@
 
 
 @retry(
-    when=retry.when.status([408, 429, 502, 503, 504]), stop=retry.stop.after_attempt(5)
+    when=retry.when.status([408, 429, 502, 503, 504]),
+    stop=retry.stop.after_attempt(5),
+    on_exception=retry.CONNECTION_ERROR,
 )
 class TestMonitorClient(BaseClient):
     # prevent pytest from thinking this is a test class
diff --git a/nisystemlink/clients/testmonitor/models/_create_steps_request.py b/nisystemlink/clients/testmonitor/models/_create_steps_request.py
@@ -8,7 +8,7 @@
 
 
 class BaseStepRequest(JsonModel):
-    step_id: str
+    step_id: Optional[str]
     """Step ID."""
 
     result_id: str
diff --git a/nisystemlink/clients/testmonitor/utilities/_dataframe_utilities.py b/nisystemlink/clients/testmonitor/utilities/_dataframe_utilities.py
@@ -41,11 +41,13 @@ def convert_results_to_dataframe(
             - Properties: All the properties will be split into separate columns. For example,
             properties.property1, properties.property2, etc.
     """
-    results_dict = [result.model_dump(exclude_none=True) for result in results]
-    results_dict_with_normalized_status = __normalize_results_status(results_dict)
-    normalized_dataframe = pd.json_normalize(
-        results_dict_with_normalized_status, sep="."
-    )
+    results_dict = []
+    for result in results:
+        data = result.model_dump(exclude_none=True)
+        __normalize_status(data)
+        results_dict.append(data)
+
+    normalized_dataframe = pd.json_normalize(results_dict, sep=".")
     normalized_dataframe = __format_results_columns(
         results_dataframe=normalized_dataframe
     )
@@ -98,26 +100,21 @@ def convert_steps_to_dataframe(
     return steps_dataframe.reindex(columns=grouped_columns, copy=False)
 
 
-def __normalize_results_status(
-    results_dict: List[Dict[str, Any]],
-) -> List[Dict[str, Any]]:
-    """Gets dictionary of results data and modifies the status object.
+def __normalize_status(
+    data: Dict[str, Any],
+) -> None:
+    """Normalizes the status object into a string.
 
     Args:
-        results: List of results.
+        data: Dictionary containing status information.
 
-    Returns:
-        A list of result fields as dictionary. If status.status_type is "CUSTOM"
-            the status field takes the value of "status_name", else value of "status_type" is used.
     """
-    for result in results_dict:
-        status = result.get("status", {})
+    status = data.get("status", {})
+    if status:
         if status.get("status_type") == "CUSTOM":
-            result["status"] = status["status_name"]
+            data["status"] = status.get("status_name", None)
         else:
-            result["status"] = status["status_type"].value
-
-    return results_dict
+            data["status"] = getattr(status.get("status_type", None), "value", None)
 
 
 def __format_results_columns(results_dataframe: pd.DataFrame) -> pd.DataFrame:
@@ -208,7 +205,7 @@ def __convert_steps_to_dict(
         single_step_dict = step.model_dump(exclude_none=True)
         __filter_invalid_measurements(single_step_dict, step, is_valid_measurement)
         __normalize_inputs_outputs(single_step_dict, step)
-        __normalize_step_status(single_step_dict)
+        __normalize_status(single_step_dict)
         steps_dict.append(single_step_dict)
     return steps_dict
 
@@ -233,11 +230,15 @@ def __filter_invalid_measurements(
     if step.data and step.data.parameters and is_valid_measurement is not None:
         valid_measurement_parameters = []
         for measurement in step.data.parameters:
-            if is_valid_measurement(measurement):
+            if (
+                measurement
+                and is_valid_measurement(measurement)
+            ):
                 valid_measurement_parameters.append(measurement)
 
         step_dict["data"]["parameters"] = [
-            measurement.model_dump() for measurement in valid_measurement_parameters
+            measurement.model_dump(exclude_none=True)
+            for measurement in valid_measurement_parameters
         ]
 
 
@@ -266,24 +267,6 @@ def __normalize_inputs_outputs(
         )
 
 
-def __normalize_step_status(step_dict: Dict[str, Any]) -> None:
-    """Normalizes the step status field. If status_type is "CUSTOM",
-    then status.status_name is used, else status.status_type.value is assigned.
-
-    Args:
-        step_dict: A dictionary with step information.
-
-    Returns:
-        None: The function modifies step_dict in place with the normalized step
-    """
-    step_status = step_dict.get("status", {})
-    step_dict["status"] = (
-        step_status.get("status_name", None)
-        if step_status.get("status_type") == "CUSTOM"
-        else step_status.get("status_type", None).value
-    )
-
-
 def __explode_and_normalize(
     dataframe: pd.DataFrame, column: str, prefix: str
 ) -> pd.DataFrame:
diff --git a/nisystemlink/clients/testmonitor/utilities/constants.py b/nisystemlink/clients/testmonitor/utilities/constants.py
@@ -5,6 +5,7 @@ class DataFrameHeaders:
 
     CATEGORY_COLUMN_HEADERS = [
         "general",
+        "inputs",
         "outputs",
         "data",
         "properties",
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nisystemlink-clients"
-version = "2.7.1"
+version = "2.8.0"
 description = "NI-SystemLink Python API"
 authors = ["National Instruments"]
 maintainers = [
diff --git a/tests/integration/spec/test_spec.py b/tests/integration/spec/test_spec.py
@@ -297,3 +297,35 @@ def test__query_spec_projection_columns__columns_returned(
         assert len(spec_columns) == 2
         assert "spec_id" in spec_columns
         assert "name" in spec_columns
+
+    def test__without_condition_type_projection__query_specs__condition_type_field_is_unset(
+        self, client: SpecClient, create_specs, create_specs_for_query, product
+    ):
+        request = QuerySpecificationsRequest(
+            product_ids=[product],
+            projection=[
+                SpecificationProjection.CONDITION_NAME,
+                SpecificationProjection.CONDITION_UNIT,
+            ],
+        )
+
+        response = client.query_specs(request)
+        specs = [vars(spec) for spec in response.specs or []]
+        condition_columns = ["name", "unit", "range", "discrete", "condition_type"]
+
+        spec_columns = {
+            f"condition_{column}"
+            for spec in specs
+            if "conditions" in spec
+            for condition in spec["conditions"]
+            for column in condition_columns
+            if getattr(condition.value if column != "name" else condition, column, None)
+            is not None
+        }
+
+        assert response.specs
+        assert len(response.specs) == 3
+        assert len(spec_columns) == 2
+        assert "condition_name" in spec_columns
+        assert "condition_unit" in spec_columns
+        assert "condition_type" not in spec_columns
diff --git a/tests/integration/testmonitor/test_testmonitor.py b/tests/integration/testmonitor/test_testmonitor.py
@@ -534,6 +534,45 @@ def test__create_single_step__creation_succeed(
         assert created_step.inputs == inputs
         assert not created_step.outputs
 
+    def test__create_step_without_step_id__creation_succeed(
+        self,
+        client: TestMonitorClient,
+        create_results,
+        create_steps,
+    ):
+        results = [
+            CreateResultRequest(
+                part_number="Python Client Testing",
+                program_name="Python Client Test Program",
+                status=Status.PASSED(),
+            )
+        ]
+        created_result = create_results(results)
+        result_id = created_result.results[0].id
+        name = "Test Step 1"
+        data = StepData(
+            text="This is a test step",
+            parameters=[Measurement(name="param1", measurement="10")],
+        )
+        properties = {"property1": "value1", "property2": "value2"}
+        keywords = ["keyword1", "keyword2"]
+        inputs = [NamedValue(name="input1", value="inputValue1")]
+        step = CreateStepRequest(
+            result_id=result_id,
+            name=name,
+            data=data,
+            properties=properties,
+            keywords=keywords,
+            inputs=inputs,
+        )
+
+        response: CreateStepsPartialSuccess = create_steps(steps=[step])
+
+        assert response is not None
+        assert len(response.steps) == 1
+        created_step = response.steps[0]
+        assert created_step.step_id is not None
+
     def test__create_multiple_steps__multiple_creation_succeed(
         self, client: TestMonitorClient, create_results, create_steps
     ):
diff --git a/tests/testmonitor/test_testmonitor_dataframe_utilities.py b/tests/testmonitor/test_testmonitor_dataframe_utilities.py

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,9 @@`
`11`	`11`
`12`	`12`
`13`	`13`	`@retry(`
`14`		`- when=retry.when.status([408, 429, 502, 503, 504]), stop=retry.stop.after_attempt(5)`
	`14`	`+ when=retry.when.status([408, 429, 502, 503, 504]),`
	`15`	`+ stop=retry.stop.after_attempt(5),`
	`16`	`+ on_exception=retry.CONNECTION_ERROR,`
`15`	`17`	`)`
`16`	`18`	`class ProductClient(BaseClient):`
`17`	`19`	`def __init__(self, configuration: Optional[core.HttpConfiguration] = None):`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,9 @@`
`15`	`15`
`16`	`16`
`17`	`17`	`@retry(`
`18`		`- when=retry.when.status([408, 429, 502, 503, 504]), stop=retry.stop.after_attempt(5)`
	`18`	`+ when=retry.when.status([408, 429, 502, 503, 504]),`
	`19`	`+ stop=retry.stop.after_attempt(5),`
	`20`	`+ on_exception=retry.CONNECTION_ERROR,`
`19`	`21`	`)`
`20`	`22`	`class TestMonitorClient(BaseClient):`
`21`	`23`	`# prevent pytest from thinking this is a test class`