nextmv 0.35.0__py3-none-any.whl → 0.35.0.dev0__py3-none-any.whl

nextmv/output.py

@@ -60,7 +60,7 @@ import sys
 from collections.abc import Callable
 from dataclasses import dataclass
 from enum import Enum
-from typing import Any
+from typing import Any, Optional, Union
 
 from pydantic import AliasChoices, Field
 
@@ -119,11 +119,16 @@ class RunStatistics(BaseModel):
     {'duration': 10.5, 'iterations': 100, 'custom': {'convergence': 0.001}}
     """
 
-    duration: float | None = None
+    duration: Optional[float] = None
     """Duration of the run in seconds."""
-    iterations: int | None = None
+    iterations: Optional[int] = None
     """Number of iterations."""
-    custom: Any | dict[str, Any] | None = None
+    custom: Optional[
+        Union[
+            Any,
+            dict[str, Any],
+        ]
+    ] = None
     """Custom statistics created by the user. Can normally expect a `dict[str,
     Any]`."""
 
@@ -159,11 +164,16 @@ class ResultStatistics(BaseModel):
     {'duration': 5.2, 'value': 42.0, 'custom': {'gap': 0.05}}
     """
 
-    duration: float | None = None
+    duration: Optional[float] = None
     """Duration of the run in seconds."""
-    value: float | None = None
+    value: Optional[float] = None
     """Value of the result."""
-    custom: Any | dict[str, Any] | None = None
+    custom: Optional[
+        Union[
+            Any,
+            dict[str, Any],
+        ]
+    ] = None
     """Custom statistics created by the user. Can normally expect a `dict[str,
     Any]`."""
 
@@ -229,9 +239,9 @@ class Series(BaseModel):
     2
     """
 
-    name: str | None = None
+    name: Optional[str] = None
     """Name of the series."""
-    data_points: list[DataPoint] | None = None
+    data_points: Optional[list[DataPoint]] = None
     """Data of the series."""
 
 
@@ -264,9 +274,9 @@ class SeriesData(BaseModel):
     1
     """
 
-    value: Series | None = None
+    value: Optional[Series] = None
     """A series for the value of the solution."""
-    custom: list[Series] | None = None
+    custom: Optional[list[Series]] = None
     """A list of series for custom statistics."""
 
 
@@ -304,13 +314,13 @@ class Statistics(BaseModel):
     100.0
     """
 
-    run: RunStatistics | None = None
+    run: Optional[RunStatistics] = None
     """Statistics about the run."""
-    result: ResultStatistics | None = None
+    result: Optional[ResultStatistics] = None
     """Statistics about the last result."""
-    series_data: SeriesData | None = None
+    series_data: Optional[SeriesData] = None
     """Data of the series."""
-    statistics_schema: str | None = Field(
+    statistics_schema: Optional[str] = Field(
         serialization_alias="schema",
         validation_alias=AliasChoices("schema", "statistics_schema"),
         default="v1",
@@ -397,7 +407,7 @@ class Visual(BaseModel):
     label: str
     """Label for the custom tab of the visual asset in the Nextmv Console."""
 
-    visual_type: str | None = Field(
+    visual_type: Optional[str] = Field(
         serialization_alias="type",
         validation_alias=AliasChoices("type", "visual_type"),
         default="custom-tab",
@@ -472,11 +482,11 @@ class Asset(BaseModel):
     content: Any
     """Content of the asset. The type must be serializable to JSON."""
 
-    content_type: str | None = "json"
+    content_type: Optional[str] = "json"
     """Content type of the asset. Only `json` is allowed"""
-    description: str | None = None
+    description: Optional[str] = None
     """Description of the asset."""
-    visual: Visual | None = None
+    visual: Optional[Visual] = None
     """Visual schema of the asset."""
 
     def __post_init__(self):
@@ -623,12 +633,12 @@ class SolutionFile:
     The `writer_args` and `writer_kwargs` parameters of this class can be used
     to provide those additional arguments.
     """
-    writer_args: list[Any] | None = None
+    writer_args: Optional[list[Any]] = None
     """
     Optional positional arguments to pass to the writer function. This can be
     used to customize the behavior of the writer.
     """
