Significantly reduce import overhead (#159)

docs/source/icons.md

@@ -5,6 +5,7 @@ specified using the :class:`viser.Icon` enum.
 
 <!-- prettier-ignore-start -->
 
+.. autoclass:: viser.IconName
 .. autoclass:: viser.Icon
 
 <!-- prettier-ignore-end -->

src/viser/__init__.py

@@ -10,6 +10,7 @@
 from ._gui_handles import GuiTabGroupHandle as GuiTabGroupHandle
 from ._gui_handles import GuiTabHandle as GuiTabHandle
 from ._icons_enum import Icon as Icon
+from ._icons_enum import IconName as IconName
 from ._scene_handles import CameraFrustumHandle as CameraFrustumHandle
 from ._scene_handles import FrameHandle as FrameHandle
 from ._scene_handles import GlbHandle as GlbHandle

src/viser/_client_autobuild.py

@@ -2,7 +2,6 @@
 import sys
 from pathlib import Path
 
-import psutil
 import rich
 
 client_dir = Path(__file__).absolute().parent / "client"
@@ -11,6 +10,8 @@
 
 def _check_viser_yarn_running() -> bool:
     """Returns True if the viewer client has been launched via `yarn start`."""
+    import psutil
+
     for process in psutil.process_iter():
         try:
             if Path(process.cwd()).as_posix().endswith("viser/client") and any(

src/viser/_gui_api.py

@@ -43,7 +43,7 @@
     _make_unique_id,
 )
 from ._icons import base64_from_icon
-from ._icons_enum import Icon
+from ._icons_enum import IconName
 from ._message_api import MessageApi, cast_vector
 
 if TYPE_CHECKING:
@@ -333,7 +333,7 @@ def add_gui_button(
                 "teal",
             ]
         ] = None,
-        icon: Optional[Icon] = None,
+        icon: Optional[IconName] = None,
         order: Optional[float] = None,
     ) -> GuiButtonHandle:
         """Add a button to the GUI. The value of this input is set to `True` every time

src/viser/_gui_handles.py

@@ -27,7 +27,7 @@
 from typing_extensions import Protocol
 
 from ._icons import base64_from_icon
-from ._icons_enum import Icon
+from ._icons_enum import IconName
 from ._message_api import _encode_image_base64
 from ._messages import (
     GuiAddDropdownMessage,
@@ -343,7 +343,7 @@ def order(self) -> float:
         """Read-only order value, which dictates the position of the GUI element."""
         return self._order
 
-    def add_tab(self, label: str, icon: Optional[Icon] = None) -> GuiTabHandle:
+    def add_tab(self, label: str, icon: Optional[IconName] = None) -> GuiTabHandle:
         """Add a tab. Returns a handle we can use to add GUI elements to it."""
 
         id = _make_unique_id()

src/viser/_icons.py

@@ -2,14 +2,13 @@
 import tarfile
 from pathlib import Path
 
-from ._icons_enum import Icon
+from ._icons_enum import IconName
 
 ICONS_DIR = Path(__file__).absolute().parent / "_icons"
 
 
-def base64_from_icon(icon: Icon) -> str:
+def base64_from_icon(icon_name: IconName) -> str:
     """Read an icon and encode it via base64."""
-    icon_name = icon.value
     assert isinstance(icon_name, str)
     icons_tarball = ICONS_DIR / "tabler-icons.tar"