Merge pull request #42 from volfpeter/fix/src-layout-without-package

Fix: src layout without package

Author: volfpeter

.coderabbit.yaml

@@ -0,0 +1,3 @@
+issue_enrichment:
+  auto_enrich:
+    enabled: false

docs/guides/forms.md

@@ -106,7 +106,7 @@ from holm import Metadata
 
 
 @component.context_only
-def head(context: Context) -> html.head:
+def head(context: Context) -> ComponentType:
     """
     Helper component that returns the entire head element of the page.
 
@@ -130,7 +130,7 @@ def head(context: Context) -> html.head:
 Next we can add the search form:
 
 ```python
-def search_form(q: str, *, autofocus: bool) -> html.form:
+def search_form(q: str, *, autofocus: bool) -> ComponentType:
     """
     Search form for the layout.
 
@@ -200,7 +200,7 @@ The description implies that the page looks essentially the same both on initial
 from typing import Annotated
 
 from fastapi import Form
-from htmy import Component, XBool, html
+from htmy import ComponentType, Component, XBool, html
 from todo_service import create_todo, find_todos
 
 
@@ -211,7 +211,7 @@ def page_content(
     title_invalid: bool = False,
     description: str = "",
     description_invalid: bool = False,
-) -> html.div:
+) -> ComponentType:
     """
     Returns the common page content for `page()` and `handle_submit()`.
 

docs/guides/path-parameters.md

@@ -203,7 +203,7 @@ With that said, let's create the user profile page:
 from typing import Annotated
 
 from fastapi import Depends
-from htmy import html
+from htmy import ComponentType, html
 
 from ..service import User, get_user
 
@@ -235,7 +235,7 @@ def metadata(id: int, user: DependsUser) -> dict[str, str]:
     }
 
 
-async def page(user: DependsUser) -> html.div:
+async def page(user: DependsUser) -> ComponentType:
     """
     Page function that uses the `DependsUser` annotated FastAPI dependency
     to get the user whose ID was submitted in the `{id}` path parameter.

docs/in-a-hurry.md

@@ -44,17 +44,17 @@ Example:
 
 ```python
 # my_app/page.py
-from htmy import html
+from htmy import ComponentType, html
 
-def page() -> html.div:
+def page() -> ComponentType:
     return html.div("Hello, world!")
 ```
 
 ```python
 # my_app/layout.py
-from htmy import html
+from htmy import ComponentType, html
 
-def layout(children: html.div) -> html.html:
+def layout(children: ComponentType) -> ComponentType:
     return html.html(
         html.head(html.title("My App")),
         html.body(children),  # <- The html.div page() returns
@@ -69,30 +69,30 @@ Example:
 
 ```python
 # my_app/page.py
-from htmy import html
+from htmy import ComponentType, html
 
 def metadata() -> dict[str, str]:
     """Metadata dependency for the page."""
     return {"title": "My App"}
 
-def page() -> html.div:
+def page() -> ComponentType:
     return html.div("Hello, world!")
 ```
 
 ```python
 # my_app/layout.py
-from htmy import Context, component, html
+from htmy import ComponentType, Context, component, html
 
 from holm import Metadata
 
 @component
-def head(default_title: str, context: Context) -> html.head:
+def head(default_title: str, context: Context) -> ComponentType:
     """Custom head component that can access page metadata from the htmy context."""
     metadata = Metadata.from_context(context)  # <- The mapping the `metadata` dependency of the page returned
     title = metadata.get("title", default_title)
     return html.head(html.title(title))
 
-def layout(children: html.div) -> html.html:
+def layout(children: ComponentType) -> ComponentType:
     return html.html(
         head("My App"),  # <- Our custom head component
         html.body(children),  # <- The html.div page() returns

examples/forms/layout.py

@@ -5,7 +5,7 @@
 
 
 @component.context_only
-def head(context: Context) -> html.head:
+def head(context: Context) -> ComponentType:
     """
     Helper component that returns the entire head element of the page.
 
@@ -25,7 +25,7 @@ def head(context: Context) -> html.head:
     )
 
 
-def search_form(q: str, *, autofocus: bool) -> html.form:
+def search_form(q: str, *, autofocus: bool) -> ComponentType:
     """
     Search form for the layout.
 

examples/forms/page.py

@@ -1,7 +1,7 @@
 from typing import Annotated
 
 from fastapi import Form
-from htmy import Component, XBool, html
+from htmy import Component, ComponentType, XBool, html
 from todo_service import create_todo, find_todos
 
 
@@ -12,7 +12,7 @@ def page_content(
     title_invalid: bool = False,
     description: str = "",
     description_invalid: bool = False,
-) -> html.div:
+) -> ComponentType:
     """
     Returns the common page content for `page()` and `handle_submit()`.
 

examples/path-parameters/user/_id_/page.py

@@ -1,7 +1,7 @@
 from typing import Annotated
 
 from fastapi import Depends
-from htmy import html
+from htmy import ComponentType, html
 
 from ..service import User, get_user
 
@@ -33,7 +33,7 @@ def metadata(id: int, user: DependsUser) -> dict[str, str]:
     }
 
 
-async def page(user: DependsUser) -> html.div:
+async def page(user: DependsUser) -> ComponentType:
     """
     Page function that uses the `DependsUser` annotated FastAPI dependency
     to get the user whose ID was submitted in the `{id}` path parameter.

holm/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.7.1"
+__version__ = "0.7.2"
 
 from .app import App as App
 from .fastapi import FastAPIDependency as FastAPIDependency

holm/_model.py

@@ -85,6 +85,15 @@ def _find_app_package_name(cls) -> str:
         raise ValueError("Could not determine the application package.")
 
 
+_no_app_package_roots: set[str] = {"", "."}
+"""
+Special package names that are encountered when the application is not wrapped in a Python package.
+
+- "": src layout
+- ".": flat layout
+"""
+
+
 @dataclass(frozen=True, kw_only=True, slots=True)
 class PackageInfo:
     """
@@ -131,14 +140,13 @@ def import_module(
             ValueError: If the module is invalid.
         """
         # Check if the module exists. Trying to import it and catching the exception would hide possible
-        # import error that occur in within the module, which is undesired because it would be hard for
+        # import errors that occur within the module, which is undesired because it would be hard for
         # users to find why an API is not registered.
         if not (self.package_dir / f"{name}.py").is_file():
             return None
 
         # Support applications that are not wrapped in a Python package.
-        # In that case `self.package_name` is ".".
-        import_name = name if self.package_name == "." else f"{self.package_name}.{name}"
+        import_name = name if self.package_name in _no_app_package_roots else f"{self.package_name}.{name}"
         try:
             module = import_module(import_name)
         except Exception:

test_app/user/_user_id_/api.py

@@ -1,6 +1,6 @@
 from fastapi import APIRouter
 from fasthx.htmy import HTMY
-from htmy import html
+from htmy import ComponentType, html
 
 
 def api(htmy: HTMY) -> APIRouter:
@@ -22,7 +22,7 @@ async def get_user(user_id: str) -> dict[str, str]:
     return api
 
 
-def user_card(user: dict[str, str]) -> html.div:
+def user_card(user: dict[str, str]) -> ComponentType:
     return html.div(
         html.h2(user["name"]),
         html.p(f"ID: {user['id']}"),