update main.py

- main.py: using new API
- update docs

Author: alphaville

docs/python-bindings.md

@@ -84,8 +84,8 @@ response = solver.run(p=[20., 1.])
 if not response.is_ok():
     raise RuntimeError(response.get().message)
 
-status = response.get()
-u_star = status.solution
+result = response.get()
+u_star = result.solution
 ```
 
 In the first line, `solver = rosenbrock.solver()`, we obtain an instance of 
@@ -107,8 +107,8 @@ the socket transport layer.
 ```python
 response = solver.run(p=[20., 1.])
 if response.is_ok():
-    status = response.get()
-    u_star = status.solution
+    result = response.get()
+    u_star = result.solution
 else:
     error = response.get()
     print(error.code, error.message)

open-codegen/main.py

@@ -44,23 +44,23 @@ def get_open_local_absolute_path():
                                           meta,
                                           build_config,
                                           solver_cfg)
-builder.build()
+# builder.build()
 
 sys.path.insert(1, os.path.join(optimizers_dir, optimizer_name))
 rosenbrock = __import__(optimizer_name)
 
 solver = rosenbrock.solver()
-result = solver.run(p=[0.5, 8.5], initial_guess=[1, 2, 3, 4, 0])
-print(" ")
-print(f"solution = {result.solution}")
-print(f"time = {result.solve_time_ms} ms")
-print(f"penalty = {result.penalty}")
-print(f"infeasibility f1 = {result.f1_infeasibility}")
-print(f"infeasibility f2 = {result.f2_norm}")
-print(f"status = {result.exit_status}")
-print(f"inner = {result.num_inner_iterations}")
-print(f"outer = {result.num_outer_iterations}")
-print(f"cost = {result.cost}")
+response = solver.run(p=[0.5, 8.5, 1.], initial_guess=[1, 2, 3, 4, 0])
+
+if response.is_ok():
+    # SolverResponse
+    result = response.get()
+    print(result)
+else:
+    # SolverError
+    error = response.get()
+    print(type(error))
+
 
 # Preconditioned    Non-preconditioned
 # -------------------------------------

open-codegen/opengen/ocp/builder.py

@@ -114,6 +114,7 @@ def backend_kind(self):
         return self.__backend_kind
 
     def __repr__(self):
+        """Return a concise summary of the generated optimizer wrapper."""
         return (
             "GeneratedOptimizer("
             f"optimizer_name={self.__optimizer_name!r}, "
@@ -343,8 +344,10 @@ def solve(
         :param initial_penalty: optional initial penalty parameter
         :param parameter_values: named parameter values
         :return: :class:`OcpSolution`
+        :raises ValueError: if required named parameters are missing or have
+            incompatible dimensions
         :raises RuntimeError: if the backend is unavailable or the low-level
-            solve call fails
+            solve call fails; backend-specific error messages are propagated
         """
         packed_parameters = self.__pack_parameters(parameter_values)
 

open-codegen/opengen/tcp/solver_error.py

@@ -1,5 +1,5 @@
 class SolverError:
-    """Class for storing solver status in the event of an error."""
+    """Structured solver error returned by TCP or direct Python bindings."""
 
     def __init__(self, error):
         """Constructs instance of :class:`~opengen.tcp.solver_error.SolverError`
@@ -40,4 +40,5 @@ def message(self):
         return self.__dict__["__message"]
 
     def __repr__(self):
+        """Return a concise one-line representation of the error."""
         return f"SolverError(code={self.code}, message={self.message!r})"

open-codegen/opengen/tcp/solver_response.py

@@ -3,7 +3,13 @@
 
 
 class SolverResponse:
-    """Stores a solver response of type SolverStatus or SolverError."""
+    """Stores a solver response of type SolverStatus or SolverError.
+
+    This wrapper is used by both the TCP interface and the direct Python
+    bindings generated by OpEn. Call :meth:`is_ok` first, then
+    :meth:`get` to obtain either a :class:`SolverStatus` or a
+    :class:`SolverError`.
+    """
 
     def __init__(self, d):
         """Constructs instance of :class:`~opengen.tcp.solver_response.SolverResponse`
@@ -38,9 +44,11 @@ def get(self):
         return self.__response
 
     def __getitem__(self, key):
+        """Proxy attribute access to the wrapped status or error object."""
         return getattr(self.__response, key)
 
     def __repr__(self):
+        """Return a concise one-line summary suitable for debugging."""
         if self.is_ok():
             status = self.get()
             return (