nextmv 0.28.1.dev0__tar.gz → 0.28.3.dev0__tar.gz

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 0.28.1.dev0
+Version: 0.28.3.dev0
 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.28.3.dev0/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v0.28.3.dev0"

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/cloud/application.py

@@ -66,6 +66,7 @@ from nextmv.logger import log
 from nextmv.model import Model, ModelConfiguration
 from nextmv.options import Options
 from nextmv.output import Output
+from nextmv.serialization import serialize_json
 
 # Maximum size of the run input/output in bytes. This constant defines the
 # maximum allowed size for run inputs and outputs. When the size exceeds this
@@ -1588,7 +1589,7 @@ class Application:
                     if isinstance(v, str):
                         options_dict[k] = v
                     else:
-                        options_dict[k] = json.dumps(v)
+                        options_dict[k] = serialize_json(v)
 
         payload = {}
         if upload_id_used:
@@ -2830,7 +2831,7 @@ class Application:
         """
 
         if isinstance(input, dict):
-            input = json.dumps(input)
+            input = serialize_json(input)
 
         self.client.upload_to_presigned_url(
             url=upload_url.upload_url,

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/cloud/client.py

@@ -14,7 +14,6 @@ get_size(obj)
     Finds the size of an object in bytes.
 """
 
-import json
 import os
 from dataclasses import dataclass, field
 from typing import IO, Any, Optional, Union
@@ -24,6 +23,8 @@ import requests
 import yaml
 from requests.adapters import HTTPAdapter, Retry
 
+from nextmv.serialization import serialize_json
+
 _MAX_LAMBDA_PAYLOAD_SIZE: int = 500 * 1024 * 1024
 """int: Maximum size of the payload handled by the Nextmv Cloud API.
 
@@ -293,7 +294,11 @@ class Client:
         if data is not None:
             kwargs["data"] = data
         if payload is not None:
-            kwargs["json"] = payload
+            if isinstance(payload, (dict, list)):
+                data = serialize_json(payload)
+                kwargs["data"] = data
+            else:
+                raise ValueError("payload must be a dictionary or a list")
         if query_params is not None:
             kwargs["params"] = query_params
 
@@ -341,7 +346,7 @@ class Client:
 
         upload_data: Optional[str] = None
         if isinstance(data, dict):
-            upload_data = json.dumps(data, separators=(",", ":"))
+            upload_data = serialize_json(data)
         elif isinstance(data, str):
             upload_data = data
         else:
@@ -436,7 +441,7 @@ def get_size(obj: Union[dict[str, Any], IO[bytes], str]) -> int:
     """
 
     if isinstance(obj, dict):
-        obj_str = json.dumps(obj, separators=(",", ":"))
+        obj_str = serialize_json(obj)
         return len(obj_str.encode("utf-8"))
 
     elif hasattr(obj, "read"):

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/cloud/manifest.py

@@ -33,7 +33,7 @@ FILE_NAME
 
 import os
 from enum import Enum
-from typing import Any, Optional
+from typing import Any, Optional, Union
 
 import yaml
 from pydantic import AliasChoices, Field
@@ -282,7 +282,9 @@ class ManifestPython(BaseModel):
     ----------
     pip_requirements : Optional[str], default=None
         Path to a requirements.txt file containing (additional) Python
-        dependencies that will be bundled with the app.
+        dependencies that will be bundled with the app. Alternatively, you can provide a
+        list of strings, each representing a package to install, e.g.,
+        `["nextmv==0.28.2", "ortools==9.12.4544"]`.
         Aliases: `pip-requirements`.
     model : Optional[ManifestPythonModel], default=None
         Information about an encoded decision model as handled via mlflow. This
