Improved validation

Author: kylebarron

lonboard/_map.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import warnings
+from dataclasses import replace
 from pathlib import Path
 from typing import IO, TYPE_CHECKING, Any, TextIO, overload
 
@@ -20,8 +21,8 @@
     ScaleControl,
 )
 from lonboard.layer import BaseLayer
+from lonboard.models import BaseViewState, MapViewState
 from lonboard.traits import HeightTrait, VariableLengthTuple, ViewStateTrait
-from lonboard.traits._map import DEFAULT_INITIAL_VIEW_STATE
 from lonboard.view import BaseView
 
 if TYPE_CHECKING:
@@ -154,9 +155,7 @@ def on_click(self, callback: Callable, *, remove: bool = False) -> None:
     _esm = bundler_output_dir / "index.js"
     _css = bundler_output_dir / "index.css"
 
-    # TODO: change this view state to allow non-map view states if we have non-map views
-    # Also allow a list/tuple of view states for multiple views
-    view_state = ViewStateTrait()
+    view_state: BaseViewState | None = ViewStateTrait()  # type: ignore
     """
     The view state of the map.
 
@@ -492,8 +491,9 @@ def add_layer(
         elif reset_zoom:
             self.view_state = compute_view(self.layers)  # type: ignore
 
-    def set_view_state(
+    def set_view_state(  # noqa: PLR0913
         self,
+        view_state: BaseViewState | None = None,
         *,
         longitude: float | None = None,
         latitude: float | None = None,
@@ -505,6 +505,9 @@ def set_view_state(
 
         Any parameters that are unset will not be changed.
 
+        Args:
+            view_state: A complete view state object to set on the map.
+
         Keyword Args:
             longitude: the new longitude to set on the map. Defaults to None.
             latitude: the new latitude to set on the map. Defaults to None.
@@ -513,24 +516,29 @@ def set_view_state(
             bearing: the new bearing to set on the map. Defaults to None.
 
         """
-        view_state = (
-            self.view_state._asdict()  # type: ignore
-            if self.view_state is not None
-            else DEFAULT_INITIAL_VIEW_STATE
-        )
-
-        if longitude is not None:
-            view_state["longitude"] = longitude
-        if latitude is not None:
-            view_state["latitude"] = latitude
-        if zoom is not None:
-            view_state["zoom"] = zoom
-        if pitch is not None:
-            view_state["pitch"] = pitch
-        if bearing is not None:
-            view_state["bearing"] = bearing
-
-        self.view_state = view_state
+        if view_state is not None:
+            self.view_state = view_state
+            return
+
+        current_view_state = self.view_state
+        if isinstance(current_view_state, MapViewState):
+            changes = {}
+            if longitude is not None:
+                changes["longitude"] = longitude
+            if latitude is not None:
+                changes["latitude"] = latitude
+            if zoom is not None:
+                changes["zoom"] = zoom
+            if pitch is not None:
+                changes["pitch"] = pitch
+            if bearing is not None:
+                changes["bearing"] = bearing
+
+            self.view_state = replace(current_view_state, **changes)
+        else:
+            raise TypeError(
+                "Can only set MapViewState or GlobeViewState parameters individually via set_view_state.\nFor other view state types, pass a complete view_state object.",
+            )
 
     def fly_to(  # noqa: PLR0913
         self,

lonboard/_viewport.py

@@ -74,14 +74,10 @@ def compute_view(layers: Sequence[BaseLayer]) -> dict[str, Any]:
             "longitude": center.x or 0,
             "latitude": center.y or 0,
             "zoom": 0,
-            "pitch": 0,
-            "bearing": 0,
         }
     else:
         return {
             "longitude": center.x,
             "latitude": center.y,
             "zoom": zoom,
-            "pitch": 0,
-            "bearing": 0,
         }

lonboard/traits/_map.py

@@ -6,24 +6,8 @@
 import traitlets
 
 from lonboard._environment import DEFAULT_HEIGHT
