nextmv 1.4.1.dev4__tar.gz → 1.4.2.dev3__tar.gz

{nextmv-1.4.1.dev4 → nextmv-1.4.2.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nextmv
-Version: 1.4.1.dev4
+Version: 1.4.2.dev3
 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-1.4.2.dev3/nextmv/__about__.py

@@ -0,0 +1 @@
+__version__ = "v1.4.2.dev3"

{nextmv-1.4.1.dev4 → nextmv-1.4.2.dev3}/nextmv/cloud/application/__init__.py

@@ -811,6 +811,9 @@ class Application(
 
         if manifest.configuration is not None and manifest.configuration.options is not None:
             options = manifest.configuration.options.to_dict()
+            # Ignore local_only options since they are not meant to be used on the platform
+            if "items" in options:
+                options["items"] = [item for item in options["items"] if not item.get("local_only", False)]
             if "format" in options and isinstance(options["format"], list):
                 # the endpoint expects a dictionary with a template key having a list of strings
                 # the app.yaml however defines format as a list of strings, so we need to convert it here

{nextmv-1.4.1.dev4 → nextmv-1.4.2.dev3}/nextmv/cloud/client.py

@@ -601,11 +601,10 @@ class Client:
         str
             The resolved API endpoint URL.
         """
-        url_key_env = os.getenv("NEXTMV_ENDPOINT")
         if self.url is not None and self.url != "":
             url = self.url
-        elif url_key_env is not None and url_key_env != "":
-            url = url_key_env
+        elif (url_env := os.getenv("NEXTMV_ENDPOINT")):
+            url = url_env
         elif profile is not None and profile != "":
             url = _retrieve_endpoint_from_config(profile)
         else:

{nextmv-1.4.1.dev4 → nextmv-1.4.2.dev3}/nextmv/manifest.py

@@ -511,6 +511,8 @@ class ManifestOption(BaseModel):
         The description of the option.
     required : bool, default=False
         Whether the option is required or not.
+    local_only : bool, default=False
+        Whether the option is only used locally and should not be sent to Nextmv Cloud.
     additional_attributes : Optional[dict[str, Any]], default=None
         Optional additional attributes for the option. The Nextmv Cloud may
         perform validation on these attributes. For example, the maximum
@@ -551,11 +553,28 @@ class ManifestOption(BaseModel):
     """The description of the option"""
     required: bool = False
     """Whether the option is required or not"""
+    local_only: bool = False
+    """Whether the option is only used locally and should not be sent to Nextmv Cloud."""
     additional_attributes: dict[str, Any] | None = None
     """Optional additional attributes for the option."""
     ui: ManifestOptionUI | None = None
     """Optional UI attributes for the option."""
 
+    def model_post_init(self, __context) -> None:
+        """
+        Validations done after parsing the model.
+
+        Raises
+        ------
+        ValueError
+            If validation fails. A descriptive error message is provided in this case.
+        """
+
+        # It does not make sense to define options as required AND them being local only,
+        # since this would make Platform runs via UI cumbersome to impossible.
+        if self.required and self.local_only:
+            raise ValueError(f"Option '{self.name}' cannot be both required and local only.")
+
     @classmethod
     def from_option(cls, option: Option) -> "ManifestOption":
         """

{nextmv-1.4.1.dev4 → nextmv-1.4.2.dev3}/tests/cloud/app.yaml

@@ -64,6 +64,12 @@ configuration:
           control_type: select
           hidden_from:
             - operator
+      - name: a local only parameter
+        option_type: string
+        default: local_default
+        description: a local only description
+        required: false
+        local_only: true
   content:
     format: "multi-file"
     multi-file:

{nextmv-1.4.1.dev4 → nextmv-1.4.2.dev3}/tests/test_manifest.py

@@ -189,7 +189,7 @@ class TestManifest(unittest.TestCase):
     def test_extract_options(self):
         manifest = Manifest.from_yaml("tests/cloud")
         options = manifest.extract_options(should_parse=False)
-        self.assertEqual(len(options.options), 5)
+        self.assertEqual(len(options.options), 6)
 
         found = {
             "string": False,
@@ -500,6 +500,57 @@ class TestManifestOption(unittest.TestCase):
                 self.assertEqual(option.required, manifest_option.required)
 
 
+class TestManifestOptionLocalOnly(unittest.TestCase):
+    def test_local_only_defaults_to_false(self):
+        option = ManifestOption(name="my_option", option_type="string", default="val")
+        self.assertFalse(option.local_only)
+
+    def test_local_only_can_be_set_to_true(self):
+        option = ManifestOption(name="my_option", option_type="int", default=0, local_only=True)
+        self.assertTrue(option.local_only)
+
+    def test_required_and_local_only_raises(self):
+        with self.assertRaises(ValueError) as ctx:
+            ManifestOption(name="my_option", option_type="string", default="val", required=True, local_only=True)
+        self.assertIn("my_option", str(ctx.exception))
+        self.assertIn("required", str(ctx.exception).lower())
+        self.assertIn("local only", str(ctx.exception).lower())
+
+    def test_local_only_round_trips_through_dict(self):
+        original = ManifestOption(name="my_option", option_type="float", default=1.5, local_only=True)
+        as_dict = original.to_dict()
+        self.assertTrue(as_dict["local_only"])
+        restored = ManifestOption.from_dict(as_dict)
+        self.assertTrue(restored.local_only)
+
+    def test_non_local_only_round_trips_through_dict(self):
+        original = ManifestOption(name="my_option", option_type="bool", default=False, local_only=False)
+        as_dict = original.to_dict()
+        self.assertFalse(as_dict["local_only"])
+        restored = ManifestOption.from_dict(as_dict)
+        self.assertFalse(restored.local_only)
+
+    def test_local_only_loaded_from_yaml(self):
+        manifest = Manifest.from_yaml("tests/cloud")
+        items = manifest.configuration.options.items
+        local_only_items = [item for item in items if item.local_only]
+        self.assertEqual(len(local_only_items), 1)
+        item = local_only_items[0]
+        self.assertEqual(item.name, "a local only parameter")
+        self.assertEqual(item.option_type, "string")
+        self.assertEqual(item.default, "local_default")
+        self.assertFalse(item.required)
+        self.assertTrue(item.local_only)
+
+    def test_other_options_are_not_local_only(self):
+        manifest = Manifest.from_yaml("tests/cloud")
+        items = manifest.configuration.options.items
+        non_local_only_items = [item for item in items if not item.local_only]
+        # All items except the one explicitly marked local_only should have local_only=False.
+        for item in non_local_only_items:
+            self.assertFalse(item.local_only, msg=f"Option '{item.name}' should not be local_only")
+
+
 class TestWriteSampleManifest(unittest.TestCase):
     def test_writes_python_manifest(self):
         with tempfile.TemporaryDirectory() as dirpath:

nextmv-1.4.1.dev4/nextmv/__about__.py

@@ -1 +0,0 @@
-__version__ = "v1.4.1.dev4"