nextmv 0.23.0__py3-none-any.whl → 0.24.0__py3-none-any.whl

nextmv/output.py

@@ -13,6 +13,7 @@ from typing import Any, Optional, Union
 from pydantic import AliasChoices, Field
 
 from nextmv.base_model import BaseModel
+from nextmv.deprecated import deprecated
 from nextmv.logger import reset_stdout
 from nextmv.options import Options
 
@@ -162,9 +163,9 @@ class Statistics(BaseModel):
 class OutputFormat(str, Enum):
     """Format of an `Input`."""
 
-    JSON = "JSON"
+    JSON = "json"
     """JSON format, utf-8 encoded."""
-    CSV_ARCHIVE = "CSV_ARCHIVE"
+    CSV_ARCHIVE = "csv-archive"
     """CSV archive format: multiple CSV files."""
 
 
@@ -333,11 +334,10 @@ class Output:
         """
 
         output_dict = {
-            "options": self.options.to_dict() if self.options is not None else None,
-            "output_format": self.output_format,
-            "solution": self.solution,
-            "statistics": self.statistics.to_dict() if self.statistics is not None else None,
-            "assets": [asset.to_dict() for asset in self.assets] if self.assets is not None else None,
+            "options": self.options.to_dict() if self.options is not None else {},
+            "solution": self.solution if self.solution is not None else {},
+            "statistics": self.statistics.to_dict() if self.statistics is not None else {},
+            "assets": [asset.to_dict() for asset in self.assets] if self.assets is not None else [],
         }
 
         if self.output_format == OutputFormat.CSV_ARCHIVE:
@@ -589,6 +589,10 @@ def write_local(
     skip_stdout_reset: bool = False,
 ) -> None:
     """
+    DEPRECATION WARNING
+    ----------
+    `write_local` is deprecated, use `write` instead.
+
     This is a convenience function for instantiating a `LocalOutputWriter` and
     calling its `write` method.
 
