with_version: necessary checks

Author: alphaville

README.md

@@ -122,7 +122,7 @@ result = optimizer.solve(x0=[1.0, 0.0], xref=[0.0, 0.0])
 
 See the dedicated [OCP documentation](https://alphaville.github.io/optimization-engine/docs/python-ocp-1) for more details and examples.
 
-## Parametric Problems
+## General Parametric Optimization
 
 **OpEn** can solve nonconvex parametric optimization problems of the general form
 
@@ -132,8 +132,6 @@ See the dedicated [OCP documentation](https://alphaville.github.io/optimization-
 where *f* is a smooth cost, *U* is a simple - possibly nonconvex - set, *F<sub>1</sub>* and *F<sub>2</sub>* are nonlinear smooth mappings and *C* is a convex set ([read more](https://alphaville.github.io/optimization-engine/docs/open-intro)).
 
 
-## Code Generation Example
-
 Code generation in **Python** in just a few lines of code (read the [docs](https://alphaville.github.io/optimization-engine/docs/python-examples) for details)
 
 <a href="https://colab.research.google.com/drive/14F6IQWo8Q65mIz5Ru4FGxRPqyFMRMyzE?usp=sharing" target="_blank">

open-codegen/CHANGELOG.md

@@ -29,6 +29,7 @@ Note: This is the Changelog file of `opengen` - the Python interface of OpEn
 
 - Avoid duplicate builder log messages by disabling propagation to the root logger
 - Use reliable package version lookup when recording the installed CasADi version in optimizer manifests
+- Check valid version in `with_version`
 
 
 ## [0.9.6] - 2026-03-14

open-codegen/opengen/config/meta.py

@@ -1,6 +1,18 @@
 import re  # regular expressions
 
 
+SEMVER_PATTERN = re.compile(
+    r"^(0|[1-9]\d*)\."
+    r"(0|[1-9]\d*)\."
+    r"(0|[1-9]\d*)"
+    r"(?:-"
+    r"(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)"
+    r"(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*"
+    r")?"
+    r"(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$"
+)
+
+
 class OptimizerMeta:
     """Metadata of auto-generated parametric optimizer
 
@@ -107,8 +119,20 @@ def with_version(self, optimizer_version):
 
         :param optimizer_version: version of auto-generated optimizer
 
+        :raises ValueError: if ``optimizer_version`` is not a valid Cargo
+            package version following Semantic Versioning, for example
+            ``0.1.0`` or ``1.2.3-alpha.1``
+
         :returns: The current instance of OptimizerMeta
         """
+        if not isinstance(optimizer_version, str) or not SEMVER_PATTERN.match(optimizer_version):
+            raise ValueError(
+                "invalid optimizer version {!r}; expected a valid Cargo package "
+                "version following Semantic Versioning, for example "
+                "'0.1.0', '1.2.3-alpha.1', or '1.0.0+build.5'".format(
+                    optimizer_version
+                )
+            )
         self.__optimizer_version = optimizer_version
         return self
 

open-codegen/test/test.py

@@ -549,6 +549,22 @@ def test_squared_norm(self):
         y = fun([3, 4])
         self.assertAlmostEqual(25., y, places=12)
 
+    def test_optimizer_meta_valid_version(self):
+        meta = og.config.OptimizerMeta().with_version("1.2.3-alpha.1+build.5")
+        self.assertEqual("1.2.3-alpha.1+build.5", meta.version)
+
+    def test_optimizer_meta_invalid_version1(self):
+        with self.assertRaises(ValueError) as context:
+            og.config.OptimizerMeta().with_version("^1.2")
+
+        self.assertIn("Cargo package version", str(context.exception))
+    
+    def test_optimizer_meta_invalid_version2(self):
+        with self.assertRaises(ValueError) as context:
+            og.config.OptimizerMeta().with_version("0.1")
+
+        self.assertIn("Cargo package version", str(context.exception))
+
 
 if __name__ == '__main__':
     logging.getLogger('retry').setLevel(logging.ERROR)