remove ComponentType, replace with Component

Author: Archmonger

src/reactpy/core/_life_cycle_hook.py

@@ -10,7 +10,7 @@
 from anyio import Semaphore
 
 from reactpy.core._thread_local import ThreadLocal
-from reactpy.types import ComponentType, Context, ContextProviderType
+from reactpy.types import Component, Context, ContextProviderType
 from reactpy.utils import Singleton
 
 T = TypeVar("T")
@@ -146,7 +146,7 @@ async def my_effect(stop_event):
         "component",
     )
 
-    component: ComponentType
+    component: Component
 
     def __init__(
         self,
@@ -219,7 +219,7 @@ def get_context_provider(
         """
         return self._context_providers.get(context)
 
-    async def affect_component_will_render(self, component: ComponentType) -> None:
+    async def affect_component_will_render(self, component: Component) -> None:
         """The component is about to render"""
         await self._render_access.acquire()
         self._scheduled_render = False

src/reactpy/core/component.py

@@ -5,11 +5,11 @@
 from functools import wraps
 from typing import Any
 
-from reactpy.types import ComponentType, VdomDict
+from reactpy.types import Component, VdomDict
 
 
 def component(
-    function: Callable[..., ComponentType | VdomDict | str | None],
+    function: Callable[..., Component | VdomDict | str | None],
 ) -> Callable[..., Component]:
     """A decorator for defining a new component.
 
@@ -30,38 +30,3 @@ def constructor(*args: Any, key: Any | None = None, **kwargs: Any) -> Component:
         return Component(function, key, args, kwargs, sig)
 
     return constructor
-
-
-class Component:
-    """An object for rending component models."""
-
-    __slots__ = "__weakref__", "_args", "_func", "_kwargs", "_sig", "key", "type"
-
-    def __init__(
-        self,
-        function: Callable[..., ComponentType | VdomDict | str | None],
-        key: Any | None,
-        args: tuple[Any, ...],
-        kwargs: dict[str, Any],
-        sig: inspect.Signature,
-    ) -> None:
-        self.key = key
-        self.type = function
-        self._args = args
-        self._kwargs = kwargs
-        self._sig = sig
-
-    def render(self) -> ComponentType | VdomDict | str | None:
-        return self.type(*self._args, **self._kwargs)
-
-    def __repr__(self) -> str:
-        try:
-            args = self._sig.bind(*self._args, **self._kwargs).arguments
-        except TypeError:
-            return f"{self.type.__name__}(...)"
-        else:
-            items = ", ".join(f"{k}={v!r}" for k, v in args.items())
-            if items:
-                return f"{self.type.__name__}({id(self):02x}, {items})"
-            else:
-                return f"{self.type.__name__}({id(self):02x})"

src/reactpy/core/layout.py

@@ -37,7 +37,7 @@
 from reactpy.core._life_cycle_hook import LifeCycleHook
 from reactpy.core.vdom import validate_vdom_json
 from reactpy.types import (
-    ComponentType,
+    Component,
     Context,
     Event,
     EventHandlerDict,
@@ -69,9 +69,9 @@ class Layout:
     if not hasattr(abc.ABC, "__weakref__"):  # nocov
         __slots__ += ("__weakref__",)
 
-    def __init__(self, root: ComponentType | Context[Any]) -> None:
+    def __init__(self, root: Component | Context[Any]) -> None:
         super().__init__()
-        if not isinstance(root, ComponentType):
+        if not isinstance(root, Component):
             msg = f"Expected a ComponentType, not {type(root)!r}."
             raise TypeError(msg)
         self.root = root
@@ -183,7 +183,7 @@ async def _render_component(
         exit_stack: AsyncExitStack,
         old_state: _ModelState | None,
         new_state: _ModelState,
-        component: ComponentType,
+        component: Component,
     ) -> None:
         life_cycle_state = new_state.life_cycle_state
         life_cycle_hook = life_cycle_state.hook
@@ -386,7 +386,7 @@ async def _render_model_children(
                 new_state.append_child(new_child_state.model.current)
                 new_state.children_by_key[key] = new_child_state
             elif child_type is _COMPONENT_TYPE:
-                child = cast(ComponentType, child)
+                child = cast(Component, child)
                 old_child_state = old_state.children_by_key.get(key)
                 if old_child_state is None:
                     new_child_state = _make_component_model_state(
@@ -490,7 +490,7 @@ def __repr__(self) -> str:
 
 
 def _new_root_model_state(
-    component: ComponentType, schedule_render: Callable[[_LifeCycleStateId], None]
+    component: Component, schedule_render: Callable[[_LifeCycleStateId], None]
 ) -> _ModelState:
     return _ModelState(
         parent=None,
@@ -508,7 +508,7 @@ def _make_component_model_state(
     parent: _ModelState,
     index: int,
     key: Any,
-    component: ComponentType,
+    component: Component,
     schedule_render: Callable[[_LifeCycleStateId], None],
 ) -> _ModelState:
     return _ModelState(
@@ -546,7 +546,7 @@ def _update_component_model_state(
     old_model_state: _ModelState,
     new_parent: _ModelState,
     new_index: int,
-    new_component: ComponentType,
+    new_component: Component,
     schedule_render: Callable[[_LifeCycleStateId], None],
 ) -> _ModelState:
     return _ModelState(
@@ -672,7 +672,7 @@ def __repr__(self) -> str:  # nocov
 
 
 def _make_life_cycle_state(
-    component: ComponentType,
+    component: Component,
     schedule_render: Callable[[_LifeCycleStateId], None],
 ) -> _LifeCycleState:
     life_cycle_state_id = _LifeCycleStateId(uuid4().hex)
@@ -685,7 +685,7 @@ def _make_life_cycle_state(
 
 def _update_life_cycle_state(
     old_life_cycle_state: _LifeCycleState,
-    new_component: ComponentType,
+    new_component: Component,
 ) -> _LifeCycleState:
     return _LifeCycleState(
         old_life_cycle_state.id,
@@ -707,7 +707,7 @@ class _LifeCycleState(NamedTuple):
     hook: LifeCycleHook
     """The life cycle hook"""
 
-    component: ComponentType
+    component: Component
     """The current component instance"""
 
 
@@ -739,7 +739,7 @@ def _get_children_info(children: list[VdomChild]) -> Sequence[_ChildInfo]:
         elif isinstance(child, dict):
             child_type = _DICT_TYPE
             key = child.get("key")
-        elif isinstance(child, ComponentType):
+        elif isinstance(child, Component):
             child_type = _COMPONENT_TYPE
             key = child.key
         else:

src/reactpy/core/vdom.py

@@ -17,7 +17,7 @@
 from reactpy.core._f_back import f_module_name
 from reactpy.core.events import EventHandler, to_event_handler_function
 from reactpy.types import (
-    ComponentType,
+    Component,
     CustomVdomConstructor,
     EllipsisRepr,
     EventHandlerDict,
@@ -275,7 +275,7 @@ def _validate_child_key_integrity(value: Any) -> None:
         )
     else:
         for child in value:
-            if isinstance(child, ComponentType) and child.key is None:
+            if isinstance(child, Component) and child.key is None:
                 warn(f"Key not specified for child in list {child}", UserWarning)
             elif isinstance(child, Mapping) and "key" not in child:
                 # remove 'children' to reduce log spam

src/reactpy/pyscript/components.py

@@ -5,7 +5,7 @@
 
 from reactpy import component, hooks
 from reactpy.pyscript.utils import pyscript_component_html
-from reactpy.types import ComponentType, Key
+from reactpy.types import Component, Key
 from reactpy.utils import string_to_reactpy
 
 if TYPE_CHECKING:
@@ -39,10 +39,10 @@ def _pyscript_component(
 
 def pyscript_component(
     *file_paths: str | Path,
-    initial: str | VdomDict | ComponentType = "",
+    initial: str | VdomDict | Component = "",
     root: str = "root",
     key: Key | None = None,
-) -> ComponentType:
+) -> Component:
     """
     Args:
         file_paths: File path to your client-side ReactPy component. If multiple paths are \

src/reactpy/types.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import inspect
 from collections.abc import Awaitable, Callable, Mapping, Sequence
 from dataclasses import dataclass
 from pathlib import Path
@@ -26,31 +27,49 @@ class State(NamedTuple, Generic[_Type]):
     set_value: Callable[[_Type | Callable[[_Type], _Type]], None]
 
 
-ComponentConstructor = Callable[..., "ComponentType"]
+ComponentConstructor = Callable[..., "Component"]
 """Simple function returning a new component"""
 
-RootComponentConstructor = Callable[[], "ComponentType"]
+RootComponentConstructor = Callable[[], "Component"]
 """The root component should be constructed by a function accepting no arguments."""
 
 
 Key: TypeAlias = str | int
 
 
-@runtime_checkable
-class ComponentType(Protocol):
-    """The expected interface for all component-like objects"""
-
-    key: Key | None
-    """An identifier which is unique amongst a component's immediate siblings"""
+class Component:
+    """An object for rending component models."""
 
-    type: Any
-    """The function or class defining the behavior of this component
+    __slots__ = "__weakref__", "_args", "_func", "_kwargs", "_sig", "key", "type"
 
-    This is used to see if two component instances share the same definition.
-    """
+    def __init__(
+        self,
+        function: Callable[..., Component | VdomDict | str | None],
+        key: Any | None,
+        args: tuple[Any, ...],
+        kwargs: dict[str, Any],
+        sig: inspect.Signature,
+    ) -> None:
+        self.key = key
+        self.type = function
+        self._args = args
+        self._kwargs = kwargs
+        self._sig = sig
+
+    def render(self) -> Component | VdomDict | str | None:
+        return self.type(*self._args, **self._kwargs)
 
-    def render(self) -> VdomDict | ComponentType | str | None:
-        """Render the component's view model."""
+    def __repr__(self) -> str:
+        try:
+            args = self._sig.bind(*self._args, **self._kwargs).arguments
+        except TypeError:
+            return f"{self.type.__name__}(...)"
+        else:
+            items = ", ".join(f"{k}={v!r}" for k, v in args.items())
+            if items:
+                return f"{self.type.__name__}({id(self):02x}, {items})"
+            else:
+                return f"{self.type.__name__}({id(self):02x})"
 
 
 _Render_co = TypeVar("_Render_co", covariant=True)
@@ -787,7 +806,7 @@ class VdomTypeDict(TypedDict):
 
     tagName: str
     key: NotRequired[Key | None]
-    children: NotRequired[Sequence[ComponentType | VdomChild]]
+    children: NotRequired[Sequence[Component | VdomChild]]
     attributes: NotRequired[VdomAttributes]
     eventHandlers: NotRequired[EventHandlerDict]
     inlineJavaScript: NotRequired[InlineJavaScriptDict]
@@ -815,7 +834,7 @@ def __getitem__(self, key: Literal["key"]) -> Key | None: ...
     @overload
     def __getitem__(
         self, key: Literal["children"]
-    ) -> Sequence[ComponentType | VdomChild]: ...
+    ) -> Sequence[Component | VdomChild]: ...
     @overload
     def __getitem__(self, key: Literal["attributes"]) -> VdomAttributes: ...
     @overload
@@ -833,7 +852,7 @@ def __setitem__(self, key: Literal["tagName"], value: str) -> None: ...
     def __setitem__(self, key: Literal["key"], value: Key | None) -> None: ...
     @overload
     def __setitem__(
-        self, key: Literal["children"], value: Sequence[ComponentType | VdomChild]
+        self, key: Literal["children"], value: Sequence[Component | VdomChild]
     ) -> None: ...
     @overload
     def __setitem__(
@@ -857,7 +876,7 @@ def __setitem__(self, key: VdomDictKeys, value: Any) -> None:
         super().__setitem__(key, value)
 
 
-VdomChild: TypeAlias = ComponentType | VdomDict | str | None | Any
+VdomChild: TypeAlias = Component | VdomDict | str | None | Any
 """A single child element of a :class:`VdomDict`"""
 
 VdomChildren: TypeAlias = Sequence[VdomChild] | VdomChild
@@ -994,7 +1013,7 @@ def __call__(
     ) -> ContextProviderType[_Type]: ...
 
 
-class ContextProviderType(ComponentType, Protocol[_Type]):
+class ContextProviderType(Component, Protocol[_Type]):
     """A component which provides a context value to its children"""
 
     type: Context[_Type]

src/reactpy/utils.py

@@ -11,7 +11,7 @@
 
 from reactpy import html
 from reactpy.transforms import RequiredTransforms, attributes_to_reactjs
-from reactpy.types import ComponentType, VdomDict
+from reactpy.types import Component, VdomDict
 
 _RefValue = TypeVar("_RefValue")
 _ModelTransform = Callable[[VdomDict], Any]
@@ -63,7 +63,7 @@ def __repr__(self) -> str:
         return f"{type(self).__name__}({current})"
 
 
-def reactpy_to_string(root: VdomDict | ComponentType) -> str:
+def reactpy_to_string(root: VdomDict | Component) -> str:
     """Convert a ReactPy component or `reactpy.html` element into an HTML string.
 
     Parameters:
@@ -186,7 +186,7 @@ def _add_vdom_to_etree(parent: etree._Element, vdom: VdomDict | dict[str, Any])
 
     for c in vdom.get("children", []):
         if hasattr(c, "render"):
-            c = component_to_vdom(cast(ComponentType, c))
+            c = component_to_vdom(cast(Component, c))
         if isinstance(c, dict):
             _add_vdom_to_etree(element, c)
 
@@ -232,14 +232,14 @@ def _generate_vdom_children(
     )
 
 
-def component_to_vdom(component: ComponentType) -> VdomDict:
+def component_to_vdom(component: Component) -> VdomDict:
     """Convert the first render of a component into a VDOM dictionary"""
     result = component.render()
 
     if isinstance(result, dict):
         return result
     if hasattr(result, "render"):
-        return component_to_vdom(cast(ComponentType, result))
+        return component_to_vdom(cast(Component, result))
     elif isinstance(result, str):
         return html.div(result)
     return html.fragment()