require a my_app.idom.components attribute

Author: rmorshea

src/django_idom/app_components.py

@@ -27,24 +27,26 @@ def has_component(name: str) -> bool:
         logger.debug(f"Skipping {idom_mod_name!r} - does not exist")
         continue
 
-    if not hasattr(idom_mod, "__all__"):
+    if not hasattr(idom_mod, "components"):
         logger.warning(
             f"'django_idom' expected module {idom_mod_name!r} to have an "
-            "'__all__' attribute that lists its publically available components."
+            "'components' attribute that lists its publically available components."
         )
         continue
 
-    for component_name in idom_mod.__all__:
-        try:
-            component_constructor = getattr(idom_mod, component_name)
-        except AttributeError:
+    for component_constructor in idom_mod.components:
+        if not callable(component_constructor):
             logger.warning(
-                f"Module {idom_mod_name!r} has no attribute {component_name!r}"
+                f"'{idom_mod_name}.{component_name}' is not a callable component constructor"
             )
             continue
 
-        if not callable(component_constructor):
-            logger.warning(f"'{idom_mod_name}.{component_name}' is not a component")
+        try:
+            component_name = getattr(component_constructor, "__name__")
+        except AttributeError:
+            logger.warning(
+                f"Component constructor {component_constructor} has not attribute '__name__'"
+            )
             continue
 
         _LOADED_COMPONENTS[f"{app_mod_name}.{component_name}"] = component_constructor

tests/test_app/components.py

@@ -0,0 +1,21 @@
+import idom
+
+
+@idom.component
+def HelloWorld():
+    return idom.html.h1({"id": "hello-world"}, "Hello World!")
+
+
+@idom.component
+def Button():
+    count, set_count = idom.hooks.use_state(0)
+    return idom.html.div(
+        idom.html.button(
+            {"id": "counter-inc", "onClick": lambda event: set_count(count + 1)},
+            "Click me!",
+        ),
+        idom.html.p(
+            {"id": "counter-num", "data-count": count},
+            f"Current count is: {count}",
+        ),
+    )

tests/test_app/idom.py

@@ -1,24 +1,7 @@
-import idom
+from .components import Button, HelloWorld
 
 
-__all__ = "HelloWorld", "Button"
-
-
-@idom.component
-def HelloWorld():
-    return idom.html.h1({"id": "hello-world"}, "Hello World!")
-
-
-@idom.component
-def Button():
-    count, set_count = idom.hooks.use_state(0)
-    return idom.html.div(
-        idom.html.button(
-            {"id": "counter-inc", "onClick": lambda event: set_count(count + 1)},
-            "Click me!",
-        ),
-        idom.html.p(
-            {"id": "counter-num", "data-count": count},
-            f"Current count is: {count}",
-        ),
-    )
+components = [
+    HelloWorld,
+    Button,
+]