-    writer_kwargs: dict[str, Any] | None = None
+    writer_kwargs: Optional[dict[str, Any]] = None
     """
     Optional keyword arguments to pass to the writer function. This can be used
     to customize the behavior of the writer.
@@ -638,7 +648,7 @@ class SolutionFile:
 def json_solution_file(
     name: str,
     data: dict[str, Any],
-    json_configurations: dict[str, Any] | None = None,
+    json_configurations: Optional[dict[str, Any]] = None,
 ) -> SolutionFile:
     """
     This is a convenience function to build a `SolutionFile`. It writes the
@@ -701,7 +711,7 @@ def json_solution_file(
 def csv_solution_file(
     name: str,
     data: list[dict[str, Any]],
-    csv_configurations: dict[str, Any] | None = None,
+    csv_configurations: Optional[dict[str, Any]] = None,
 ) -> SolutionFile:
     """
     This is a convenience function to build a `SolutionFile`. It writes the
@@ -923,7 +933,7 @@ class Output:
     True
     """
 
-    options: Options | dict[str, Any] | None = None
+    options: Optional[Union[Options, dict[str, Any]]] = None
     """
     Options that the `Output` was created with. These options can be of type
     `Options` or a simple dictionary. If the options are of type `Options`,
@@ -939,13 +949,18 @@ class Output:
     }
     ```
     """
-    output_format: OutputFormat | None = OutputFormat.JSON
+    output_format: Optional[OutputFormat] = OutputFormat.JSON
     """
     Format of the output data. Default is `OutputFormat.JSON`. When set to
     `OutputFormat.MULTI_FILE`, the `solution_files` field must be specified and
     cannot be `None`.
     """
-    solution: dict[str, Any] | Any | dict[str, list[dict[str, Any]]] | None = None
+    solution: Optional[
+        Union[
+            Union[dict[str, Any], Any],  # JSON
+            dict[str, list[dict[str, Any]]],  # CSV_ARCHIVE
+        ]
+    ] = None
     """
     The solution to the decision problem. Use this filed when working with
     `output_format` of types:
@@ -960,7 +975,7 @@ class Output:
     this `solution` field is ignored, as you should use the `solution_files`
     field instead.
     """
-    statistics: Statistics | dict[str, Any] | None = None
+    statistics: Optional[Union[Statistics, dict[str, Any]]] = None
     """
     Statistics of the solution. These statistics can be of type `Statistics` or a
     simple dictionary. If the statistics are of type `Statistics`, they will be
@@ -968,19 +983,19 @@ class Output:
     dictionary, they will be used as is. If the statistics are not provided, an
     empty dictionary will be used.
     """
-    csv_configurations: dict[str, Any] | None = None
+    csv_configurations: Optional[dict[str, Any]] = None
     """
     Optional configuration for writing CSV files, to be used when the
     `output_format` is `OutputFormat.CSV_ARCHIVE`. These configurations are
     passed as kwargs to the `DictWriter` class from the `csv` module.
     """
-    json_configurations: dict[str, Any] | None = None
+    json_configurations: Optional[dict[str, Any]] = None
     """
     Optional configuration for writing JSON files, to be used when the
     `output_format` is `OutputFormat.JSON`. These configurations are passed as
     kwargs to the `json.dumps` function.
     """
-    assets: list[Asset | dict[str, Any]] | None = None
+    assets: Optional[list[Union[Asset, dict[str, Any]]]] = None
     """
     Optional list of assets to be included in the output. These assets can be of
     type `Asset` or a simple dictionary. If the assets are of type `Asset`, they
@@ -988,7 +1003,7 @@ class Output:
     dictionary, they will be used as is. If the assets are not provided, an
     empty list will be used.
     """
-    solution_files: list[SolutionFile] | None = None
+    solution_files: Optional[list[SolutionFile]] = None
     """
     Optional list of solution files to be included in the output. These files
     are of type `SolutionFile`, which allows for custom serialization and
@@ -1147,7 +1162,7 @@ class OutputWriter:
     ...         print(f"Writing output to {path}")
     """
 
-    def write(self, output: Output | dict[str, Any] | BaseModel, *args, **kwargs) -> None:
+    def write(self, output: Union[Output, dict[str, Any], BaseModel], *args, **kwargs) -> None:
         """
         Write the output data.
 
@@ -1197,9 +1212,9 @@ class LocalOutputWriter(OutputWriter):
 
     def _write_json(
         self,
-        output: Output | dict[str, Any] | BaseModel,
+        output: Union[Output, dict[str, Any], BaseModel],
         output_dict: dict[str, Any],
-        path: str | None = None,
+        path: Optional[str] = None,
     ) -> None:
         """
         Write output in JSON format.
@@ -1231,9 +1246,9 @@ class LocalOutputWriter(OutputWriter):
 
     def _write_archive(
         self,
-        output: Output | dict[str, Any] | BaseModel,
+        output: Union[Output, dict[str, Any], BaseModel],
         output_dict: dict[str, Any],
-        path: str | None = None,
+        path: Optional[str] = None,
     ) -> None:
         """
         Write output in CSV archive format.
@@ -1297,9 +1312,9 @@ class LocalOutputWriter(OutputWriter):
 
     def _write_multi_file(
         self,
-        output: Output | dict[str, Any] | BaseModel,
+        output: Union[Output, dict[str, Any], BaseModel],
         output_dict: dict[str, Any],
-        path: str | None = None,
+        path: Optional[str] = None,
     ) -> None:
         """
         Write output to multiple files.
@@ -1352,7 +1367,7 @@ class LocalOutputWriter(OutputWriter):
         parent_dir: str,
         output_dict: dict[str, Any],
         element_key: str,
-        json_configurations: dict[str, Any] | None = None,
+        json_configurations: Optional[dict[str, Any]] = None,
     ):
         """
         Auxiliary function to write a specific element of the output
@@ -1425,8 +1440,8 @@ class LocalOutputWriter(OutputWriter):
 
     def write(
         self,
-        output: Output | dict[str, Any] | BaseModel,
-        path: str | None = None,
+        output: Union[Output, dict[str, Any], BaseModel],
+        path: Optional[str] = None,
         skip_stdout_reset: bool = False,
     ) -> None:
         """
