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

nextmv/model.py

@@ -18,8 +18,6 @@ deployed to Nextmv Cloud for execution.
 import logging
 import os
 import shutil
-import sqlite3
-import time
 import warnings
 from dataclasses import dataclass
 from typing import Any
@@ -86,9 +84,6 @@ def _custom_showwarning(message, category, filename, lineno, file=None, line=Non
     if "mlflow/pyfunc/__init__.py" in filename:
         return
 
-    if "/mlflow/tracing/provider.py" in filename:
-        return
-
     _original_showwarning(message, category, filename, lineno, file, line)
 
 
@@ -293,6 +288,7 @@ class Model:
             ) from e
 
         finally:
+            from mlflow.models import infer_signature
             from mlflow.pyfunc import PythonModel, save_model
 
         class MLFlowModel(PythonModel):
@@ -346,16 +342,12 @@ class Model:
 
         _cleanup_python_model(model_dir, configuration, verbose=False)
 
-        # Removing this seems to make the "apps from models" experience once
-        # again. I am not removing it entirely because we might want to
-        # re-introduce it later on.
-        # signature = None
-        # if configuration.options is not None:
-        #     options_dict = configuration.options.to_dict()
-        #     signature = infer_signature(
-        #         model_input={},
-        #         params=options_dict,
-        #     )
+        signature = None
+        if configuration.options is not None:
+            options_dict = configuration.options.to_dict()
+            signature = infer_signature(
+                params=options_dict,
+            )
 
         # We use mlflow to save the model to the local filesystem, to be able to
         # load it later on.
@@ -364,7 +356,7 @@ class Model:
             path=model_path,  # Customize the name of the model location.
             infer_code_paths=True,  # Makes the imports portable.
             python_model=MLFlowModel(),
-            # signature=signature,  # Please see comment above about keeping this in case we need to go back.
+            signature=signature,  # Allows us to work with our own `Options` class.
         )
 
         # Create an auxiliary requirements file with the model dependencies.