@@ -623,10 +627,63 @@ def write_local(
         If the `Output.output_format` is not supported.
     """
 
+    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()
+
+
+def write(
+    output: Union[Output, dict[str, Any]],
+    path: Optional[str] = None,
+    skip_stdout_reset: bool = False,
+    writer: Optional[OutputWriter] = _LOCAL_OUTPUT_WRITER,
+) -> None:
+    """
+    This is a convenience function for writing an `Output`, i.e.: write the
+    output to the specified destination. The `writer` is used to call the
+    `.write` method. Note that the default writes is the `LocalOutputWriter`.
+
+    Consider the following for the `path` parameter, depending on the
+    `Output.output_format`:
+
+    - `OutputFormat.JSON`: the `path` is the file where the JSON data will
+        be written. If empty or `None`, the data will be written to stdout.
+    - `OutputFormat.CSV_ARCHIVE`: the `path` is the directory where the CSV
+        files will be written. If empty or `None`, the data will be written
+        to a directory named `output` under the current working directory.
+        The `Output.options` and `Output.statistics` will be written to
+        stdout.
+
+    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`.
+
+    Parameters
+    ----------
+    output : Output, dict[str, Any]
+        Output data to write.
+    path : str
+        Path to write the output data to.
+    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.
+    """
+
+    writer.write(output, path, skip_stdout_reset)
+
+
 def _custom_serial(obj: Any):
     """JSON serializer for objects not serializable by default one."""
 

{nextmv-0.23.0.dist-info → nextmv-0.24.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 0.23.0
+Version: 0.24.0
 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.24.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+nextmv/__about__.py,sha256=fD27wZZANNFf0FJ1iOoxuLS18yRdvKwwSYfjMUoav6A,24
+nextmv/__entrypoint__.py,sha256=5K058PICm5sx4sNMqx56auMh9yWgdIESVLzfvyIXdjs,1158
+nextmv/__init__.py,sha256=QN5e_BFkIdBkR8DiGr9T06N6mXtowT84eRUJj3_Vfrg,1459
+nextmv/base_model.py,sha256=mdaBe-epNK1cFgP4TxbOtn3So4pCi1vMTOrIBkCBp7A,1050
+nextmv/deprecated.py,sha256=ctE39pmJEfoicR-w0EdT7FPtd0cWmP3GKth-FsNn_Ks,406
+nextmv/input.py,sha256=tppXHiJM_EzR9Z1yJPc37joBvgC0RmiAFo0Ab1X5nPA,15480
+nextmv/logger.py,sha256=5qQ7E3Aaw3zzkIeiUuwYGzTcB7VhVqIzNZm5PHmdpUI,852
+nextmv/model.py,sha256=rwBdgmKSEp1DPv43zF0azj3QnbHO6O6wKs0PIGvVS40,9861
+nextmv/options.py,sha256=IPqAIUjoKMWmoPx_e5zDcnxu7S2HVxw-SLjjUduVvZM,25302
+nextmv/output.py,sha256=xag6SoNkd3oyKBgQCbvx6jsYLu4pzHPuLEAEtbCDolI,21984
+nextmv/cloud/__init__.py,sha256=O34rjrgClnIwXDE63PK4iq5ESuGQ86dJ6FPSrcUnmk0,3680
+nextmv/cloud/acceptance_test.py,sha256=NtqGhj-UYibxGBbU2kfjr-lYcngojb_5VMvK2WZwibI,6620
+nextmv/cloud/account.py,sha256=mZUGzV-uMGBA5BC_FPtsiCMFuz5jxEZ3O1BbELZIm18,1841
+nextmv/cloud/application.py,sha256=tx_VgtW34cpYdOCdvWh6J5z6KpEEeU22nPdYvtRyuKI,79346
+nextmv/cloud/batch_experiment.py,sha256=xuItiW0hhaDt78BWSz7bcw8cbI8joCkw5KH2Gj5JRbQ,3734
+nextmv/cloud/client.py,sha256=JUE3vD767_FFICl1vov5Mxmircci03TBL3KmT1BOZY4,9096
+nextmv/cloud/input_set.py,sha256=HTLA2acJridZbBCAVJNom8ldNo2Rfy40YQ8Coyz3bdo,1482
+nextmv/cloud/instance.py,sha256=UfyfZXfL1ugCGAB6zwZJIAi8qxI1JCUGsluwaGdjfN4,1223
+nextmv/cloud/manifest.py,sha256=lB3rwFmIKNAncaA00DelT4tDkMkIUCWEY4QJKJsx_-U,12116
+nextmv/cloud/package.py,sha256=Y3RethLiXXW7Y6_QBJDJdd7mFNaYaSBMyasIeGLav8o,12287
+nextmv/cloud/run.py,sha256=yeuaY8rAxTAhhKY0zTGQA3sKUkSiJg487QZIxPppm40,9604
+nextmv/cloud/safe.py,sha256=IUQUOlx4ulIIyP2-Fx3-gNBm9nyWOgZgaOAlRrzqaZE,2515
+nextmv/cloud/scenario.py,sha256=9gbdnQuvmerPUBCcJ-5QbLCwgbsIfBwKXE8c5359S8E,8120
+nextmv/cloud/secrets.py,sha256=kqlN4ceww_L4kVTrAU8BZykRzXINO3zhMT_BLYea6tk,1764
+nextmv/cloud/status.py,sha256=C-ax8cLw0jPeh7CPsJkCa0s4ImRyFI4NDJJxI0_1sr4,602
+nextmv/cloud/version.py,sha256=sjVRNRtohHA97j6IuyM33_DSSsXYkZPusYgpb6hlcrc,1244
+nextmv-0.24.0.dist-info/METADATA,sha256=i51XfzKArsSXtHLUce4KczcnWp5h5Uqq7_Iezk4Xsug,14557
+nextmv-0.24.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nextmv-0.24.0.dist-info/licenses/LICENSE,sha256=ZIbK-sSWA-OZprjNbmJAglYRtl5_K4l9UwAV3PGJAPc,11349
+nextmv-0.24.0.dist-info/RECORD,,

nextmv-0.23.0.dist-info/RECORD

@@ -1,27 +0,0 @@
-nextmv/__about__.py,sha256=SaoMA-zT-KKas7BJjyDi5vRFQ0KVW0fwwmJqCzguwBY,24
-nextmv/__entrypoint__.py,sha256=o6xYGBBUgCY_htteW-qNJfp-S3Th8dzS4RreJcDCnzM,1333
-nextmv/__init__.py,sha256=rz9oP7JGyFQJdUtYX4j9xx4Gv4LMGfNvXoEID5qUqig,1354
-nextmv/base_model.py,sha256=mdaBe-epNK1cFgP4TxbOtn3So4pCi1vMTOrIBkCBp7A,1050
-nextmv/input.py,sha256=tYjiD9KM37Phqzm4faO4QLem8IXnU6HS160c1E-Yhc8,12732
-nextmv/logger.py,sha256=5qQ7E3Aaw3zzkIeiUuwYGzTcB7VhVqIzNZm5PHmdpUI,852
-nextmv/model.py,sha256=rwBdgmKSEp1DPv43zF0azj3QnbHO6O6wKs0PIGvVS40,9861
-nextmv/options.py,sha256=uLMGNt8MoBmtrcZSuinDZ7z8yq58bzHKohBRqC80r_s,18225
-nextmv/output.py,sha256=cxw7Z0dTj5u42w2MQLOz2gesj046tvYFSWmhSZtRSXU,20082
-nextmv/cloud/__init__.py,sha256=IjvO3xYvrU7nw2VDpvb2UCXV80kRYMSx9IRT6IUu68w,3349
-nextmv/cloud/acceptance_test.py,sha256=NtqGhj-UYibxGBbU2kfjr-lYcngojb_5VMvK2WZwibI,6620
-nextmv/cloud/account.py,sha256=mZUGzV-uMGBA5BC_FPtsiCMFuz5jxEZ3O1BbELZIm18,1841
-nextmv/cloud/application.py,sha256=XZvR0e2sx3HPLp6nhZEbwx7xytDSFRgDoyFDkIrGSWs,62362
-nextmv/cloud/batch_experiment.py,sha256=UxrMNAm2c7-RZ9TWRhZBtiVyEeUG1pjsLNhYkoT5Jog,2236
-nextmv/cloud/client.py,sha256=E4C8wOGOdgyMf-DCDt4YfI7ib8HwmUhAtKMdrSBJc2M,9004
-nextmv/cloud/input_set.py,sha256=ovkP17-jYs0yWrbqTM6Nl5ubWQabD_UrDqAHNo8aE2s,672
-nextmv/cloud/instance.py,sha256=UfyfZXfL1ugCGAB6zwZJIAi8qxI1JCUGsluwaGdjfN4,1223
-nextmv/cloud/manifest.py,sha256=Fdjw4c14_ph20ASOzBs2mLslyLs1jGSxWThipGFp8rk,7458
-nextmv/cloud/package.py,sha256=Y3RethLiXXW7Y6_QBJDJdd7mFNaYaSBMyasIeGLav8o,12287
-nextmv/cloud/run.py,sha256=NHuEz9qBhXKFRygSNeSXVvX4vPSsmM-KfJjh6W473XI,9567
-nextmv/cloud/secrets.py,sha256=kqlN4ceww_L4kVTrAU8BZykRzXINO3zhMT_BLYea6tk,1764
-nextmv/cloud/status.py,sha256=C-ax8cLw0jPeh7CPsJkCa0s4ImRyFI4NDJJxI0_1sr4,602
-nextmv/cloud/version.py,sha256=sjVRNRtohHA97j6IuyM33_DSSsXYkZPusYgpb6hlcrc,1244
-nextmv-0.23.0.dist-info/METADATA,sha256=R5bHWU5ED-4CqVuOOWEWn5SByiMpiUS1AJpaoYXpRr0,14557
-nextmv-0.23.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nextmv-0.23.0.dist-info/licenses/LICENSE,sha256=ZIbK-sSWA-OZprjNbmJAglYRtl5_K4l9UwAV3PGJAPc,11349
-nextmv-0.23.0.dist-info/RECORD,,