nextmv 1.0.0.dev7__py3-none-any.whl → 1.0.0.dev8__py3-none-any.whl

nextmv/cloud/application/_input_set.py

@@ -6,7 +6,6 @@ from datetime import datetime
 from typing import TYPE_CHECKING
 
 from nextmv.cloud.input_set import InputSet, ManagedInput
-from nextmv.safe import safe_id
 
 if TYPE_CHECKING:
     from . import Application
@@ -17,32 +16,6 @@ class ApplicationInputSetMixin:
     Mixin class for managing app input sets within an application.
     """
 
-    def delete_input_set(self: "Application", input_set_id: str) -> None:
-        """
-        Delete an input set.
-
-        Deletes an input set along with all the associated information.
-
-        Parameters
-        ----------
-        input_set_id : str
-            ID of the input set to delete.
-
-        Raises
-        ------
-        requests.HTTPError
-            If the response status code is not 2xx.
-
-        Examples
-        --------
-        >>> app.delete_input_set("input-set-123")
-        """
-
-        _ = self.client.request(
-            method="DELETE",
-            endpoint=f"{self.experiments_endpoint}/inputsets/{input_set_id}",
-        )
-
     def input_set(self: "Application", input_set_id: str) -> InputSet:
         """
         Get an input set.
@@ -108,8 +81,8 @@ class ApplicationInputSetMixin:
 
     def new_input_set(
         self: "Application",
-        id: str | None = None,
-        name: str | None = None,
+        id: str,
+        name: str,
         description: str | None = None,
         end_time: datetime | None = None,
         instance_id: str | None = None,
@@ -134,11 +107,10 @@ class ApplicationInputSetMixin:
 
         Parameters
         ----------
-        id: str | None = None
-            ID of the input set, will be generated if not provided.
-        name: str | None = None
-            Name of the input set. If not provided, the ID will be used as
-            the name.
+        id: str
+            ID of the input set
+        name: str
+            Name of the input set.
         description: Optional[str]
             Optional description of the input set.
         end_time: Optional[datetime]
@@ -173,14 +145,6 @@ class ApplicationInputSetMixin:
             If the response status code is not 2xx.
         """
 
-        # Generate ID if not provided
-        if id is None or id == "":
-            id = safe_id("input-set")
-
-        # Use ID as name if name not provided
-        if name is None or name == "":
-            name = id
-
         payload = {
             "id": id,
             "name": name,

nextmv/cloud/application/_run.py

@@ -21,7 +21,14 @@ from nextmv.cloud.url import DownloadURL
 from nextmv.input import Input, InputFormat
 from nextmv.logger import log
 from nextmv.options import Options
-from nextmv.output import ASSETS_KEY, STATISTICS_KEY, Asset, Output, OutputFormat, Statistics
+from nextmv.output import (
+    ASSETS_KEY,
+    STATISTICS_KEY,
+    Asset,
+    Output,
+    OutputFormat,
+    Statistics,
+)
 from nextmv.polling import DEFAULT_POLLING_OPTIONS, PollingOptions, poll
 from nextmv.run import (
     ExternalRunResult,

nextmv/cloud/application/_shadow.py

@@ -4,7 +4,7 @@ Application mixin for managing shadow tests.
 
 from typing import TYPE_CHECKING
 
-from nextmv.cloud.shadow import ShadowTest, ShadowTestMetadata, StartEvents, StopIntent, TerminationEvents
+from nextmv.cloud.shadow import ShadowTest, ShadowTestMetadata, StartEvents, TerminationEvents
 from nextmv.run import Run
 from nextmv.safe import safe_id
 
@@ -248,7 +248,7 @@ class ApplicationShadowMixin:
             endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}/start",
         )
 
-    def stop_shadow_test(self: "Application", shadow_test_id: str, intent: StopIntent) -> None:
+    def stop_shadow_test(self: "Application", shadow_test_id: str) -> None:
         """
         Stop a shadow test. The test should already have started before using
         this method.
@@ -257,22 +257,16 @@ class ApplicationShadowMixin:
         ----------
         shadow_test_id : str
             ID of the shadow test to stop.
-        intent : StopIntent
-            Intent for stopping the shadow test.
+
         Raises
         ------
         requests.HTTPError
             If the response status code is not 2xx.
         """
 
-        payload = {
-            "intent": intent.value,
-        }
-
         _ = self.client.request(
             method="PUT",
             endpoint=f"{self.experiments_endpoint}/shadow/{shadow_test_id}/stop",
-            payload=payload,
         )
 
     def update_shadow_test(

nextmv/cloud/application/_switchback.py

@@ -5,7 +5,6 @@ Application mixin for managing switchback tests.
 from datetime import datetime
 from typing import TYPE_CHECKING
 
-from nextmv.cloud.shadow import StopIntent
 from nextmv.cloud.switchback import SwitchbackTest, SwitchbackTestMetadata, TestComparisonSingle
 from nextmv.run import Run
 from nextmv.safe import safe_id
@@ -217,7 +216,7 @@ class ApplicationSwitchbackMixin:
         payload = {
             "id": switchback_test_id,
             "name": name,
-            "comparison": comparison.to_dict(),
+            "comparison": comparison,
             "generate_random_plan": {
                 "unit_duration_minutes": unit_duration_minutes,
                 "units": units,
@@ -258,7 +257,7 @@ class ApplicationSwitchbackMixin:
             endpoint=f"{self.experiments_endpoint}/switchback/{switchback_test_id}/start",
         )
 
-    def stop_switchback_test(self: "Application", switchback_test_id: str, intent: StopIntent) -> None:
+    def stop_switchback_test(self: "Application", switchback_test_id: str) -> None:
         """
         Stop a switchback test. The test should already have started before using
         this method.
@@ -268,23 +267,15 @@ class ApplicationSwitchbackMixin:
         switchback_test_id : str
             ID of the switchback test to stop.
 
-        intent : StopIntent
-            Intent for stopping the switchback test.
-
         Raises
         ------
         requests.HTTPError
             If the response status code is not 2xx.
         """
 
-        payload = {
-            "intent": intent.value,
-        }
-
         _ = self.client.request(
             method="PUT",
             endpoint=f"{self.experiments_endpoint}/switchback/{switchback_test_id}/stop",
-            payload=payload,
         )
 
     def update_switchback_test(

nextmv/cloud/batch_experiment.py

@@ -30,9 +30,7 @@ class ExperimentStatus(str, Enum):
 
     You can import the `ExperimentStatus` class directly from `cloud`:
 
-    ```python
-    from nextmv.cloud import ExperimentStatus
-    ```
+    ```python from nextmv.cloud import ExperimentStatus ```
 
     This enum represents the comprehensive set of possible states for an
     experiment in Nextmv Cloud.

nextmv/cloud/client.py

@@ -303,7 +303,7 @@ class Client:
         if data is not None:
             kwargs["data"] = data
         if payload is not None:
-            if isinstance(payload, (dict, list)):
+            if isinstance(payload, dict | list):
                 data = deflated_serialize_json(payload, json_configurations=json_configurations)
                 kwargs["data"] = data
             else:

nextmv/cloud/integration.py

@@ -225,12 +225,12 @@ class Integration(BaseModel):
     def new(  # noqa: C901
         cls,
         client: Client,
+        name: str,
         integration_type: IntegrationType | str,
         exec_types: list[ManifestType | str],
         provider: IntegrationProvider | str,
         provider_config: dict[str, Any],
         integration_id: str | None = None,
-        name: str | None = None,
         description: str | None = None,
         is_global: bool = False,
         application_ids: list[str] | None = None,
@@ -243,6 +243,8 @@ class Integration(BaseModel):
         ----------
         client : Client
             Client to use for interacting with the Nextmv Cloud API.
+        name : str
+            The name of the integration.
         integration_type : IntegrationType | str
             The type of the integration. Please refer to the `IntegrationType`
             enum for possible values.
@@ -257,9 +259,6 @@ class Integration(BaseModel):
         integration_id : str, optional
             The unique identifier of the integration. If not provided,
             it will be generated automatically.
-        name : str | None, optional
-            The name of the integration. If not provided, the integration ID
-            will be used as the name.
         description : str, optional
             An optional description of the integration.
         is_global : bool, optional, default=False
@@ -303,10 +302,8 @@ class Integration(BaseModel):
         elif not is_global and application_ids is None:
             raise ValueError("A non-global integration must have specific application IDs.")
 
-        if integration_id is None or integration_id == "":
+        if integration_id is None:
             integration_id = safe_id("integration")
-        if name is None or name == "":
-            name = integration_id
 
         if exist_ok:
             try:

nextmv/cloud/shadow.py

@@ -19,7 +19,6 @@ ShadowTest
 """
 
 from datetime import datetime
-from enum import Enum
 from typing import Any
 
 from pydantic import AliasChoices, Field
@@ -228,27 +227,3 @@ class ShadowTest(BaseModel):
     """Grouped distributional summaries of the shadow test."""
     runs: list[Run] | None = None
     """List of runs in the shadow test."""
-
-
-class StopIntent(str, Enum):
-    """
-    Intent for stopping a shadow test.
-
-    You can import the `StopIntent` class directly from `cloud`:
-
-    ```python
-    from nextmv.cloud import StopIntent
-    ```
-
-    Attributes
-    ----------
-    complete : str
-        The test is marked as complete.
-    cancel : str
-        The test is canceled.
-    """
-
-    complete = "complete"
-    """The test is marked as complete."""
-    cancel = "cancel"
-    """The test is canceled."""

nextmv/cloud/switchback.py

@@ -45,8 +45,6 @@ class TestComparisonSingle(BaseModel):
         ID of the candidate instance for comparison.
     """
 
-    __test__ = False  # Prevents pytest from collecting this class as a test case
-
     baseline_instance_id: str
     """ID of the baseline instance for comparison."""
     candidate_instance_id: str

nextmv/default_app/main.py

@@ -26,12 +26,10 @@ assets = create_visuals(name, input.data["radius"], input.data["distance"])
 output = nextmv.Output(
     options=options,
     solution={"message": message},
-    statistics=nextmv.Statistics(
-        result=nextmv.ResultStatistics(
-            value=1.23,
-            custom={"message": message},
-        ),
-    ),
+    metrics={
+        "value": 1.23,
+        "custom": {"message": message},
+    },
     assets=assets,
 )
 nextmv.write(output)

nextmv/local/executor.py

@@ -22,6 +22,8 @@ process_run_information
     Function to update run metadata including duration and status.
 process_run_logs
     Function to process and save run logs.
+process_run_metrics
+    Function to process and save run metrics.
 process_run_statistics
     Function to process and save run statistics.
 process_run_assets
@@ -57,7 +59,16 @@ from nextmv.local.local import (
 )
 from nextmv.local.plotly_handler import handle_plotly_visual
 from nextmv.manifest import Manifest, ManifestType
-from nextmv.output import ASSETS_KEY, OUTPUTS_KEY, SOLUTIONS_KEY, STATISTICS_KEY, Asset, OutputFormat, VisualSchema
+from nextmv.output import (
+    ASSETS_KEY,
+    METRICS_KEY,
+    OUTPUTS_KEY,
+    SOLUTIONS_KEY,
+    STATISTICS_KEY,
+    Asset,
+    OutputFormat,
+    VisualSchema,
+)
 from nextmv.status import StatusV2
 
 
@@ -305,7 +316,7 @@ def process_run_output(
 ) -> None:
     """
     Processes the result of the subprocess run. This function is in charge of
-    handling the run results, including solutions, statistics, logs, assets,
+    handling the run results, including solutions, statistics, metrics, logs, assets,
     and visuals.
 
     Parameters
@@ -347,6 +358,13 @@ def process_run_output(
         result=result,
         stdout_output=stdout_output,
     )
+    process_run_metrics(
+        temp_run_outputs_dir=temp_run_outputs_dir,
+        outputs_dir=outputs_dir,
+        stdout_output=stdout_output,
+        temp_src=temp_src,
+        manifest=manifest,
+    )
     process_run_statistics(
         temp_run_outputs_dir=temp_run_outputs_dir,
         outputs_dir=outputs_dir,
@@ -499,6 +517,65 @@ def process_run_logs(
 
         f.write(std_err)
 
+def process_run_metrics(
+    temp_run_outputs_dir: str,
+    outputs_dir: str,
+    stdout_output: str | dict[str, Any],
+    temp_src: str,
+    manifest: Manifest,
+) -> None:
+    """
+    Processes the metrics of the run. Checks for an outputs/metrics folder
+    or custom metrics file location from manifest. If found, copies to run
+    directory. Otherwise, attempts to extract metrics from stdout.
+
+    Parameters
+    ----------
+    temp_run_outputs_dir : str
+        The path to the temporary outputs directory.
+    outputs_dir : str
+        The path to the outputs directory in the run directory.
+    stdout_output : Union[str, dict[str, Any]]
+        The stdout output of the run, either as raw string or parsed dictionary.
+    temp_src : str
+        The path to the temporary source directory.
+    manifest : Manifest
+        The application manifest containing configuration and custom paths.
+    """
+
+    metrics_dst = os.path.join(outputs_dir, METRICS_KEY)
+    os.makedirs(metrics_dst, exist_ok=True)
+    metrics_file = f"{METRICS_KEY}.json"
+
+    # Check for custom location in manifest and override metrics_src if needed.
+    if (
+        manifest.configuration is not None
+        and manifest.configuration.content is not None
+        and manifest.configuration.content.format == OutputFormat.MULTI_FILE
+        and manifest.configuration.content.multi_file is not None
+    ):
+        metrics_src_file = os.path.join(temp_src, manifest.configuration.content.multi_file.output.metrics)
+
+        # If the custom metrics file exists, copy it to the metrics destination
+        if os.path.exists(metrics_src_file) and os.path.isfile(metrics_src_file):
+            metrics_dst_file = os.path.join(metrics_dst, metrics_file)
+            shutil.copy2(metrics_src_file, metrics_dst_file)
+            return
+
+    metrics_src = os.path.join(temp_run_outputs_dir, METRICS_KEY)
+    if os.path.exists(metrics_src) and os.path.isdir(metrics_src):
+        shutil.copytree(metrics_src, metrics_dst, dirs_exist_ok=True)
+        return
+
+    if not isinstance(stdout_output, dict):
+        return
+
+    if METRICS_KEY not in stdout_output:
+        return
+
+    with open(os.path.join(metrics_dst, metrics_file), "w") as f:
+        metrics = {METRICS_KEY: stdout_output[METRICS_KEY]}
+        json.dump(metrics, f, indent=2)
 
 def process_run_statistics(
     temp_run_outputs_dir: str,
@@ -508,6 +585,9 @@ def process_run_statistics(
     manifest: Manifest,
 ) -> None:
     """
+    !!! warning
+    `process_run_statistics` is deprecated, use `process_run_metrics` instead.
+
     Processes the statistics of the run. Checks for an outputs/statistics folder
     or custom statistics file location from manifest. If found, copies to run
     directory. Otherwise, attempts to extract statistics from stdout.
@@ -848,7 +928,7 @@ def _copy_new_or_modified_files(  # noqa: C901
     This function identifies files that are either new (not present in the original
     source) or have been modified (different content, checksum, or modification time)
     compared to the original source. It excludes files that exist in specified
-    exclusion directories to avoid copying input data, statistics, or assets as
+    exclusion directories to avoid copying input data, statistics, metrics, or assets as
     solution outputs.
 
     Parameters

nextmv/local/geojson_handler.py

@@ -111,7 +111,7 @@ def extract_coordinates(coords, all_coords) -> None:
       like Polygons and MultiPolygons
     """
     if isinstance(coords, list):
-        if len(coords) == 2 and isinstance(coords[0], (int, float)) and isinstance(coords[1], (int, float)):
+        if len(coords) == 2 and isinstance(coords[0], int | float) and isinstance(coords[1], int | float):
             # This is a coordinate pair [lon, lat]
             all_coords.append(coords)
         else:

nextmv/manifest.py

@@ -829,7 +829,9 @@ class ManifestContentMultiFileOutput(BaseModel):
     Parameters
     ----------
     statistics : Optional[str], default=""
-        The path to the statistics file.
+        Deprecated: Use `metrics` instead. The path to the statistics file.
+    metrics : Optional[str], default=""
+        The path to the metrics file.
     assets : Optional[str], default=""
         The path to the assets file.
     solutions : Optional[str], default=""
@@ -839,16 +841,18 @@ class ManifestContentMultiFileOutput(BaseModel):
     --------
     >>> from nextmv import ManifestContentMultiFileOutput
     >>> output_config = ManifestContentMultiFileOutput(
-    ...     statistics="my-outputs/statistics.json",
+    ...     metrics="my-outputs/metrics.json",
     ...     assets="my-outputs/assets.json",
     ...     solutions="my-outputs/solutions/"
     ... )
-    >>> output_config.statistics
-    'my-outputs/statistics.json'
+    >>> output_config.metrics
+    'my-outputs/metrics.json'
     """
 
     statistics: str | None = ""
-    """The path to the statistics file."""
+    """Deprecated: Use `metrics` instead. The path to the statistics file."""
+    metrics: str | None = ""
+    """The path to the metrics file."""
     assets: str | None = ""
     """The path to the assets file."""
     solutions: str | None = ""
@@ -878,7 +882,7 @@ class ManifestContentMultiFile(BaseModel):
     >>> multi_file_config = ManifestContentMultiFile(
     ...     input=ManifestContentMultiFileInput(path="data/input/"),
     ...     output=ManifestContentMultiFileOutput(
-    ...         statistics="my-outputs/statistics.json",
+    ...         metrics="my-outputs/metrics.json",
     ...         assets="my-outputs/assets.json",
     ...         solutions="my-outputs/solutions/"
     ...     )
@@ -919,7 +923,7 @@ class ManifestContent(BaseModel):
     ...     multi_file=ManifestContentMultiFile(
     ...         input=ManifestContentMultiFileInput(path="data/input/"),
     ...         output=ManifestContentMultiFileOutput(
-    ...             statistics="my-outputs/statistics.json",
+    ...             metrics="my-outputs/metrics.json",
     ...             assets="my-outputs/assets.json",
     ...             solutions="my-outputs/solutions/"
     ...         )

nextmv/model.py

@@ -195,7 +195,7 @@ class Model:
     ...         return nextmv.Output(
     ...             options=input.options,
     ...             solution=nextroute_output.solutions[0].to_dict(),
-    ...             statistics=nextroute_output.statistics.to_dict(),
+    ...             metrics=nextroute_output.metrics.to_dict(),
     ...         )
     """
 
@@ -234,7 +234,7 @@ class Model:
         ...     return Output(
         ...         options=input.options,
         ...         solution=result,
-        ...         statistics={"processing_time": 0.5}
+        ...         metrics={"processing_time": 0.5}
         ...     )
         """
 

nextmv/options.py

@@ -695,7 +695,7 @@ class Options:
             help=argparse.SUPPRESS,
             default="1",
         )
-        args, _ = parser.parse_known_args()
+        args = parser.parse_args()
 
         for arg in vars(args):
             if arg == "fff" or arg == "f":