rename proto modules to types

Author: rmorshea

docs/examples.py

@@ -6,7 +6,7 @@
 from typing import Callable, Iterator
 
 import idom
-from idom import ComponentType
+from idom.types import ComponentType
 
 
 HERE = Path(__file__)

src/idom/__init__.py

@@ -1,8 +1,8 @@
-from . import config, html, log, web
+from . import config, html, log, types, web
 from .core import hooks
-from .core.component import Component, component
+from .core.component import component
 from .core.dispatcher import Stop
-from .core.events import EventHandler, event
+from .core.events import event
 from .core.hooks import (
     create_context,
     use_callback,
@@ -14,7 +14,6 @@
     use_state,
 )
 from .core.layout import Layout
-from .core.proto import ComponentType, VdomDict
 from .core.vdom import vdom
 from .sample import run_sample_app
 from .server.prefab import run
@@ -27,12 +26,9 @@
 
 __all__ = [
     "component",
-    "Component",
-    "ComponentType",
     "config",
     "create_context",
     "event",
-    "EventHandler",
     "hooks",
     "hotswap",
     "html_to_vdom",
@@ -44,6 +40,7 @@
     "run_sample_app",
     "run",
     "Stop",
+    "types",
     "use_callback",
     "use_context",
     "use_effect",
@@ -52,6 +49,5 @@
     "use_ref",
     "use_state",
     "vdom",
-    "VdomDict",
     "web",
 ]

src/idom/core/component.py

@@ -4,7 +4,7 @@
 from functools import wraps
 from typing import Any, Callable, Dict, Optional, Tuple, Union
 
-from .proto import ComponentType, VdomDict
+from .types import ComponentType, VdomDict
 
 
 def component(

src/idom/core/dispatcher.py

@@ -24,7 +24,7 @@
 
 from ._fixed_jsonpatch import apply_patch, make_patch  # type: ignore
 from .layout import LayoutEvent, LayoutUpdate
-from .proto import LayoutType, VdomJson
+from .types import LayoutType, VdomJson
 
 
 logger = getLogger(__name__)

src/idom/core/events.py

@@ -6,7 +6,7 @@
 from anyio import create_task_group
 from typing_extensions import Literal
 
-from idom.core.proto import EventHandlerFunc, EventHandlerType
+from idom.core.types import EventHandlerFunc, EventHandlerType
 
 
 @overload

src/idom/core/hooks.py

@@ -27,7 +27,7 @@
 from idom.utils import Ref
 
 from ._thread_local import ThreadLocal
-from .proto import Key, VdomDict
+from .types import Key, VdomDict
 from .vdom import vdom
 
 

src/idom/core/layout.py

@@ -32,7 +32,7 @@
 
 from ._event_proxy import _wrap_in_warning_event_proxies
 from .hooks import LifeCycleHook
-from .proto import ComponentType, EventHandlerDict, VdomDict, VdomJson
+from .types import ComponentType, EventHandlerDict, VdomDict, VdomJson
 from .vdom import validate_vdom_json
 
 

src/idom/core/proto.py renamed to src/idom/core/types.py

@@ -180,3 +180,15 @@ class EventHandlerType(Protocol):
 
         When ``None``, it is left to a :class:`LayoutType` to auto generate a unique ID.
     """
+
+
+class VdomDictConstructor(Protocol):
+    """Standard function for constructing a :class:`VdomDict`"""
+
+    def __call__(
+        self,
+        *attributes_and_children: VdomAttributesAndChildren,
+        key: str = ...,
+        event_handlers: Optional[EventHandlerMapping] = ...,
+    ) -> VdomDict:
+        ...

src/idom/core/vdom.py

@@ -13,7 +13,7 @@
     merge_event_handlers,
     to_event_handler_function,
 )
-from idom.core.proto import (
+from idom.core.types import (
     EventHandlerDict,
     EventHandlerMapping,
     EventHandlerType,
@@ -320,7 +320,7 @@ def _is_single_child(value: Any) -> bool:
         if _debug_is_single_child(value):
             return True
 
-        from .proto import ComponentType
+        from .types import ComponentType
 
         if hasattr(value, "__iter__") and not hasattr(value, "__len__"):
             logger.error(

src/idom/html.py

@@ -160,7 +160,7 @@
 
 from typing import Any, Mapping
 
-from .core.proto import Key, VdomDict
+from .core.types import Key, VdomDict
 from .core.vdom import coalesce_attributes_and_children, make_vdom_constructor