-from lonboard.models import (
-    BaseViewState,
-    FirstPersonViewState,
-    GlobeViewState,
-    MapViewState,
-    OrbitViewState,
-    OrthographicViewState,
-    _serialize_view_state,
-)
+from lonboard.models import BaseViewState, _serialize_view_state
 from lonboard.traits._base import FixedErrorTraitType
-from lonboard.view import (
-    BaseView,
-    FirstPersonView,
-    GlobeView,
-    MapView,
-    OrbitView,
-    OrthographicView,
-)
 
 if TYPE_CHECKING:
     from traitlets import HasTraits
@@ -82,15 +66,6 @@ def validate(self, obj: Any, value: Any) -> str:
         assert False
 
 
-VIEW_STATE_VALIDATORS: dict[type[BaseView], type[BaseViewState]] = {
-    MapView: MapViewState,
-    GlobeView: GlobeViewState,
-    FirstPersonView: FirstPersonViewState,
-    OrbitView: OrbitViewState,
-    OrthographicView: OrthographicViewState,
-}
-
-
 class ViewStateTrait(FixedErrorTraitType):
     """Trait to validate view state input."""
 
@@ -109,13 +84,9 @@ def __init__(
     def validate(self, obj: Map, value: Any) -> None | BaseViewState:
         view = obj.views
         if view is None:
-            return MapViewState() if value is None else value
+            return None
         else:  # noqa: RET505 (typing issue)
-            validator = VIEW_STATE_VALIDATORS.get(type(view))
-            if validator is None:
-                self.error(obj, value, info="unsupported view type")
-                assert False
-
+            validator = view._view_state_type  # noqa: SLF001
             return validator(value)  # type: ignore
         #     view
 

lonboard/view.py

@@ -1,6 +1,14 @@
 import traitlets as t
 
 from lonboard._base import BaseWidget
+from lonboard.models import (
+    BaseViewState,
+    FirstPersonViewState,
+    GlobeViewState,
+    MapViewState,
+    OrbitViewState,
+    OrthographicViewState,
+)
 
 
 class BaseView(BaseWidget):
@@ -10,6 +18,8 @@ class BaseView(BaseWidget):
 
     """
 
+    _view_state_type: type[BaseViewState] = BaseViewState
+
     x = t.Union([t.Int(), t.Unicode()], allow_none=True, default_value=None).tag(
         sync=True,
     )
@@ -51,6 +61,8 @@ class FirstPersonView(BaseView):
 
     _view_type = t.Unicode("first-person-view").tag(sync=True)
 
+    _view_state_type = FirstPersonViewState
+
     projection_matrix = t.List(
         t.Float(),
         allow_none=True,
@@ -98,6 +110,8 @@ class GlobeView(BaseView):
 
     _view_type = t.Unicode("globe-view").tag(sync=True)
 
+    _view_state_type = GlobeViewState
+
     resolution = t.Float(allow_none=True, default_value=None).tag(sync=True)
     """The resolution at which to turn flat features into 3D meshes, in degrees.
 
@@ -125,6 +139,8 @@ class MapView(BaseView):
 
     _view_type = t.Unicode("map-view").tag(sync=True)
 
+    _view_state_type = MapViewState
+
     repeat = t.Bool(allow_none=True, default_value=None).tag(sync=True)
     """
     Whether to render multiple copies of the map at low zoom levels. Default `false`.
@@ -183,6 +199,8 @@ class OrbitView(BaseView):
 
     _view_type = t.Unicode("orbit-view").tag(sync=True)
 
+    _view_state_type = OrbitViewState
+
     orbit_axis = t.Unicode(allow_none=True, default_value=None).tag(sync=True)
     """Axis with 360 degrees rotating freedom, either `'Y'` or `'Z'`, default to `'Z'`."""
 
@@ -233,6 +251,8 @@ class OrthographicView(BaseView):
 
     _view_type = t.Unicode("orthographic-view").tag(sync=True)
 
+    _view_state_type = OrthographicViewState
+
     flip_y = t.Bool(allow_none=True, default_value=None).tag(sync=True)
     """
     Whether to use top-left coordinates (`true`) or bottom-left coordinates (`false`).