@@ -423,7 +415,9 @@ def _cleanup_python_model(
     if os.path.exists(model_path):
         shutil.rmtree(model_path)
 
-    _cleanup_mlflow_db(model_dir)
+    mlruns_path = os.path.join(model_dir, "mlruns")
+    if os.path.exists(mlruns_path):
+        shutil.rmtree(mlruns_path)
 
     requirements_file = os.path.join(model_dir, _REQUIREMENTS_FILE)
     if os.path.exists(requirements_file):
@@ -435,36 +429,3 @@ def _cleanup_python_model(
 
     if verbose:
         log("🧹 Cleaned up Python model artifacts.")
-
-
-def _cleanup_mlflow_db(model_dir: str) -> None:
-    """
-    Clean up the mlflow.db file created during model packaging.
-
-    Parameters
-    ----------
-    model_dir : str
-        The directory where the model was saved.
-    """
-    mlflow_db_path = os.path.join(model_dir, "mlflow.db")
-    if not os.path.exists(mlflow_db_path):
-        return
-
-    # Try to close any open SQLite connections and retry deletion
-    max_retries = 5
-    for attempt in range(max_retries):
-        try:
-            # Attempt to connect and close to release any locks
-            try:
-                conn = sqlite3.connect(mlflow_db_path)
-                conn.close()
-            except Exception:
-                pass
-            os.remove(mlflow_db_path)
-            break
-        except PermissionError:
-            if attempt < max_retries - 1:
-                time.sleep(0.5)
-            else:
-                log(f"Could not delete {mlflow_db_path} after {max_retries} retries due to file lock.")
-                break

nextmv/options.py

@@ -24,6 +24,155 @@ from dataclasses import dataclass
 from typing import Any
 
 from nextmv.base_model import BaseModel
+from nextmv.deprecated import deprecated
+
+
+@dataclass
+class Parameter:
+    """
+    !!! warning
+        `Parameter` is deprecated, use `Option` instead.
+
+    Parameter that is used in a `Configuration`. When a parameter is required,
+    it is a good practice to provide a default value for it. This is because
+    the configuration will raise an error if a required parameter is not
+    provided through a command-line argument, an environment variable or a
+    default value.
+
+    Parameters
+    ----------
+    name : str
+        The name of the parameter.
+
+    param_type : type
+        The type of the parameter.
+
+    default : Any, optional
+        The default value of the parameter. Even though this is optional, it is
+        recommended to provide a default value for all parameters.
+
+    description : str, optional
+        An optional description of the parameter. This is useful for generating
+        help messages for the configuration.
+
+    required : bool, optional
+        Whether the parameter is required. If a parameter is required, it will
+        be an error to not provide a value for it, either through a command-line
+        argument, an environment variable or a default value.
+
+    choices : list[Optional[Any]], optional
+        Limits values to a specific set of choices.
+
+    Examples
+    --------
+    >>> from nextmv.options import Parameter
+    >>> parameter = Parameter("timeout", int, 60, "The maximum timeout in seconds", required=True)
+    """
+
+    name: str
+    """The name of the parameter."""
+    param_type: type
+    """The type of the parameter."""
+
+    default: Any | None = None
+    """The default value of the parameter. Even though this is optional, it is
+    recommended to provide a default value for all parameters."""
+    description: str | None = None
+    """An optional description of the parameter. This is useful for generating
+    help messages for the configuration."""
+    required: bool = False
+    """Whether the parameter is required. If a parameter is required, it will
+    be an error to not provide a value for it, either trough a command-line
+    argument, an environment variable or a default value."""
+    choices: list[Any | None] = None
+    """Limits values to a specific set of choices."""
+
+    def __post_init__(self):
+        """
+        Post-initialization hook that marks this class as deprecated.
+
+        This method is automatically called after the object is initialized.
+        It displays a deprecation warning to inform users to use the `Option` class instead.
+        """
+        deprecated(
+            name="Parameter",
+            reason="`Parameter` is deprecated, use `Option` instead",
+        )
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "Parameter":
+        """
+        !!! warning
+            `Parameter` is deprecated, use `Option` instead.
+            `Parameter.from_dict` -> `Option.from_dict`
+
+        Creates an instance of `Parameter` from a dictionary.
+
+        Parameters
+        ----------
+        data : dict[str, Any]
+            The dictionary representation of a parameter.
+
+        Returns
+        -------
+        Parameter
+            An instance of `Parameter`.
+        """
+
+        deprecated(
+            name="Parameter.from_dict",
+            reason="`Parameter` is deprecated, use `Option` instead. Parameter.from_dict -> Option.from_dict",
+        )
+
+        param_type_string = data["param_type"]
+        param_type = getattr(builtins, param_type_string.split("'")[1])
+
+        return Parameter(
+            name=data["name"],
+            param_type=param_type,
+            default=data.get("default"),
+            description=data.get("description"),
+            required=data.get("required", False),
+            choices=data.get("choices"),
+        )
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        !!! warning
+            `Parameter` is deprecated, use `Option` instead.
+            `Parameter.to_dict` -> `Option.to_dict`
+
+        Converts the parameter to a dict.
+
+        Returns
+        -------
+        dict[str, Any]
+            The parameter as a dict with its name, type, default value,
+            description, required flag, and choices.
+
+        Examples
+        --------
+        >>> param = Parameter("timeout", int, 60, "Maximum time in seconds", True)
+        >>> param_dict = param.to_dict()
+        >>> param_dict["name"]
+        'timeout'
+        >>> param_dict["default"]
+        60
+        """
+
+        deprecated(
+            name="Parameter.to_dict",
+            reason="`Parameter` is deprecated, use `Option` instead. Parameter.to_dict -> Option.to_dict",
+        )
+
+        return {
+            "name": self.name,
+            "param_type": str(self.param_type),
+            "default": self.default,
+            "description": self.description,
+            "required": self.required,
+            "choices": self.choices,
+        }
 
 
 @dataclass
@@ -276,7 +425,8 @@ class Options:
         If a required option is not provided through a command-line
         argument, an environment variable or a default value.
     TypeError
-        If an option is not an `Option`
+        If an option is not either an `Option` or `Parameter` (deprecated)
+        object.
     ValueError
         If an environment variable is not of the type of the corresponding
         parameter.
@@ -372,6 +522,27 @@ class Options:
 
         return cloud_dict
 
+    def parameters_dict(self) -> list[dict[str, Any]]:
+        """
+        !!! warning
+            `Parameter` is deprecated, use `Option` instead. `Options.parameters_dict` -> `Options.options_dict`
+
+        Converts the options to a list of dicts. Each dict is the dict
+        representation of a `Parameter`.
+
+        Returns
+        -------
+        list[dict[str, Any]]
+            The list of dictionaries (parameter entries).
+        """
+
+        deprecated(
+            name="Options.parameters_dict",
+            reason="`Parameter` is deprecated, use `Option` instead. Options.parameters_dict -> Options.options_dict",
+        )
+
+        return [param.to_dict() for param in self.options]
+
     def options_dict(self) -> list[dict[str, Any]]:
         """
         Converts the `Options` to a list of dicts. Each dict is the dict
@@ -435,7 +606,7 @@ class Options:
             If a required option is not provided through a command-line
             argument, an environment variable or a default value.
         TypeError
-            If an option is not an `Option` object.
+            If an option is not an `Option` or `Parameter` (deprecated) object.
         ValueError
             If an environment variable is not of the type of the corresponding
             parameter.
@@ -557,6 +728,41 @@ class Options:
 
         return cls(*options)
 
+    @classmethod
+    def from_parameters_dict(cls, parameters_dict: list[dict[str, Any]]) -> "Options":
+        """
+        !!! warning
+
+            `Parameter` is deprecated, use `Option` instead.
+            `Options.from_parameters_dict` -> `Options.from_options_dict`
+
+        Creates an instance of `Options` from parameters in dict form. Each
+        entry is the dict representation of a `Parameter`.
+
+        Parameters
+        ----------
+        parameters_dict : list[dict[str, Any]]
+            The list of dictionaries (parameter entries).
+
+        Returns
+        -------
+        Options
+            An instance of `Options`.
+        """
+
+        deprecated(
+            name="Options.from_parameters_dict",
+            reason="`Parameter` is deprecated, use `Option` instead. "
+            "Options.from_parameters_dict -> Options.from_options_dict",
+        )
+
+        parameters = []
+        for parameter_dict in parameters_dict:
+            parameter = Parameter.from_dict(parameter_dict)
+            parameters.append(parameter)
+
+        return cls(*parameters)
+
     @classmethod
     def from_options_dict(cls, options_dict: list[dict[str, Any]]) -> "Options":
         """
@@ -631,7 +837,7 @@ class Options:
             If a required option is not provided through a command-line
             argument, an environment variable or a default value.
         TypeError
-            If an option is not an `Option` object.
+            If an option is not an `Option` or `Parameter` (deprecated) object.
         ValueError
             If an environment variable is not of the type of the corresponding
             parameter.
@@ -652,8 +858,10 @@ class Options:
         options_by_field_name: dict[str, Option] = {}
 
         for ix, option in enumerate(self.options):
-            if not isinstance(option, Option):
-                raise TypeError(f"expected an <Option> object, but got {type(option)} in index {ix}")
+            if not isinstance(option, Option) and not isinstance(option, Parameter):
+                raise TypeError(
+                    f"expected an <Option> (or deprecated <Parameter>) object, but got {type(option)} in index {ix}"
+                )
 
             # See comment below about ipykernel adding a `-f` argument. We
             # restrict options from having the name 'f' or 'fff' for that
@@ -668,7 +876,7 @@ class Options:
             option.name = option.name.lstrip("-")
 
             kwargs = {
-                "type": option.option_type if option.option_type is not bool else str,
+                "type": self._option_type(option) if self._option_type(option) is not bool else str,
                 "help": self._description(option),
             }
 
@@ -695,7 +903,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":
@@ -717,10 +925,12 @@ class Options:
             env_value = os.getenv(upper_name)
             if env_value is not None:
                 try:
-                    typed_env_value = option.option_type(env_value) if option.option_type is not bool else env_value
+                    typed_env_value = (
+                        self._option_type(option)(env_value) if self._option_type(option) is not bool else env_value
+                    )
                 except ValueError:
                     raise ValueError(
-                        f'environment variable "{upper_name}" is not of type {option.option_type}'
+                        f'environment variable "{upper_name}" is not of type {self._option_type(option)}'
                     ) from None
 
                 value = self._option_value(option, typed_env_value)
@@ -758,6 +968,8 @@ class Options:
         """
 
         description = ""
+        if isinstance(option, Parameter):
+            description = "DEPRECATED (initialized with <Parameter>, use <Option> instead) "
 
         description += f"[env var: {option.name.upper()}]"
 
@@ -767,7 +979,7 @@ class Options:
         if option.default is not None:
             description += f" (default: {option.default})"
 
-        description += f" (type: {option.option_type.__name__})"
+        description += f" (type: {self._option_type(option).__name__})"
 
         if isinstance(option, Option) and option.additional_attributes is not None:
             description += f" (additional attributes: {option.additional_attributes})"
@@ -808,7 +1020,7 @@ class Options:
             other values are converted to False.
         """
 
-        opt_type = option.option_type
+        opt_type = self._option_type(option)
         if opt_type is not bool:
             return value
 
@@ -819,6 +1031,39 @@ class Options:
 
         return False
 
+    @staticmethod
+    def _option_type(option: Option | Parameter) -> type:
+        """
+        Get the type of an option.
+
+        This auxiliary function was introduced for backwards compatibility with
+        the deprecated `Parameter` class. Once `Parameter` is removed, this function
+        can be removed as well. When the function is removed, use the
+        `option.option_type` attribute directly, instead of calling this function.
+
+        Parameters
+        ----------
+        option : Union[Option, Parameter]
+            The option to get the type for.
+
+        Returns
+        -------
+        type
+            The type of the option.
+
+        Raises
+        ------
+        TypeError
+            If the option is not an `Option` or `Parameter` object.
+        """
+
+        if isinstance(option, Option):
+            return option.option_type
+        elif isinstance(option, Parameter):
+            return option.param_type
+        else:
+            raise TypeError(f"expected an <Option> (or deprecated <Parameter>) object, but got {type(option)}")
+
 
 class OptionsEnforcement:
     """

nextmv/output.py

@@ -66,6 +66,7 @@ from pydantic import AliasChoices, Field
 
 from nextmv._serialization import serialize_json
 from nextmv.base_model import BaseModel
+from nextmv.deprecated import deprecated
 from nextmv.logger import reset_stdout
 from nextmv.options import Options
 
@@ -1517,6 +1518,67 @@ class LocalOutputWriter(OutputWriter):
         )
 
 
+def write_local(
+    output: Output | dict[str, Any],
+    path: str | None = None,
+    skip_stdout_reset: bool = False,
+) -> None:
+    """
+    !!! warning
+        `write_local` is deprecated, use `write` instead.
+
+    Write the output to the local filesystem or stdout.
+
+    This is a convenience function for instantiating a `LocalOutputWriter` and
+    calling its `write` method.
+
+    Parameters
+    ----------
+    output : Union[Output, dict[str, Any]]
+        Output data to write. Can be an Output object or a dictionary.
+    path : str, optional
+        Path to write the output data to. The interpretation depends on the
+        output format:
+
+        - For `OutputFormat.JSON`: File path for the JSON output. If None or
+          empty, writes to stdout.
+        - For `OutputFormat.CSV_ARCHIVE`: Directory path for CSV files. If None
+          or empty, writes to a directory named "output" in the current working
+          directory.
+    skip_stdout_reset : bool, optional
+        Skip resetting stdout before writing the output data. Default is False.
+
+    Raises
+    ------
+    ValueError
+        If the Output.output_format is not supported.
+    TypeError
+        If the output is of an unsupported type.
+
+    Notes
+    -----
+    This function detects if stdout was redirected and resets it to avoid
+    unexpected behavior. If you want to skip this behavior, set the
+    skip_stdout_reset parameter to True.
+
+    Examples
+    --------
+    >>> from nextmv.output import write_local, Output
+    >>> # Write JSON to a file
+    >>> write_local(Output(solution={"result": 42}), path="result.json")
+    >>> # Write JSON to stdout
+    >>> write_local({"simple": "data"})
+    """
+
+    deprecated(
+        name="write_local",
+        reason="`write_local` is deprecated, use `write` instead",
+    )
+
+    writer = LocalOutputWriter()
+    writer.write(output, path, skip_stdout_reset)
+
+
 _LOCAL_OUTPUT_WRITER = LocalOutputWriter()
 """Default LocalOutputWriter instance used by the write function."""
 

nextmv/run.py

@@ -53,7 +53,7 @@ from nextmv._serialization import serialize_json
 from nextmv.base_model import BaseModel
 from nextmv.input import Input, InputFormat
 from nextmv.output import Asset, Output, OutputFormat, Statistics
-from nextmv.status import StatusV2
+from nextmv.status import Status, StatusV2
 
 
 def run_duration(start: datetime | float, end: datetime | float) -> int:
@@ -520,6 +520,8 @@ class Run(BaseModel):
         Class name for the execution of a job.
     runtime : str
         Runtime environment for the run.
+    status : Status
+        Deprecated, use status_v2 instead.
     status_v2 : StatusV2
         Status of the run.
     queuing_priority : int, optional
@@ -596,6 +598,8 @@ class Run(BaseModel):
     status_v2: StatusV2
     """Status of the run."""
 
+    status: Status | None = None
+    """Deprecated, use status_v2 instead."""
     queuing_priority: int | None = None
     """Priority of the run in the queue."""
     queuing_disabled: bool | None = None
@@ -652,6 +656,8 @@ class Metadata(BaseModel):
         Size of the output in bytes.
     format : Format
         Format of the input and output of the run.
+    status : Status
+        Deprecated: use status_v2.
     status_v2 : StatusV2
         Status of the run.
     """
@@ -676,6 +682,8 @@ class Metadata(BaseModel):
     """Format of the input and output of the run."""
     status_v2: StatusV2
     """Status of the run."""
+    status: Status | None = None
+    """Deprecated: use status_v2."""
     statistics: dict[str, Any] | None = None
     """User defined statistics of the run."""
 
@@ -859,6 +867,7 @@ class RunInformation(BaseModel):
             run_type=RunTypeConfiguration(),  # Default empty configuration
             execution_class="",  # Not available in RunInformation
             runtime="",  # Not available in RunInformation
+            status=self.metadata.status,
             status_v2=self.metadata.status_v2,
             # Optional fields that are not available in RunInformation
             queuing_priority=None,

nextmv/status.py

@@ -2,10 +2,13 @@
 Provides status enums for Nextmv application runs.
 
 This module defines enumerations for representing the status of a run in a
-Nextmv application.
+Nextmv application. It includes a deprecated `Status` enum and the current
+`StatusV2` enum.
 
 Classes
 -------
+Status
+    Deprecated status of a run.
 StatusV2
     Represents the status of a run.
 """
@@ -13,6 +16,53 @@ StatusV2
 from enum import Enum
 
 
+class Status(str, Enum):
+    """
+    !!! warning
+        `Status` is deprecated, use `StatusV2` instead.
+
+    Status of a run.
+
+    You can import the `Status` class directly from `nextmv`:
+
+    ```python
+    from nextmv import Status
+    ```
+
+    This enum represents the possible states of a run. It is deprecated and
+    `StatusV2` should be used for new implementations.
+
+    Attributes
+    ----------
+    failed : str
+        Run failed.
+    running : str
+        Run is running.
+    succeeded : str
+        Run succeeded.
+
+    Examples
+    --------
+    >>> from nextmv.cloud import Status
+    >>> current_status = Status.running
+    >>> if current_status == Status.succeeded:
+    ...     print("Run completed successfully.")
+    ... elif current_status == Status.failed:
+    ...     print("Run failed.")
+    ... else:
+    ...     print(f"Run is currently {current_status.value}.")
+    Run is currently running.
+
+    """
+
+    failed = "failed"
+    """Run failed."""
+    running = "running"
+    """Run is running."""
+    succeeded = "succeeded"
+    """Run succeeded."""
+
+
 class StatusV2(str, Enum):
     """
     Status of a run.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.0.0
+Version: 1.0.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/
@@ -229,20 +229,19 @@ Requires-Dist: plotly>=6.0.1; extra == 'all'
 Provides-Extra: dev
 Requires-Dist: build>=1.0.3; extra == 'dev'
 Requires-Dist: folium>=0.20.0; extra == 'dev'
-Requires-Dist: mlflow>=3.9.0; extra == 'dev'
-Requires-Dist: nextpipe>=0.6.0; extra == 'dev'
+Requires-Dist: mlflow>=2.19.0; extra == 'dev'
+Requires-Dist: nextroute>=1.11.1; extra == 'dev'
 Requires-Dist: openpyxl>=3.1.5; extra == 'dev'
 Requires-Dist: pandas>=2.2.3; extra == 'dev'
 Requires-Dist: plotly>=6.0.1; extra == 'dev'
 Requires-Dist: pydantic>=2.5.2; extra == 'dev'
-Requires-Dist: pytest>=9.0.2; extra == 'dev'
 Requires-Dist: pyyaml>=6.0.1; extra == 'dev'
 Requires-Dist: requests>=2.31.0; extra == 'dev'
 Requires-Dist: ruff>=0.1.7; extra == 'dev'
 Requires-Dist: twine>=4.0.2; extra == 'dev'
 Requires-Dist: urllib3>=2.1.0; extra == 'dev'
 Provides-Extra: notebook
-Requires-Dist: mlflow>=3.9.0; extra == 'notebook'
+Requires-Dist: mlflow>=2.19.0; extra == 'notebook'
 Description-Content-Type: text/markdown
 
 # Nextmv Python SDK