Add types for all Widget and Pane class variables

panel/interact.py

@@ -8,11 +8,14 @@
 Copyright (c) Jupyter Development Team and PyViz Development Team.
 Distributed under the terms of the Modified BSD License.
 """
+from __future__ import annotations
+
 import types
 
 from collections import OrderedDict
 from inspect import getcallargs
 from numbers import Integral, Real
+from typing import TYPE_CHECKING
 
 try:  # Python >= 3.3
     from collections.abc import Iterable, Mapping
@@ -42,6 +45,9 @@
     TextInput, Widget,
 )
 
+if TYPE_CHECKING:
+    from bokeh.model import Model
+
 
 def _get_min_max_value(min, max, value=None, step=None):
     """Return min, max, value given input values with possible None."""
@@ -208,7 +214,7 @@ def update_pane(change):
             watcher = widget.param.watch(update_pane, pname)
             self._callbacks.append(watcher)
 
-    def _cleanup(self, root):
+    def _cleanup(self, root: Model | None = None) -> None:
         self._inner_layout._cleanup(root)
         super()._cleanup(root)
 

panel/io/location.py

@@ -79,7 +79,8 @@ def _get_model(
         return model
 
     def get_root(
-        self, doc: Optional[Document] = None, comm: Optional[Comm] = None, preprocess: bool = True
+        self, doc: Optional[Document] = None, comm: Optional[Comm] = None,
+        preprocess: bool = True
     ) -> 'Model':
         doc = init_doc(doc)
         root = self._get_model(doc, comm=comm)
@@ -88,7 +89,7 @@ def get_root(
         self._documents[doc] = root
         return root
 
-    def _cleanup(self, root: Optional['Model']) -> None:
+    def _cleanup(self, root: Model | None = None) -> None:
         if root:
             if root.document in self._documents:
                 del self._documents[root.document]

panel/io/notifications.py

@@ -64,7 +64,8 @@ def __init__(self, **params):
         self._notification_watchers = {}
 
     def get_root(
-        self, doc: Optional['Document'] = None, comm: Optional['Comm'] = None, preprocess: bool = True
+        self, doc: Optional[Document] = None, comm: Optional[Comm] = None,
+        preprocess: bool = True
     ) -> 'Model':
         root = super().get_root(doc, comm, preprocess)
         self._documents[doc] = root

panel/layout/accordion.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import ClassVar, Mapping
+from typing import TYPE_CHECKING, ClassVar, Mapping
 
 import param
 
@@ -9,6 +9,9 @@
 from .base import NamedListPanel
 from .card import Card
 
+if TYPE_CHECKING:
+    from bokeh.model import Model
+
 
 class Accordion(NamedListPanel):
     """
@@ -126,7 +129,7 @@ def _get_objects(self, model, old_objects, doc, root, comm=None):
         self._update_active()
         return new_models
 
-    def _cleanup(self, root):
+    def _cleanup(self, root: Model | None = None) -> None:
         for panel in self._panels.values():
             panel._cleanup(root)
         super()._cleanup(root)

panel/layout/base.py

@@ -641,7 +641,7 @@ def _process_param_change(self, params: Dict[str, Any]) -> Dict[str, Any]:
             params['css_classes'] = css_classes
         return super()._process_param_change(params)
 
-    def _cleanup(self, root: 'Model' | None):
+    def _cleanup(self, root: Model | None = None) -> None:
         if root is not None and root.ref['id'] in state._fake_roots:
             state._fake_roots.remove(root.ref['id'])
         super()._cleanup(root)
@@ -676,7 +676,7 @@ def _process_param_change(self, params: Dict[str, Any]) -> Dict[str, Any]:
             params['css_classes'] = css_classes
         return super()._process_param_change(params)
 
-    def _cleanup(self, root: 'Model' | None) -> None:
+    def _cleanup(self, root: Model | None = None) -> None:
         if root is not None and root.ref['id'] in state._fake_roots:
             state._fake_roots.remove(root.ref['id'])
         super()._cleanup(root)
