nextmv 0.34.0.dev3__tar.gz → 0.34.1.dev1__tar.gz

{nextmv-0.34.0.dev3 → nextmv-0.34.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 0.34.0.dev3
+Version: 0.34.1.dev1
 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/

nextmv-0.34.1.dev1/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v0.34.1.dev1"

{nextmv-0.34.0.dev3 → nextmv-0.34.1.dev1}/nextmv/local/application.py

@@ -892,9 +892,6 @@ class Application:
         Auxiliary function to validate the directory path and configuration.
         """
 
-        if input_dir_path is None or input_dir_path == "":
-            return
-
         if configuration is None:
             if self.manifest.configuration is not None and self.manifest.configuration.content is not None:
                 configuration = RunConfiguration(
@@ -904,18 +901,21 @@ class Application:
                         ),
                     ),
                 )
-            else:
-                raise ValueError(
-                    "If `dir_path` is provided, either a `RunConfiguration` must also be provided or "
-                    "the application's manifest (app.yaml) must include the format under "
-                    "`configuration.content.format`.",
-                )
-
-        # Forcefully turn the configuration into a RunConfiguration object to
-        # make it easier to deal with in the other functions.
-        if isinstance(configuration, dict):
+        elif isinstance(configuration, dict):
+            # Forcefully turn the configuration into a RunConfiguration object to
+            # make it easier to deal with in the other functions.
             configuration = RunConfiguration.from_dict(configuration)
 
+        if input_dir_path is None or input_dir_path == "":
+            return configuration
+
+        if configuration is None:
+            raise ValueError(
+                "If `dir_path` is provided, either a `RunConfiguration` must also be provided or "
+                "the application's manifest (app.yaml) must include the format under "
+                "`configuration.content.format`.",
+            )
+
         config_format = configuration.format
         if config_format is None:
             raise ValueError(

{nextmv-0.34.0.dev3 → nextmv-0.34.1.dev1}/nextmv/manifest.py

@@ -11,6 +11,8 @@ ManifestType
     Enum for application types based on programming language.
 ManifestRuntime
     Enum for runtime environments where apps run on Nextmv.
+ManifestPythonArch
+    Enum for target architecture for bundling Python apps.
 ManifestBuild
     Class for build-specific attributes in the manifest.
 ManifestPythonModel
@@ -38,6 +40,11 @@ ManifestConfiguration
 Manifest
     Main class representing an app manifest for Nextmv.
 
+Functions
+---------
+default_python_manifest
+    Creates a default Python manifest as a starting point for applications.
+
 Constants
 --------
 MANIFEST_FILE_NAME
@@ -331,7 +338,7 @@ class ManifestPython(BaseModel):
 
     Parameters
     ----------
-    pip_requirements : Optional[str], default=None
+    pip_requirements : Optional[Union[str, list[str]]], default=None
         Path to a requirements.txt file containing (additional) Python
         dependencies that will be bundled with the app. Alternatively, you can provide a
         list of strings, each representing a package to install, e.g.,
@@ -358,10 +365,11 @@ class ManifestPython(BaseModel):
         default=None,
     )
     """
-    Path to a requirements.txt file.
+    Path to a requirements.txt file or list of packages.
 
     Contains (additional) Python dependencies that will be bundled with the
-    app.
+    app. Can be either a string path to a requirements.txt file or a list
+    of package specifications.
     """
     arch: Optional[ManifestPythonArch] = None
     """
@@ -383,6 +391,31 @@ class ManifestPython(BaseModel):
     @field_validator("version", mode="before")
     @classmethod
     def validate_version(cls, v: Optional[Union[str, float]]) -> Optional[str]:
+        """
+        Validate and convert the Python version field to a string.
+
+        This validator allows the version to be specified as either a float or string
+        in the manifest for convenience, but ensures it's stored internally as a string.
+
+        Parameters
+        ----------
+        v : Optional[Union[str, float]]
+            The version value to validate. Can be None, a string, or a float.
+
+        Returns
+        -------
+        Optional[str]
+            The version as a string, or None if the input was None.
+
+        Examples
+        --------
+        >>> ManifestPython.validate_version(3.11)
+        '3.11'
+        >>> ManifestPython.validate_version("3.11")
+        '3.11'
+        >>> ManifestPython.validate_version(None) is None
+        True
+        """
         # We allow the version to be a float in the manifest for convenience, but we want
         # to store it as a string internally.
         if v is None:
@@ -917,7 +950,23 @@ class ManifestContent(BaseModel):
     """Configuration for multi-file content format."""
 
     def model_post_init(self, __context) -> None:
-        """Post-initialization to validate fields."""
+        """
+        Post-initialization validation to ensure format field contains valid values.
+
+        This method is automatically called by Pydantic after the model is initialized
+        to validate that the format field contains one of the acceptable values.
+
+        Parameters
+        ----------
+        __context : Any
+            Pydantic context (unused in this implementation).
+
+        Raises
+        ------
+        ValueError
+            If the format field contains an invalid value that is not one of the
+            acceptable formats (JSON, MULTI_FILE, or CSV_ARCHIVE).
+        """
         acceptable_formats = [InputFormat.JSON, InputFormat.MULTI_FILE, InputFormat.CSV_ARCHIVE]
         if self.format not in acceptable_formats:
             raise ValueError(f"Invalid format: {self.format}. Must be one of {acceptable_formats}.")
@@ -1084,6 +1133,26 @@ class Manifest(BaseModel):
     """
 
     def model_post_init(self, __context) -> None:
+        """
+        Post-initialization to set default entrypoint based on runtime if not specified.
+
+        This method is automatically called by Pydantic after the model is initialized.
+        If no entrypoint is provided, it sets a default entrypoint based on the runtime:
+        - Python runtimes (PYTHON, HEXALY, PYOMO, CUOPT): "./main.py"
+        - DEFAULT runtime: "./main"
+        - JAVA runtime: "./main.jar"
+
+        Parameters
+        ----------
+        __context : Any
+            Pydantic context (unused in this implementation).
+
+        Raises
+        ------
+        ValueError
+            If no entrypoint is provided and the runtime cannot be resolved to
+            establish a default entrypoint.
+        """
         if self.entrypoint is None:
             if self.runtime in (
                 ManifestRuntime.PYTHON,

{nextmv-0.34.0.dev3 → nextmv-0.34.1.dev1}/nextmv/run.py

@@ -682,9 +682,10 @@ class Metadata(BaseModel):
     """Format of the input and output of the run."""
     status_v2: StatusV2
     """Status of the run."""
-
     status: Optional[Status] = None
     """Deprecated: use status_v2."""
+    statistics: Optional[dict[str, Any]] = None
+    """User defined statistics of the run."""
 
 
 class SyncedRun(BaseModel):
@@ -1560,9 +1561,9 @@ class TrackedRun:
 
         if isinstance(self.output, Output):
             try:
-                _ = serialize_json(self.output.data)
+                _ = serialize_json(self.output.solution)
             except (TypeError, OverflowError) as e:
-                raise ValueError("Output.data is not JSON serializable") from e
+                raise ValueError("`Output.solution` is not JSON serializable") from e
         elif isinstance(self.output, dict):
             try:
                 _ = serialize_json(self.output)

{nextmv-0.34.0.dev3 → nextmv-0.34.1.dev1}/tests/local/test_executor.py

@@ -274,11 +274,11 @@ class TestLocalExecutor(unittest.TestCase):
         logs_dir = os.path.join(self.run_dir, "logs")
         self.assertTrue(os.path.exists(logs_dir))
 
-        # Check that stderr.log was created with correct content
-        stderr_file = os.path.join(logs_dir, "stderr.log")
-        self.assertTrue(os.path.exists(stderr_file))
+        # Check that logs.log was created with correct content
+        logs_file = os.path.join(logs_dir, "logs.log")
+        self.assertTrue(os.path.exists(logs_file))
 
-        with open(stderr_file) as f:
+        with open(logs_file) as f:
             content = f.read()
 
         self.assertEqual(content, "Error line 1\nError line 2\n")
@@ -299,7 +299,12 @@ class TestLocalExecutor(unittest.TestCase):
         stdout_output = {}
 
         process_run_statistics(
-            temp_outputs_dir, outputs_dir, stdout_output, temp_src=self.temp_src, manifest=self.mock_manifest
+            temp_outputs_dir,
+            outputs_dir,
+            stdout_output,
+            temp_src=self.temp_src,
+            manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that statistics directory was copied
@@ -316,7 +321,12 @@ class TestLocalExecutor(unittest.TestCase):
         stdout_output = {STATISTICS_KEY: {"duration": 2.5, "iterations": 100}}
 
         process_run_statistics(
-            temp_outputs_dir, outputs_dir, stdout_output, temp_src=self.temp_src, manifest=self.mock_manifest
+            temp_outputs_dir,
+            outputs_dir,
+            stdout_output,
+            temp_src=self.temp_src,
+            manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that statistics.json was created
@@ -341,7 +351,12 @@ class TestLocalExecutor(unittest.TestCase):
         stdout_output = {}
 
         process_run_statistics(
-            temp_outputs_dir, outputs_dir, stdout_output, temp_src=self.temp_src, manifest=self.mock_manifest
+            temp_outputs_dir,
+            outputs_dir,
+            stdout_output,
+            temp_src=self.temp_src,
+            manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that statistics directory was not created
@@ -364,7 +379,12 @@ class TestLocalExecutor(unittest.TestCase):
         stdout_output = {}
 
         process_run_assets(
-            temp_outputs_dir, outputs_dir, stdout_output, temp_src=self.temp_src, manifest=self.mock_manifest
+            temp_outputs_dir,
+            outputs_dir,
+            stdout_output,
+            temp_src=self.temp_src,
+            manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that assets directory was copied
@@ -386,7 +406,12 @@ class TestLocalExecutor(unittest.TestCase):
         }
 
         process_run_assets(
-            temp_outputs_dir, outputs_dir, stdout_output, temp_src=self.temp_src, manifest=self.mock_manifest
+            temp_outputs_dir,
+            outputs_dir,
+            stdout_output,
+            temp_src=self.temp_src,
+            manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that assets.json was created
@@ -429,6 +454,7 @@ class TestLocalExecutor(unittest.TestCase):
             stdout_output,
             output_format=OutputFormat.CSV_ARCHIVE,
             manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that solutions directory was created and files copied
@@ -463,6 +489,7 @@ class TestLocalExecutor(unittest.TestCase):
             stdout_output,
             output_format=OutputFormat.MULTI_FILE,
             manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that solutions directory was created and files copied
@@ -490,6 +517,7 @@ class TestLocalExecutor(unittest.TestCase):
             stdout_output,
             output_format=self.mock_output_format,
             manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that solution.json was created
@@ -524,6 +552,7 @@ class TestLocalExecutor(unittest.TestCase):
             stdout_output,
             output_format=self.mock_output_format,
             manifest=self.mock_manifest,
+            src=self.test_dir,
         )
 
         # Check that solutions directory was created
@@ -609,6 +638,7 @@ class TestLocalExecutor(unittest.TestCase):
             temp_src=temp_src,
             result=mock_result,
             run_dir="/test/run_dir",
+            src="/test/src",
         )
 
     def test_process_run_output_with_valid_json(self):
@@ -636,6 +666,7 @@ class TestLocalExecutor(unittest.TestCase):
                 temp_src=self.temp_src,
                 result=mock_result,
                 run_dir=self.run_dir,
+                src=self.test_dir,
             )
 
             # Verify all processing functions were called
@@ -674,11 +705,12 @@ class TestLocalExecutor(unittest.TestCase):
                 temp_src=self.temp_src,
                 result=mock_result,
                 run_dir=self.run_dir,
+                src=self.test_dir,
             )
 
-            # Verify all processing functions were called with empty dict
+            # Verify all processing functions were called with empty string
             mock_logs.assert_called_once_with(
-                output_format=unittest.mock.ANY, run_dir=self.run_dir, result=mock_result, stdout_output={}
+                output_format=unittest.mock.ANY, run_dir=self.run_dir, result=mock_result, stdout_output=""
             )
             mock_stats.assert_called_once()
             mock_assets.assert_called_once()
@@ -686,7 +718,7 @@ class TestLocalExecutor(unittest.TestCase):
 
             # Get the stdout_output that was passed to the functions
             stdout_output = mock_stats.call_args.kwargs["stdout_output"]
-            self.assertEqual(stdout_output, {})
+            self.assertEqual(stdout_output, "")
 
 
 if __name__ == "__main__":

nextmv-0.34.0.dev3/nextmv/__about__.py

@@ -1 +0,0 @@
-__version__ = "v0.34.0.dev3"