@@ -299,7 +301,7 @@ class ManifestPython(BaseModel):
     'requirements.txt'
     """
 
-    pip_requirements: Optional[str] = Field(
+    pip_requirements: Optional[Union[str, list[str]]] = Field(
         serialization_alias="pip-requirements",
         validation_alias=AliasChoices("pip-requirements", "pip_requirements"),
         default=None,

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/cloud/package.py

@@ -233,11 +233,25 @@ def __install_dependencies(
         return
 
     pip_requirements = manifest.python.pip_requirements
+
     if pip_requirements is None or pip_requirements == "":
+        # If no pip requirements are specified, we do not install any dependencies.
         return
 
-    if not os.path.isfile(os.path.join(app_dir, pip_requirements)):
-        raise FileNotFoundError(f"pip requirements file '{pip_requirements}' not found in '{app_dir}'")
+    if isinstance(pip_requirements, list):
+        # If pip_requirements is a list, we write it to a temporary file so that we can
+        # pass it to pip.
+        pip_requirements_file = os.path.join(temp_dir, "requirements.txt")
+        with open(pip_requirements_file, "w") as f:
+            for requirement in pip_requirements:
+                f.write(requirement + "\n")
+        pip_requirements = pip_requirements_file
+    elif isinstance(pip_requirements, str):
+        # If pip_requirements is a string, we expect it to be a file path to a
+        # requirements file.
+        pip_requirements = pip_requirements.strip()
+        if not os.path.isfile(os.path.join(app_dir, pip_requirements)):
+            raise FileNotFoundError(f"pip requirements file '{pip_requirements}' not found in '{app_dir}'")
 
     py_cmd = __get_python_command()
     dep_dir = os.path.join(".nextmv", "python", "deps")

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/cloud/run.py

@@ -39,7 +39,6 @@ run_duration(start, end)
     Calculate the duration of a run in milliseconds.
 """
 
-import json
 from dataclasses import dataclass
 from datetime import datetime
 from enum import Enum
@@ -51,6 +50,7 @@ from nextmv.base_model import BaseModel
 from nextmv.cloud.status import Status, StatusV2
 from nextmv.input import Input, InputFormat
 from nextmv.output import Output, OutputFormat
+from nextmv.serialization import serialize_json
 
 
 def run_duration(start: Union[datetime, float], end: Union[datetime, float]) -> int:
@@ -628,7 +628,7 @@ class TrackedRun:
                 raise ValueError("Input.input_format must be JSON.")
         elif isinstance(self.input, dict):
             try:
-                _ = json.dumps(self.input)
+                _ = serialize_json(self.input)
             except (TypeError, OverflowError) as e:
                 raise ValueError("Input is dict[str, Any] but it is not JSON serializable") from e
 
@@ -637,7 +637,7 @@ class TrackedRun:
                 raise ValueError("Output.output_format must be JSON.")
         elif isinstance(self.output, dict):
             try:
-                _ = json.dumps(self.output)
+                _ = serialize_json(self.output)
             except (TypeError, OverflowError) as e:
                 raise ValueError("Output is dict[str, Any] but it is not JSON serializable") from e
 

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/input.py

@@ -33,6 +33,7 @@ from typing import Any, Optional, Union
 
 from nextmv.deprecated import deprecated
 from nextmv.options import Options
+from nextmv.serialization import serialize_json
 
 
 class InputFormat(str, Enum):
@@ -139,7 +140,7 @@ class Input:
 
         if self.input_format == InputFormat.JSON:
             try:
-                _ = json.dumps(self.data)
+                _ = serialize_json(self.data)
             except (TypeError, OverflowError) as e:
                 raise ValueError(
                     f"Input has input_format InputFormat.JSON and "

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/options.py

@@ -575,7 +575,7 @@ class Options:
 
         self._parse()
 
-    def merge(self, new: "Options") -> "Options":
+    def merge(self, *new: "Options", skip_parse: bool = False) -> "Options":
         """
         Merges the current options with the new options.
 
@@ -587,7 +587,11 @@ class Options:
         Parameters
         ----------
         new : Options
-            The new options to merge with the current options.
+            The new options to merge with the current options. At least one new option set
+            is required to merge. Multiple `Options` instances can be passed.
+        skip_parse : bool, optional
+            If True, the merged options will not be parsed after merging. This is useful
+            if you want to merge further options after this merge. The default is False.
 
         Returns
         -------
@@ -605,11 +609,14 @@ class Options:
         --------
         >>> opt1 = Options(Option("duration", str, "30s"))
         >>> opt2 = Options(Option("threads", int, 4))
-        >>> merged = opt1.merge(opt2)
+        >>> opt3 = Options(Option("verbose", bool, False))
+        >>> merged = opt1.merge(opt2, opt3)
         >>> merged.duration
         '30s'
         >>> merged.threads
         4
+        >>> merged.verbose
+        False
         """
 
         if self.PARSED:
@@ -617,14 +624,24 @@ class Options:
                 "base options have already been parsed, cannot merge. See `Options.parse()` for more information."
             )
 