@@ -764,9 +764,13 @@ class WidgetBox(ListPanel):
         be specified as a two-tuple of the form (vertical, horizontal)
         or a four-tuple (top, right, bottom, left).""")
 
-    _source_transforms = {'disabled': None, 'horizontal': None}
+    _source_transforms: ClassVar[Mapping[str, str | None]] = {
+        'disabled': None, 'horizontal': None
+    }
 
-    _rename: ClassVar[Mapping[str, str | None]] = {'objects': 'children', 'horizontal': None}
+    _rename: ClassVar[Mapping[str, str | None]] = {
+        'objects': 'children', 'horizontal': None
+    }
 
     @property
     def _bokeh_model(self) -> Type['Model']: # type: ignore

panel/layout/card.py

@@ -1,12 +1,17 @@
 from __future__ import annotations
 
-from typing import ClassVar, Mapping
+from typing import (
+    TYPE_CHECKING, ClassVar, List, Mapping, Type,
+)
 
 import param
 
 from ..models import Card as BkCard
 from .base import Column, ListPanel, Row
 
+if TYPE_CHECKING:
+    from bokeh.model import Model
+
 
 class Card(Column):
     """
@@ -63,11 +68,13 @@ class Card(Column):
         A title to be displayed in the Card header, will be overridden
         by the header if defined.""")
 
-    _bokeh_model = BkCard
+    _bokeh_model: ClassVar[Type[Model]] = BkCard
 
-    _linked_props = ['collapsed']
+    _linked_props: ClassVar[List[str]] = ['collapsed']
 
-    _rename: ClassVar[Mapping[str, str | None]] = dict(Column._rename, title=None, header=None, title_css_classes=None)
+    _rename: ClassVar[Mapping[str, str | None]] = dict(
+        Column._rename, title=None, header=None, title_css_classes=None
+    )
 
     def __init__(self, *objects, **params):
         self._header_layout = Row(css_classes=['card-header-row'],
@@ -77,7 +84,7 @@ def __init__(self, *objects, **params):
         self.param.watch(self._update_header, ['title', 'header', 'title_css_classes'])
         self._update_header()
 
-    def _cleanup(self, root):
+    def _cleanup(self, root: Model | None = None) -> None:
         super()._cleanup(root)
         self._header_layout._cleanup(root)
 

panel/layout/grid.py

@@ -7,7 +7,9 @@
 
 from collections import OrderedDict, namedtuple
 from functools import partial
-from typing import ClassVar, Mapping
+from typing import (
+    TYPE_CHECKING, Any, ClassVar, Dict, Mapping, Optional,
+)
 
 import numpy as np
 import param
@@ -19,6 +21,11 @@
     ListPanel, Panel, _col, _row,
 )
 
+if TYPE_CHECKING:
+    from bokeh.document import Document
+    from bokeh.model import Model
+    from pyviz_comms import Comm
+
 
 class GridBox(ListPanel):
     """
@@ -155,7 +162,10 @@ def _get_model(self, doc, root=None, parent=None, comm=None):
         self._link_props(model, self._linked_props, doc, root, comm)
         return model
 
-    def _update_model(self, events, msg, root, model, doc, comm=None):
+    def _update_model(
+        self, events: Dict[str, param.parameterized.Event], msg: Dict[str, Any],
+        root: Model, model: Model, doc: Document, comm: Optional[Comm]
+    ) -> None:
         from ..io import state
 
         msg = dict(msg)
@@ -327,7 +337,7 @@ def _object_grid(self):
                     grid[y, x] = {((y0, x0, y1, x1), obj)}
         return grid
 
-    def _cleanup(self, root):
+    def _cleanup(self, root: Model | None = None) -> None:
         super()._cleanup(root)
         for p in self.objects.values():
             p._cleanup(root)

panel/layout/tabs.py

@@ -4,7 +4,7 @@
 from __future__ import annotations
 
 from collections import defaultdict
-from typing import ClassVar, Mapping
+from typing import TYPE_CHECKING, ClassVar, Mapping
 
 import param
 
@@ -14,6 +14,9 @@
 from ..viewable import Layoutable
 from .base import NamedListPanel
 
+if TYPE_CHECKING:
+    from bokeh.model import Model
+
 
 class Tabs(NamedListPanel):
     """
@@ -74,7 +77,7 @@ def _update_names(self, event):
         self.param.active.bounds = (0, len(event.new)-1)
         super()._update_names(event)
 
-    def _cleanup(self, root):
+    def _cleanup(self, root: Model | None = None) -> None:
         super()._cleanup(root)
         if root.ref['id'] in self._panels:
             del self._panels[root.ref['id']]

panel/pane/alert.py

@@ -5,7 +5,7 @@
 """
 from __future__ import annotations
 