@@ -1511,8 +1526,8 @@ class LocalOutputWriter(OutputWriter):
 
 
 def write_local(
-    output: Output | dict[str, Any],
-    path: str | None = None,
+    output: Union[Output, dict[str, Any]],
+    path: Optional[str] = None,
     skip_stdout_reset: bool = False,
 ) -> None:
     """
@@ -1576,10 +1591,10 @@ _LOCAL_OUTPUT_WRITER = LocalOutputWriter()
 
 
 def write(
-    output: Output | dict[str, Any] | BaseModel,
-    path: str | None = None,
+    output: Union[Output, dict[str, Any], BaseModel],
+    path: Optional[str] = None,
     skip_stdout_reset: bool = False,
-    writer: OutputWriter | None = _LOCAL_OUTPUT_WRITER,
+    writer: Optional[OutputWriter] = _LOCAL_OUTPUT_WRITER,
 ) -> None:
     """
     Write the output to the specified destination.

nextmv/polling.py

@@ -19,7 +19,7 @@ import random
 import time
 from collections.abc import Callable
 from dataclasses import dataclass
-from typing import Any
+from typing import Any, Optional
 
 from nextmv.logger import log
 
@@ -121,7 +121,7 @@ class PollingOptions:
     """
     verbose: bool = False
     """Whether to log the polling strategy. This is useful for debugging."""
-    stop: Callable[[], bool] | None = None
+    stop: Optional[Callable[[], bool]] = None
     """
     Function to call to check if the polling should stop. This is useful for
     stopping the polling based on external conditions. The function should

nextmv/run.py

@@ -45,7 +45,7 @@ run_duration(start, end)
 from dataclasses import dataclass
 from datetime import datetime
 from enum import Enum
-from typing import Any
+from typing import Any, Optional, Union
 
 from pydantic import AliasChoices, Field, field_validator
 
