Skip to content

Commit 1bcde58

Browse files
committed
overhaul of __init__.py
1 parent 38f7049 commit 1bcde58

File tree

7 files changed

+99
-40
lines changed

7 files changed

+99
-40
lines changed

python/opengen/builder/__init__.py

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1-
from .optimizer_builder import *
2-
from .problem import *
3-
from .set_y_calculator import *
1+
from .optimizer_builder import OpEnOptimizerBuilder
2+
from .problem import Problem
3+
from .set_y_calculator import SetYCalculator
4+
from .ros_builder import RosBuilder, ROS2Builder
5+
6+
__all__ = [
7+
"OpEnOptimizerBuilder",
8+
"Problem",
9+
"SetYCalculator",
10+
"RosBuilder",
11+
"ROS2Builder",
12+
]

python/opengen/builder/optimizer_builder.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
import shutil
33
import yaml
44

5+
import opengen as og
56
import opengen.config as og_cfg
67
import opengen.definitions as og_dfn
78
import opengen.constraints as og_cstr
@@ -43,10 +44,10 @@ class OpEnOptimizerBuilder:
4344
"""
4445

4546
def __init__(self,
46-
problem,
47-
metadata=og_cfg.OptimizerMeta(),
48-
build_configuration=og_cfg.BuildConfiguration(),
49-
solver_configuration=og_cfg.SolverConfiguration()):
47+
problem: og.builder.Problem,
48+
metadata: og_cfg.OptimizerMeta =og_cfg.OptimizerMeta(),
49+
build_configuration: og_cfg.BuildConfiguration =og_cfg.BuildConfiguration(),
50+
solver_configuration: og_cfg.SolverConfiguration=og_cfg.SolverConfiguration()):
5051
"""Constructor of OpEnOptimizerBuilder
5152
5253
:param problem: instance of :class:`~opengen.builder.problem.Problem`
@@ -645,7 +646,7 @@ def __initialize(self):
645646

646647
def __check_user_provided_parameters(self):
647648
self.__logger.info("Checking user parameters")
648-
649+
649650
# Check constraints dimensions
650651
dim_constraints = self.__problem.constraints.dimension()
651652
dim_decision_variables = self.__problem.dim_decision_variables()

python/opengen/config/__init__.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
from .meta import *
2-
from .solver_config import *
3-
from .build_config import *
4-
from .tcp_server_config import *
5-
from .ros_config import *
1+
from .meta import OptimizerMeta, SEMVER_PATTERN
2+
from .solver_config import SolverConfiguration
3+
from .build_config import BuildConfiguration, RustAllocator
4+
from .tcp_server_config import TcpServerConfiguration
5+
from .ros_config import RosConfiguration
6+
7+
__all__ = [
8+
"OptimizerMeta",
9+
"SEMVER_PATTERN",
10+
"SolverConfiguration",
11+
"BuildConfiguration",
12+
"RustAllocator",
13+
"TcpServerConfiguration",
14+
"RosConfiguration",
15+
]
Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,31 @@
1-
from .ball1 import *
2-
from .ball2 import *
3-
from .sphere2 import *
4-
from .rectangle import *
5-
from .constraint import *
6-
from .ball_inf import *
7-
from .soc import *
8-
from .no_constraints import *
9-
from .cartesian import *
10-
from .zero import *
11-
from .finite_set import *
12-
from .halfspace import *
13-
from .simplex import *
14-
from .affine_space import *
1+
from .ball1 import Ball1
2+
from .ball2 import Ball2
3+
from .sphere2 import Sphere2
4+
from .rectangle import Rectangle
5+
from .constraint import Constraint
6+
from .ball_inf import BallInf
7+
from .soc import SecondOrderCone
8+
from .no_constraints import NoConstraints
9+
from .cartesian import CartesianProduct
10+
from .zero import Zero
11+
from .finite_set import FiniteSet
12+
from .halfspace import Halfspace
13+
from .simplex import Simplex
14+
from .affine_space import AffineSpace
15+
16+
__all__ = [
17+
"Ball1",
18+
"Ball2",
19+
"Sphere2",
20+
"Rectangle",
21+
"Constraint",
22+
"BallInf",
23+
"SecondOrderCone",
24+
"NoConstraints",
25+
"CartesianProduct",
26+
"Zero",
27+
"FiniteSet",
28+
"Halfspace",
29+
"Simplex",
30+
"AffineSpace",
31+
]
Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1-
from .rosenbrock import *
2-
from .fmin import *
3-
from .fmax import *
4-
from .is_symbolic import *
5-
from .is_numeric import *
6-
from .sign import *
7-
from .norm2 import *
8-
from .fabs import *
9-
from .norm2_squared import *
1+
from .rosenbrock import rosenbrock
2+
from .fmin import fmin
3+
from .fmax import fmax
4+
from .is_symbolic import is_symbolic
5+
from .is_numeric import is_numeric
6+
from .sign import sign
7+
from .norm2 import norm2
8+
from .fabs import fabs
9+
from .norm2_squared import norm2_squared
10+
11+
__all__ = [
12+
"rosenbrock",
13+
"fmin",
14+
"fmax",
15+
"is_symbolic",
16+
"is_numeric",
17+
"sign",
18+
"norm2",
19+
"fabs",
20+
"norm2_squared",
21+
]

python/opengen/tcp/__init__.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
from .optimizer_tcp_manager import *
2-
from .solver_status import *
3-
from .solver_error import *
4-
from .solver_response import *
1+
from .optimizer_tcp_manager import OptimizerTcpManager
2+
from .solver_status import SolverStatus
3+
from .solver_error import SolverError
4+
from .solver_response import SolverResponse
5+
6+
__all__ = [
7+
"OptimizerTcpManager",
8+
"SolverStatus",
9+
"SolverError",
10+
"SolverResponse",
11+
]

python/test/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
"""Test package for the project."""
2+
3+
__all__ = []

0 commit comments

Comments
 (0)