make install of lanelet2 optional

Author: MichaelSchuldes

.gitlab-ci.yml

@@ -48,7 +48,7 @@ create_doc:
   stage: test
   before_script:
     - apt-get update -q -y && apt-get install -y libgl1-mesa-dev
-    - uv pip install --system -e .[test]
+    - uv pip install --system -e .[test,lanelet2]
   script:
     - pdoc ./omega_prime --html -o docs --force
   artifacts:

omega_prime/__init__.py

@@ -1,14 +1,31 @@
 __pdoc__ = {}
 __pdoc__["converters"] = False
 """ .. include:: ./../README.md """
+import importlib.util
+import warnings
 from . import converters, metrics
 from .map_odr import MapOdr
-from .map_lanelet import MapLanelet
 from .locator import LaneRelation, Locator
 from .map import Lane, LaneBoundary, Map, MapOsi
 from .recording import MovingObject, Recording
 from importlib.metadata import version
 
+if importlib.util.find_spec("lanelet2") is not None:
+    from .map_lanelet import MapLanelet
+else:
+
+    class MapLanelet:
+        def __init__(self, *args, **kwargs):
+            warnings.warn(
+                "lanelet2 is not installed. To use MapLanelet you need to install `lanelet2` with `pip install lanelet2` (only available on linux). If you are using windows and python <= 3.12 you can try to install `lanelet2x` instead."
+            )
+
+        def __getattr__(self, name):
+            raise RuntimeError(
+                f"Cannot use attribute '{name}', since lanelet2 is not installed. To use MapLanelet you need to install `lanelet2` with `pip install lanelet2` (only available on linux). If you are using windows and python <= 3.12 you can try to install `lanelet2x` instead."
+            )
+
+
 __version__ = version("omega_prime")
 
 __all__ = [
@@ -18,8 +35,8 @@
     "Map",
     "Lane",
     "LaneBoundary",
-    "MapOdr",
     "MapLanelet",
+    "MapOdr",
     "Locator",
     "LaneRelation",
     "converters",

pyproject.toml

@@ -43,8 +43,7 @@ dependencies = [
     'lxd-io>=0.4.6',
     'pyxodr-omega-prime',
     'joblib',
-    'tqdm_joblib',
-    'lanelet2x'
+    'tqdm_joblib'
 ]
 version = "0.1.17"
 
@@ -54,6 +53,8 @@ Repository = "https://github.com/ika-rwth-aachen/omega-prime"
 
 [project.optional-dependencies]
 test = ['ruff', 'pdoc3', 'pre-commit', 'pytest', 'pytest-sugar', 'pytest-env','pytest-cov','pytest-progress','pytest-codeblocks', 'nbval','ipywidgets']
+lanelet2 = ['lanelet2']
+lanelet2x = ['lanelet2x']
 
 [project.scripts]
 omega-prime = "omega_prime.cli:main"