@@ -56,7 +56,7 @@ from nextmv.output import Asset, Output, OutputFormat, Statistics
 from nextmv.status import Status, StatusV2
 
 
-def run_duration(start: datetime | float, end: datetime | float) -> int:
+def run_duration(start: Union[datetime, float], end: Union[datetime, float]) -> int:
     """
     Calculate the duration of a run in milliseconds.
 
@@ -218,7 +218,7 @@ class Format(BaseModel):
         validation_alias=AliasChoices("input", "format_input"),
     )
     """Input format for the run configuration."""
-    format_output: FormatOutput | None = Field(
+    format_output: Optional[FormatOutput] = Field(
         serialization_alias="output",
         validation_alias=AliasChoices("output", "format_output"),
         default=None,
@@ -322,15 +322,15 @@ class RunTypeConfiguration(BaseModel):
     'def-67890'
     """
 
-    run_type: RunType | None = Field(
+    run_type: Optional[RunType] = Field(
         serialization_alias="type",
         validation_alias=AliasChoices("type", "run_type"),
         default=None,
     )
     """Type of the run."""
-    definition_id: str | None = None
+    definition_id: Optional[str] = None
     """ID of the definition for the run type."""
-    reference_id: str | None = None
+    reference_id: Optional[str] = None
     """ID of the reference for the run type."""
 
     @field_validator("run_type", mode="before")
@@ -428,9 +428,9 @@ class RunInfoStatistics(BaseModel):
     status: str
     """Status of the statistics in the run."""
 
-    error: str | None = None
+    error: Optional[str] = None
     """Error message if the statistics could not be retrieved."""
-    indicators: list[StatisticsIndicator] | None = None
+    indicators: Optional[list[StatisticsIndicator]] = None
     """List of statistics indicators."""
 
 
@@ -598,31 +598,31 @@ class Run(BaseModel):
     status_v2: StatusV2
     """Status of the run."""
 
-    status: Status | None = None
+    status: Optional[Status] = None
     """Deprecated, use status_v2 instead."""
-    queuing_priority: int | None = None
+    queuing_priority: Optional[int] = None
     """Priority of the run in the queue."""
-    queuing_disabled: bool | None = None
+    queuing_disabled: Optional[bool] = None
     """Whether the run is disabled from queuing."""
-    experiment_id: str | None = None
+    experiment_id: Optional[str] = None
     """ID of the experiment associated with the run."""
-    statistics: RunInfoStatistics | None = None
+    statistics: Optional[RunInfoStatistics] = None
     """Statistics of the run."""
-    input_id: str | None = None
+    input_id: Optional[str] = None
     """ID of the input associated with the run."""
-    option_set: str | None = None
+    option_set: Optional[str] = None
     """ID of the option set associated with the run."""
-    options: dict[str, str] | None = None
+    options: Optional[dict[str, str]] = None
     """Options associated with the run."""
-    request_options: dict[str, str] | None = None
+    request_options: Optional[dict[str, str]] = None
     """Request options associated with the run."""
-    options_summary: list[OptionsSummaryItem] | None = None
+    options_summary: Optional[list[OptionsSummaryItem]] = None
     """Summary of options used in the run."""
-    scenario_id: str | None = None
+    scenario_id: Optional[str] = None
     """ID of the scenario associated with the run."""
-    repetition: int | None = None
+    repetition: Optional[int] = None
     """Repetition number of the run."""
-    input_set_id: str | None = None
+    input_set_id: Optional[str] = None
     """ID of the input set associated with the run."""
 
 
@@ -682,9 +682,9 @@ class Metadata(BaseModel):
     """Format of the input and output of the run."""
     status_v2: StatusV2
     """Status of the run."""
-    status: Status | None = None
+    status: Optional[Status] = None
     """Deprecated: use status_v2."""
-    statistics: dict[str, Any] | None = None
+    statistics: Optional[dict[str, Any]] = None
     """User defined statistics of the run."""
 
 
@@ -730,7 +730,7 @@ class SyncedRun(BaseModel):
     The ID of the remote application that the local run was synced to.
     """
 
-    instance_id: str | None = None
+    instance_id: Optional[str] = None
     """
     The instance of the remote application that the local run was synced to.
     This field is optional and may be None. If it is not specified, it
@@ -778,7 +778,7 @@ class RunInformation(BaseModel):
     """
     URL to the run in the Nextmv console.
     """
-    synced_runs: list[SyncedRun] | None = None
+    synced_runs: Optional[list[SyncedRun]] = None
     """
     List of synced runs associated with this run, if applicable. When the
     `Application.sync` method is used, this field contains the associations
@@ -907,7 +907,7 @@ class RunInformation(BaseModel):
 
         return True
 
-    def is_synced(self, app_id: str, instance_id: str | None = None) -> tuple[SyncedRun, bool]:
+    def is_synced(self, app_id: str, instance_id: Optional[str] = None) -> tuple[SyncedRun, bool]:
         """
         Check if the run has been synced to a specific application and instance.
 
@@ -965,11 +965,11 @@ class ErrorLog(BaseModel):
         Standard error. Defaults to None.
     """
 
-    error: str | None = None
+    error: Optional[str] = None
     """Error message."""
-    stdout: str | None = None
+    stdout: Optional[str] = None
     """Standard output."""
-    stderr: str | None = None
+    stderr: Optional[str] = None
     """Standard error."""
 
 
@@ -993,9 +993,9 @@ class RunResult(RunInformation):
         None.
     """
 
-    error_log: ErrorLog | None = None
+    error_log: Optional[ErrorLog] = None
     """Error log of the run. Only available if the run failed."""
-    output: dict[str, Any] | None = None
+    output: Optional[dict[str, Any]] = None
     """Output of the run. Only available if the run succeeded."""
 
 
@@ -1070,12 +1070,12 @@ class RunQueuing(BaseModel):
     True
     """
 
-    priority: int | None = None
+    priority: Optional[int] = None
     """
     Priority of the run in the queue. 1 is the highest priority, 9 is the
     lowest priority.
     """
-    disabled: bool | None = None
+    disabled: Optional[bool] = None
     """
     Whether the run should be queued, or not. If True, the run will not be
     queued. If False, the run will be queued.
@@ -1140,21 +1140,21 @@ class RunConfiguration(BaseModel):
     True
     """
 
-    execution_class: str | None = None
+    execution_class: Optional[str] = None
     """Execution class for the instance."""
-    format: Format | None = None
+    format: Optional[Format] = None
     """Format for the run configuration."""
-    run_type: RunTypeConfiguration | None = None
+    run_type: Optional[RunTypeConfiguration] = None
     """Run type configuration for the run."""
-    secrets_collection_id: str | None = None
+    secrets_collection_id: Optional[str] = None
     """ID of the secrets collection to use for the run."""
-    queuing: RunQueuing | None = None
+    queuing: Optional[RunQueuing] = None
     """Queuing configuration for the run."""
 
     def resolve(
         self,
-        input: Input | dict[str, Any] | BaseModel | str,
-        dir_path: str | None = None,
+        input: Union[Input, dict[str, Any], BaseModel, str],
+        dir_path: Optional[str] = None,
     ) -> None:
         """
         Resolves the run configuration by modifying or setting the `format`,
@@ -1271,22 +1271,22 @@ class ExternalRunResult(BaseModel):
     'Optimization failed due to invalid constraints'
     """
 
-    output_upload_id: str | None = None
+    output_upload_id: Optional[str] = None
     """ID of the output upload."""
-    error_upload_id: str | None = None
+    error_upload_id: Optional[str] = None
     """ID of the error upload."""
-    status: str | None = None
+    status: Optional[str] = None
     """Status of the run."""
-    error_message: str | None = None
+    error_message: Optional[str] = None
     """Error message of the run."""
-    execution_duration: int | None = None
+    execution_duration: Optional[int] = None
     """Duration of the run, in milliseconds."""
-    statistics_upload_id: str | None = None
+    statistics_upload_id: Optional[str] = None
     """
     ID of the statistics upload. Use this field when working with `CSV_ARCHIVE`
     or `MULTI_FILE` output formats.
     """
-    assets_upload_id: str | None = None
+    assets_upload_id: Optional[str] = None
     """
     ID of the assets upload. Use this field when working with `CSV_ARCHIVE`
     or `MULTI_FILE` output formats.
@@ -1466,37 +1466,37 @@ class TrackedRun:
     status: TrackedRunStatus
     """The status of the run being tracked"""
 
-    input: Input | dict[str, Any] | str | None = None
+    input: Optional[Union[Input, dict[str, Any], str]] = None
     """
     The input of the run being tracked. Please note that if the input
     format is JSON, then the input data must be JSON serializable. If both
     `input` and `input_dir_path` are specified, the `input` is ignored, and
     the files in the directory are used instead.
     """
-    output: Output | dict[str, Any] | str | None = None
+    output: Optional[Union[Output, dict[str, Any], str]] = None
     """
     The output of the run being tracked. Please note that if the output
     format is JSON, then the output data must be JSON serializable. If both
     `output` and `output_dir_path` are specified, the `output` is ignored, and
     the files in the directory are used instead.
     """
-    duration: int | None = None
+    duration: Optional[int] = None
     """The duration of the run being tracked, in milliseconds."""
-    error: str | None = None
+    error: Optional[str] = None
     """An error message if the run failed. You should only specify this if the
     run failed, otherwise an exception will be raised."""
-    logs: list[str] | None = None
+    logs: Optional[list[str]] = None
     """The logs of the run being tracked. Each element of the list is a line in
     the log."""
-    name: str | None = None
+    name: Optional[str] = None
     """
     Optional name for the run being tracked.
     """
-    description: str | None = None
+    description: Optional[str] = None
     """
     Optional description for the run being tracked.
     """
-    input_dir_path: str | None = None
+    input_dir_path: Optional[str] = None
     """
     Path to a directory containing input files. If specified, the calling
     function will package the files in the directory into a tar file and upload
@@ -1505,7 +1505,7 @@ class TrackedRun:
     `input_dir_path` are specified, the `input` is ignored, and the files in
     the directory are used instead.
     """
-    output_dir_path: str | None = None
+    output_dir_path: Optional[str] = None
     """
     Path to a directory containing output files. If specified, the calling
     function will package the files in the directory into a tar file and upload
@@ -1514,14 +1514,14 @@ class TrackedRun:
     `output_dir_path` are specified, the `output` is ignored, and the files
     are saved in the directory instead.
     """
-    statistics: Statistics | dict[str, Any] | None = None
+    statistics: Optional[Union[Statistics, dict[str, Any]]] = None
     """
     Statistics of the run being tracked. Only use this field if you want to
     track statistics for `CSV_ARCHIVE` or `MULTI_FILE` output formats. If you
     are working with `JSON` or `TEXT` output formats, this field will be
     ignored, as the statistics are extracted directly from the `output`.
     """
-    assets: list[Asset | dict[str, Any]] | None = None
+    assets: Optional[list[Union[Asset, dict[str, Any]]]] = None
     """
     Assets associated with the run being tracked. Only use this field if you
     want to track assets for `CSV_ARCHIVE` or `MULTI_FILE` output formats.

{nextmv-0.35.0.dist-info → nextmv-0.35.0.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 0.35.0
+Version: 0.35.0.dev0
 Summary: The all-purpose Python SDK for Nextmv
 Project-URL: Homepage, https://www.nextmv.io
 Project-URL: Documentation, https://nextmv-py.docs.nextmv.io/en/latest/nextmv/
@@ -213,11 +213,12 @@ Keywords: decision engineering,decision science,decisions,nextmv,operations rese
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.10
+Requires-Python: >=3.9
 Requires-Dist: pydantic>=2.5.2
 Requires-Dist: pyyaml>=6.0.1
 Requires-Dist: requests>=2.31.0
@@ -269,7 +270,7 @@ Welcome to `nextmv`, the general Python SDK for the Nextmv Platform.
 
 ## Installation
 
-Requires Python `>=3.10`. Install using `pip`:
+Requires Python `>=3.9`. Install using `pip`:
 
 ```bash
 pip install nextmv