rename proto modules to types (#701)

* rename proto modules to types

* sphinx ignore __all__

* changelog entry

* fix doc issue

not sure why this was not caught earlier

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__)

docs/source/_custom_js/package-lock.json

@@ -22,10 +22,12 @@
 AUTODOC_TEMPLATE_WITH_MEMBERS = """\
 .. automodule:: {module}
     :members:
+    :ignore-module-all:
 """
 
 AUTODOC_TEMPLATE_WITHOUT_MEMBERS = """\
 .. automodule:: {module}
+    :ignore-module-all:
 """
 
 TITLE = """\

docs/source/_exts/autogen_api_docs.py

@@ -10,13 +10,17 @@ Changelog
 
 All notable changes to this project will be recorded in this document. The style of
 which is based on `Keep a Changelog <https://keepachangelog.com/>`__. The versioning
-scheme for the project adheres to `Semantic Versioning <https://semver.org/>`__.
+scheme for the project adheres to `Semantic Versioning <https://semver.org/>`__. For
+more info, see the :ref:`Contributor Guide <Create a Changelog Entry>`.
 
 
 Unreleased
 ----------
 
-Nothing yet...
+Changed:
+
+- The name of ``proto`` modules to ``types`` and added a top level ``idom.types`` module
+  - :pull:`701`
 
 
 0.37.1

docs/source/about/changelog.rst

@@ -69,10 +69,11 @@ about how to get started. To make a change to IDOM you'll do the following:
 Create a Changelog Entry
 ........................
 
-As part of your pull request, you'll want to edit the :ref:`Changelog` by adding an
-entry describing what you've changed or improved. You should write an entry in the style
-of `Keep a Changelog <https://keepachangelog.com/>`__ that falls under one of the
-following categories, and add it to the :ref:`Unreleased` section of the changelog:
+As part of your pull request, you'll want to edit the `Changelog
+<https://github.com/idom-team/idom/blob/main/docs/source/about/changelog.rst>`__ by
+adding an entry describing what you've changed or improved. You should write an entry in
+the style of `Keep a Changelog <https://keepachangelog.com/>`__ that falls under one of
+the following categories, and add it to the :ref:`Unreleased` section of the changelog:
 
 - **Added** - for new features.
 - **Changed** - for changes in existing functionality.

docs/source/about/contributor-guide.rst

@@ -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/__init__.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/component.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/dispatcher.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/events.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
 
 
@@ -561,15 +561,19 @@ class LifeCycleHook:
 
         .. testcode::
 
-            from idom.core.hooks import LifeCycleHook, DID_RENDER_EFFECT
+            from idom.core.hooks import (
+                current_hook,
+                LifeCycleHook,
+                COMPONENT_DID_RENDER_EFFECT,
+            )
 
 
             # this function will come from a layout implementation
             schedule_render = lambda: ...
 
             # --- start life cycle ---
 
-            hook = hooks.LifeCycle(schedule_render)
+            hook = LifeCycleHook(schedule_render)
 
             # --- start render cycle ---
 
@@ -582,11 +586,11 @@ class LifeCycleHook:
                 ...
 
                 # the component may access the current hook
-                assert hooks.current_hook() is hook
+                assert current_hook() is hook
 
                 # and save state or add effects
                 current_hook().use_state(lambda: ...)
-                current_hook().use_effect(DID_RENDER_EFFECT, lambda: ...)
+                current_hook().add_effect(COMPONENT_DID_RENDER_EFFECT, lambda: ...)
             finally:
                 hook.unset_current()