-        if new.PARSED:
-            raise RuntimeError(
-                "new options have already been parsed, cannot merge. See `Options.parse()` for more information."
-            )
+        if not new:
+            raise ValueError("at least one new Options instance is required to merge")
 
-        self.options += new.options
+        for i, opt in enumerate(new):
+            if not isinstance(opt, Options):
+                raise TypeError(f"expected an <Options> object, but got {type(opt)} in index {i}")
+            if opt.PARSED:
+                raise RuntimeError(
+                    f"new options at index {i} have already been parsed, cannot merge. "
+                    + "See `Options.parse()` for more information."
+                )
 
-        self._parse()
+        # Add the new options to the current options.
+        for n in new:
+            self.options += n.options
+
+        if not skip_parse:
+            self.parse()
 
         return self
 

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/nextmv/output.py

@@ -42,8 +42,6 @@ write
 
 import copy
 import csv
-import datetime
-import json
 import os
 import sys
 from dataclasses import dataclass
@@ -56,6 +54,7 @@ from nextmv.base_model import BaseModel
 from nextmv.deprecated import deprecated
 from nextmv.logger import reset_stdout
 from nextmv.options import Options
+from nextmv.serialization import serialize_json
 
 
 class RunStatistics(BaseModel):
@@ -644,7 +643,7 @@ class Output:
 
         if self.output_format == OutputFormat.JSON:
             try:
-                _ = json.dumps(self.solution, default=_custom_serial)
+                _ = serialize_json(self.solution)
             except (TypeError, OverflowError) as e:
                 raise ValueError(
                     f"Output has output_format OutputFormat.JSON and "
@@ -722,12 +721,6 @@ class Output:
             and self.csv_configurations != {}
         ):
             output_dict["csv_configurations"] = self.csv_configurations
-        elif (
-            self.output_format == OutputFormat.JSON
-            and self.json_configurations is not None
-            and self.json_configurations != {}
-        ):
-            output_dict["json_configurations"] = self.json_configurations
 
         return output_dict
 
@@ -822,19 +815,9 @@ class LocalOutputWriter(OutputWriter):
         if hasattr(output, "json_configurations") and output.json_configurations is not None:
             json_configurations = output.json_configurations
 