-from typing import ClassVar, Mapping
+from typing import Any, ClassVar, Mapping
 
 import param
 
@@ -28,12 +28,12 @@ class Alert(Markdown):
 
     alert_type = param.ObjectSelector("primary", objects=ALERT_TYPES)
 
-    priority = 0
+    priority: ClassVar[float | bool | None] = 0
 
     _rename: ClassVar[Mapping[str, str | None]] = dict(Markdown._rename, alert_type=None)
 
     @classmethod
-    def applies(cls, obj):
+    def applies(cls, obj: Any) -> float | bool | None:
         priority = Markdown.applies(obj)
         return 0 if priority else False
 

panel/pane/base.py

@@ -8,7 +8,7 @@
 
 from functools import partial
 from typing import (
-    TYPE_CHECKING, Any, Callable, List, Optional, Type, TypeVar,
+    TYPE_CHECKING, Any, Callable, ClassVar, List, Optional, Type, TypeVar,
 )
 
 import param
@@ -121,19 +121,19 @@ class PaneBase(Reactive):
     # numerical priority is selected. The default is an intermediate value.
     # If set to None, applies method will be called to get a priority
     # value for a specific object type.
-    priority: float | bool | None = 0.5
+    priority: ClassVar[float | bool | None] = 0.5
 
     # Whether applies requires full set of keywords
-    _applies_kw = False
+    _applies_kw: ClassVar[bool] = False
 
     # Whether the Pane layout can be safely unpacked
-    _unpack: bool = True
+    _unpack: ClassVar[bool] = True
 
     # Declares whether Pane supports updates to the Bokeh model
-    _updates: bool = False
+    _updates: ClassVar[bool] = False
 
     # List of parameters that trigger a rerender of the Bokeh model
-    _rerender_params: List[str] = ['object']
+    _rerender_params: ClassVar[List[str]] = ['object']
 
     __abstract = True
 
@@ -179,7 +179,7 @@ def _synced_params(self) -> List[str]:
         return [p for p in self.param if p not in ignored_params]
 
     def _update_object(
-        self, ref: str, doc: 'Document', root: 'Model', parent: 'Model', comm: Optional['Comm']
+        self, ref: str, doc: 'Document', root: Model, parent: Model, comm: Optional[Comm]
     ) -> None:
         old_model = self._models[ref][0]
         if self._updates:
@@ -246,7 +246,7 @@ def _update_pane(self, *events) -> None:
                 else:
                     cb()
 
-    def _update(self, ref: Optional[str] = None, model: Optional['Model'] = None) -> None:
+    def _update(self, ref: Optional[str] = None, model: Optional[Model] = None) -> None:
         """
         If _updates=True this method is used to update an existing
         Bokeh model instead of replacing the model entirely. The
@@ -290,9 +290,9 @@ def clone(self: T, object: Optional[Any] = None, **params) -> T:
         return type(self)(object, **params)
 
     def get_root(
-        self, doc: Optional['Document'] = None, comm: Optional['Comm'] = None,
+        self, doc: Optional[Document] = None, comm: Optional[Comm] = None,
         preprocess: bool = True
-    ) -> 'Model':
+    ) -> Model:
         """
         Returns the root model and applies pre-processing hooks
 
@@ -460,9 +460,9 @@ def _update_inner(self, new_object: Any) -> None:
         self._internal = internal
 
     def _get_model(
-        self, doc: 'Document', root: Optional['Model'] = None,
-        parent: Optional['Model'] = None, comm: Optional['Comm'] = None
-    ) -> 'Model':
+        self, doc: Document, root: Optional[Model] = None,
+        parent: Optional[Model] = None, comm: Optional[Comm] = None
+    ) -> Model:
         if root:
             ref = root.ref['id']
             if ref in self._models:
@@ -473,7 +473,7 @@ def _get_model(
         self._models[ref] = (model, parent)
         return model
 
-    def _cleanup(self, root: 'Model' | None = None) -> None:
+    def _cleanup(self, root: Model | None = None) -> None:
         self._inner_layout._cleanup(root)
         super()._cleanup(root)