nextmv 0.24.0__tar.gz → 0.26.0__tar.gz

{nextmv-0.24.0 → nextmv-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 0.24.0
+Version: 0.26.0
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://www.nextmv.io/docs/python-sdks/nextmv/installation

nextmv-0.26.0/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v0.26.0"

{nextmv-0.24.0 → nextmv-0.26.0}/nextmv/cloud/application.py

@@ -14,7 +14,12 @@ import requests
 from nextmv.base_model import BaseModel
 from nextmv.cloud import package
 from nextmv.cloud.acceptance_test import AcceptanceTest, ExperimentStatus, Metric
-from nextmv.cloud.batch_experiment import BatchExperiment, BatchExperimentMetadata, BatchExperimentRun
+from nextmv.cloud.batch_experiment import (
+    BatchExperiment,
+    BatchExperimentInformation,
+    BatchExperimentMetadata,
+    BatchExperimentRun,
+)
 from nextmv.cloud.client import Client, get_size
 from nextmv.cloud.input_set import InputSet, ManagedInput
 from nextmv.cloud.instance import Instance, InstanceConfiguration
@@ -1799,7 +1804,7 @@ class Application:
 
         return self.batch_experiment(batch_id=scenario_test_id)
 
-    def track_run(self, tracked_run: TrackedRun) -> str:
+    def track_run(self, tracked_run: TrackedRun, instance_id: Optional[str] = None) -> str:
         """
         Track an external run.
 
@@ -1812,6 +1817,9 @@ class Application:
         ----------
         tracked_run : TrackedRun
             The run to track.
+        instance_id: Optional[str]
+            Optional instance ID if you want to associate your tracked run with
+            an instance.
 
         Returns
         -------
@@ -1855,12 +1863,17 @@ class Application:
         if tracked_run.error is not None and tracked_run.error != "":
             external_result.error_message = tracked_run.error
 
-        return self.new_run(upload_id=url_input.upload_id, external_result=external_result)
+        return self.new_run(
+            upload_id=url_input.upload_id,
+            external_result=external_result,
+            instance_id=instance_id,
+        )
 
     def track_run_with_result(
         self,
         tracked_run: TrackedRun,
         polling_options: PollingOptions = _DEFAULT_POLLING_OPTIONS,
+        instance_id: Optional[str] = None,
     ) -> RunResult:
         """
         Track an external run and poll for the result. This is a convenience
@@ -1874,6 +1887,9 @@ class Application:
             The run to track.
         polling_options : PollingOptions
             Options to use when polling for the run result.
+        instance_id: Optional[str]
+            Optional instance ID if you want to associate your tracked run with
+            an instance.
 
         Returns
         -------
@@ -1893,7 +1909,7 @@ class Application:
             If the run does not succeed after the polling strategy is
             exhausted based on number of tries.
         """
-        run_id = self.track_run(tracked_run=tracked_run)
+        run_id = self.track_run(tracked_run=tracked_run, instance_id=instance_id)
 
         return self.run_result_with_polling(
             run_id=run_id,
@@ -1944,6 +1960,47 @@ class Application:
 
         return Instance.from_dict(response.json())
 
+    def update_batch_experiment(
+        self,
+        batch_experiment_id: str,
+        name: str,
+        description: str,
+    ) -> BatchExperimentInformation:
+        """
+        Update a batch experiment.
+
+        Parameters
+        ----------
+        batch_experiment_id : str
+            ID of the batch experiment to update.
+        name : str
+            Name of the batch experiment.
+        description : str
+            Description of the batch experiment.
+
+        Returns
+        -------
+        BatchExperimentInformation
+            The information with the updated batch experiment.
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        payload = {
+            "name": name,
+            "description": description,
+        }
+        response = self.client.request(
+            method="PATCH",
+            endpoint=f"{self.experiments_endpoint}/batch/{batch_experiment_id}",
+            payload=payload,
+        )
+
+        return BatchExperimentInformation.from_dict(response.json())
+
     def update_managed_input(
         self,
         managed_input_id: str,
@@ -1983,6 +2040,43 @@ class Application:
             payload=payload,
         )
 
+    def update_scenario_test(
+        self,
+        scenario_test_id: str,
+        name: str,
+        description: str,
+    ) -> BatchExperimentInformation:
+        """
+        Update a scenario test. Scenario tests use the batch experiments API,
+        so this method calls the `update_batch_experiment` method, and thus the
+        return type is the same.
+
+        Parameters
+        ----------
+        scenario_test_id : str
+            ID of the scenario test to update.
+        name : str
+            Name of the scenario test.
+        description : str
+            Description of the scenario test.
+
+        Returns
+        -------
+        BatchExperimentInformation
+            The information with the updated scenario test.
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        return self.update_batch_experiment(
+            batch_experiment_id=scenario_test_id,
+            name=name,
+            description=description,
+        )
+
     def update_secrets_collection(
         self,
         secrets_collection_id: str,

{nextmv-0.24.0 → nextmv-0.26.0}/nextmv/cloud/batch_experiment.py

@@ -18,9 +18,9 @@ class BatchExperimentInformation(BaseModel):
     """Creation date of the batch experiment."""
     updated_at: datetime
     """Last update date of the batch experiment."""
-    status: str
-    """Status of the batch experiment."""
 
+    status: Optional[str] = None
+    """Status of the batch experiment."""
     description: Optional[str] = None
     """Description of the batch experiment."""
     number_of_requested_runs: Optional[int] = None
@@ -101,5 +101,5 @@ class BatchExperimentRun(BaseModel):
 class BatchExperimentMetadata(BatchExperimentInformation):
     """Metadata of a batch experiment."""
 
-    app_id: str
+    app_id: Optional[str] = None
     """ID of the application used for the batch experiment."""

{nextmv-0.24.0 → nextmv-0.26.0}/nextmv/output.py

@@ -349,7 +349,7 @@ class Output:
 class OutputWriter:
     """Base class for writing outputs."""
 
-    def write(self, output: Output, *args, **kwargs) -> None:
+    def write(self, output: Union[Output, dict[str, Any], BaseModel], *args, **kwargs) -> None:
         """
         Write the output data. This method should be implemented by subclasses.
         """
@@ -364,7 +364,7 @@ class LocalOutputWriter(OutputWriter):
     """
 
     def _write_json(
-        output: Union[Output, dict[str, Any]],
+        output: Union[Output, dict[str, Any], BaseModel],
         options: dict[str, Any],
         statistics: dict[str, Any],
         assets: list[dict[str, Any]],
@@ -372,6 +372,8 @@ class LocalOutputWriter(OutputWriter):
     ) -> None:
         if isinstance(output, dict):
             final_output = output
+        elif isinstance(output, BaseModel):
+            final_output = output.to_dict()
         else:
             solution = output.solution if output.solution is not None else {}
             final_output = {
@@ -447,7 +449,7 @@ class LocalOutputWriter(OutputWriter):
 
     def write(
         self,
-        output: Union[Output, dict[str, Any]],
+        output: Union[Output, dict[str, Any], BaseModel],
         path: Optional[str] = None,
         skip_stdout_reset: bool = False,
     ) -> None:
@@ -497,8 +499,12 @@ class LocalOutputWriter(OutputWriter):
             output_format = output.output_format
         elif isinstance(output, dict):
             output_format = OutputFormat.JSON
+        elif isinstance(output, BaseModel):
+            output_format = OutputFormat.JSON
         else:
-            raise TypeError(f"unsupported output type: {type(output)}, supported types are `Output` or `dict`")
+            raise TypeError(
+                f"unsupported output type: {type(output)}, supported types are `Output`, `dict`, `BaseModel`"
+            )
 
         statistics = self._extract_statistics(output)
         options = self._extract_options(output)
@@ -640,7 +646,7 @@ _LOCAL_OUTPUT_WRITER = LocalOutputWriter()
 
 
 def write(
-    output: Union[Output, dict[str, Any]],
+    output: Union[Output, dict[str, Any], BaseModel],
     path: Optional[str] = None,
     skip_stdout_reset: bool = False,
     writer: Optional[OutputWriter] = _LOCAL_OUTPUT_WRITER,

{nextmv-0.24.0 → nextmv-0.26.0}/tests/test_output.py

@@ -4,10 +4,11 @@ import os
 import shutil
 import unittest
 from io import StringIO
-from typing import Optional
+from typing import Any, Optional
 from unittest.mock import patch
 
 import nextmv
+from nextmv.base_model import BaseModel
 
 
 class TestOutput(unittest.TestCase):
@@ -294,6 +295,32 @@ class TestOutput(unittest.TestCase):
 
             self.assertDictEqual(got, expected)
 
+    def test_local_write_base_model(self):
+        class myClass(BaseModel):
+            output: dict[str, Any]
+
+        output = {
+            "i_am": "a_crazy_object",
+            "with": [
+                {"nested": "values"},
+                {"and": "more_craziness"},
+            ],
+        }
+        custom_class = myClass(output=output)
+
+        output_writer = nextmv.LocalOutputWriter()
+
+        with patch("sys.stdout", new=StringIO()) as mock_stdout:
+            output_writer.write(custom_class, skip_stdout_reset=True)
+
+            got = json.loads(mock_stdout.getvalue())
+
+            # We test that the `write` method calls the `.to_dict()` method if
+            # it detects the output type to be an instance of `BaseModel`.
+            expected = {"output": output}
+
+            self.assertDictEqual(got, expected)
+
     def test_local_write_empty_output(self):
         output = nextmv.Output()
 

nextmv-0.24.0/nextmv/__about__.py

@@ -1 +0,0 @@
-__version__ = "v0.24.0"