-        indent, custom_serial = 2, _custom_serial
-        if "indent" in json_configurations:
-            indent = json_configurations["indent"]
-            del json_configurations["indent"]
-        if "default" in json_configurations:
-            custom_serial = json_configurations["default"]
-            del json_configurations["default"]
-
-        serialized = json.dumps(
+        serialized = serialize_json(
             output_dict,
-            indent=indent,
-            default=custom_serial,
-            **json_configurations,
+            json_configurations=json_configurations,
         )
 
         if path is None or path == "":
@@ -877,13 +860,17 @@ class LocalOutputWriter(OutputWriter):
         if not os.path.exists(dir_path):
             os.makedirs(dir_path)
 
-        serialized = json.dumps(
+        json_configurations = {}
+        if hasattr(output, "json_configurations") and output.json_configurations is not None:
+            json_configurations = output.json_configurations
+
+        serialized = serialize_json(
             {
                 "options": output_dict.get("options", {}),
                 "statistics": output_dict.get("statistics", {}),
                 "assets": output_dict.get("assets", []),
             },
-            indent=2,
+            json_configurations=json_configurations,
         )
         print(serialized, file=sys.stdout)
 
@@ -1118,32 +1105,3 @@ def write(
     """
 
     writer.write(output, path, skip_stdout_reset)
-
-
-def _custom_serial(obj: Any) -> str:
-    """
-    JSON serializer for objects not serializable by default json serializer.
-
-    This function provides custom serialization for datetime objects, converting
-    them to ISO format strings.
-
-    Parameters
-    ----------
-    obj : Any
-        The object to serialize.
-
-    Returns
-    -------
-    str
-        The serialized representation of the object.
-
-    Raises
-    ------
-    TypeError
-        If the object type is not supported for serialization.
-    """
-
-    if isinstance(obj, (datetime.datetime | datetime.date)):
-        return obj.isoformat()
-
-    raise TypeError(f"Type {type(obj)} not serializable")

nextmv-0.28.3.dev0/nextmv/serialization.py

@@ -0,0 +1,67 @@
+import datetime
+import json
+from typing import Any, Union
+
+
+def serialize_json(
+    obj: Union[dict, list],
+    json_configurations: dict[str, Any] = None,
+) -> str:
+    """
+    Serialize a Python object (dict or list) to a JSON string.
+
+    Parameters
+    ----------
+    obj : Union[dict, list]
+        The Python object to serialize.
+    json_configurations : dict, optional
+        Additional configurations for JSON serialization. This allows customization
+        of the Python `json.dumps` function. You can specify parameters like `indent`
+        for pretty printing or `default` for custom serialization functions.
+
+    Returns
+    -------
+    str
+        A JSON string representation of the object.
+    """
+
+    # Apply some default configuration if not provided
+    json_configurations = json_configurations or {}
+    if "default" not in json_configurations:
+        json_configurations["default"] = _custom_serial
+    if "separators" not in json_configurations:
+        json_configurations["separators"] = (",", ":")
+
+    return json.dumps(
+        obj,
+        **json_configurations,
+    )
+
+
+def _custom_serial(obj: Any) -> str:
+    """
+    JSON serializer for objects not serializable by default json serializer.
+
+    This function provides custom serialization for datetime objects, converting
+    them to ISO format strings.
+
+    Parameters
+    ----------
+    obj : Any
+        The object to serialize.
+
+    Returns
+    -------
+    str
+        The serialized representation of the object.
+
+    Raises
+    ------
+    TypeError
+        If the object type is not supported for serialization.
+    """
+
+    if isinstance(obj, (datetime.datetime, datetime.date)):
+        return obj.isoformat()
+
+    raise TypeError(f"Type {type(obj)} not serializable")

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/tests/test_options.py

@@ -588,6 +588,69 @@ class TestParameter(unittest.TestCase):
         self.assertEqual(opt.foo2, 3)
         self.assertEqual(opt.bar2, 4)
 
+    def test_merge_lazy(self):
+        opt1 = nextmv.Options(
+            nextmv.Parameter("foo1", int, default=1),
+            nextmv.Parameter("bar1", int, default=2),
+        )
+        self.assertFalse(opt1.PARSED)
+
+        opt2 = nextmv.Options(
+            nextmv.Parameter("foo2", int, default=3),
+            nextmv.Parameter("bar2", int, default=4),
+        )
+        self.assertFalse(opt2.PARSED)
+
+        opt3 = nextmv.Options(
+            nextmv.Parameter("foo3", int, default=5),
+            nextmv.Parameter("bar3", int, default=6),
+        )
+        self.assertFalse(opt3.PARSED)
+
+        opt = opt1.merge(opt2, skip_parse=True)
+        self.assertFalse(opt.PARSED)
+
+        opt = opt.merge(opt3, skip_parse=True)
+        self.assertFalse(opt.PARSED)
+
+        opt.parse()
+        self.assertTrue(opt.PARSED)
+
+        self.assertEqual(opt.foo1, 1)
+        self.assertEqual(opt.bar1, 2)
+        self.assertEqual(opt.foo2, 3)
+        self.assertEqual(opt.bar2, 4)
+        self.assertEqual(opt.foo3, 5)
+        self.assertEqual(opt.bar3, 6)
+
+    def test_merge_multi(self):
+        opt1 = nextmv.Options(
+            nextmv.Parameter("foo1", int, default=1),
+            nextmv.Parameter("bar1", int, default=2),
+        )
+        self.assertFalse(opt1.PARSED)
+
+        opt2 = nextmv.Options(
+            nextmv.Parameter("foo2", int, default=3),
+            nextmv.Parameter("bar2", int, default=4),
+        )
+        self.assertFalse(opt2.PARSED)
+
+        opt3 = nextmv.Options(
+            nextmv.Parameter("foo3", int, default=5),
+            nextmv.Parameter("bar3", int, default=6),
+        )
+        self.assertFalse(opt3.PARSED)
+
+        opt1.merge(opt2, opt3)
+        self.assertTrue(opt1.PARSED)
+        self.assertEqual(opt1.foo1, 1)
+        self.assertEqual(opt1.bar1, 2)
+        self.assertEqual(opt1.foo2, 3)
+        self.assertEqual(opt1.bar2, 4)
+        self.assertEqual(opt1.foo3, 5)
+        self.assertEqual(opt1.bar3, 6)
+
     def test_cant_merge(self):
         opt1 = nextmv.Options(
             nextmv.Parameter("foo1", int, default=1),

{nextmv-0.28.1.dev0 → nextmv-0.28.3.dev0}/tests/test_output.py

@@ -118,13 +118,6 @@ class TestOutput(unittest.TestCase):
         result = output.to_dict()
         self.assertEqual(result["assets"][0]["name"], "asset3")
 
-        # Test with JSON configurations
-        json_config = {"indent": 4, "sort_keys": True}
-        output = nextmv.Output(output_format=nextmv.OutputFormat.JSON, json_configurations=json_config)
-        result = output.to_dict()
-        self.assertEqual(result["json_configurations"]["indent"], 4)
-        self.assertEqual(result["json_configurations"]["sort_keys"], True)
-
         # Test with CSV configurations
         csv_config = {"delimiter": ";", "quoting": csv.QUOTE_NONNUMERIC}
         output = nextmv.Output(output_format=nextmv.OutputFormat.CSV_ARCHIVE, csv_configurations=csv_config)
@@ -183,7 +176,6 @@ class TestOutput(unittest.TestCase):
         self.assertEqual(result["assets"][0]["name"], "asset1")
         self.assertEqual(result["assets"][0]["visual"]["schema"], "chartjs")
         self.assertEqual(result["solution"]["value"], 42)
-        self.assertEqual(result["json_configurations"]["indent"], 4)
 
     def test_local_writer_json_stdout_default(self):
         output = nextmv.Output(
@@ -262,7 +254,7 @@ class TestOutput(unittest.TestCase):
 
             self.assertEqual(
                 mock_stdout.getvalue(),
-                '{"assets":[],"json_configurations":{"separators":[",",":"],"sort_keys":true},"options":{},"solution":{"empanadas":"are_life"},"statistics":{"foo":"bar"}}\n',
+                '{"assets":[],"options":{},"solution":{"empanadas":"are_life"},"statistics":{"foo":"bar"}}\n',
             )
 
     def test_local_writer_json_stdout_with_options(self):

nextmv-0.28.3.dev0/tests/test_serialization.py

@@ -0,0 +1,53 @@
+import datetime
+import json
+import unittest
+
+import nextmv.serialization
+
+
+class TestSerialization(unittest.TestCase):
+    """Tests for the common serialization functionality."""
+
+    def test_default_serialization(self):
+        """Test the default serialization"""
+
+        data = {
+            "name": "Test",
+            "value": 42,
+            "timestamp": nextmv.serialization._custom_serial(datetime.datetime(2023, 10, 1)),
+        }
+        serialized = nextmv.serialization.serialize_json(data)
+        expected = json.dumps(
+            {
+                "name": "Test",
+                "value": 42,
+                "timestamp": "2023-10-01T00:00:00",
+            },
+            separators=(",", ":"),
+        )
+        self.assertEqual(serialized, expected)
+
+    def test_custom_serialization(self):
+        """Test custom serialization with additional configurations"""
+
+        data = {
+            "name": "Test",
+            "value": 42,
+            "timestamp": nextmv.serialization._custom_serial(datetime.datetime(2023, 10, 1)),
+        }
+        json_configurations = {
+            "indent": 2,
+            "default": nextmv.serialization._custom_serial,
+            "separators": (",", ": "),
+        }
+        serialized = nextmv.serialization.serialize_json(data, json_configurations)
+        expected = json.dumps(
+            {
+                "name": "Test",
+                "value": 42,
+                "timestamp": "2023-10-01T00:00:00",
+            },
+            indent=2,
+            separators=(",", ": "),
+        )
+        self.assertEqual(serialized, expected)

nextmv-0.28.1.dev0/nextmv/__about__.py

@@ -1 +0,0 @@
-__version__ = "v0.28.1.dev0"