Add type checking

Author: Archmonger

.github/workflows/test-python.yml

@@ -80,3 +80,18 @@ jobs:
         run: pip install --upgrade pip hatch uv
       - name: Check Python formatting
         run: hatch fmt src tests --check
+
+  python-types:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Install Python Dependencies
+        run: pip install --upgrade pip hatch uv
+      - name: Run Python type checker
+        run: hatch run python:type_check

docs/src/about/contributing.md

@@ -43,6 +43,7 @@ By utilizing `hatch`, the following commands are available to manage the develop
 | `hatch fmt --formatter` | Run only formatters |
 | `hatch run javascript:check` | Run the JavaScript linter/formatter |
 | `hatch run javascript:fix` | Run the JavaScript linter/formatter and write fixes to disk |
+| `hatch run python:type_check` | Run the Python type checker |
 
 ??? tip "Configure your IDE for linting"
 

src/reactpy_router/routers.py

@@ -7,8 +7,8 @@
 from typing import TYPE_CHECKING, Any, Literal, cast
 
 from reactpy import component, use_memo, use_state
-from reactpy.backend.hooks import ConnectionContext, use_connection
 from reactpy.backend.types import Connection, Location
+from reactpy.core.hooks import ConnectionContext, use_connection
 from reactpy.types import ComponentType, VdomDict
 
 from reactpy_router.components import FirstLoad, History
@@ -20,16 +20,16 @@
 
     from reactpy.core.component import Component
 
-    from reactpy_router.types import CompiledRoute, Resolver, Router, RouteType
+    from reactpy_router.types import CompiledRoute, Resolver, Route, Router
 
 __all__ = ["browser_router", "create_router"]
 _logger = getLogger(__name__)
 
 
-def create_router(resolver: Resolver[RouteType]) -> Router[RouteType]:
+def create_router(resolver: Resolver[Route]) -> Router[Route]:
     """A decorator that turns a resolver into a router"""
 
-    def wrapper(*routes: RouteType) -> Component:
+    def wrapper(*routes: Route) -> Component:
         return router(*routes, resolver=resolver)
 
     return wrapper
@@ -38,13 +38,13 @@ def wrapper(*routes: RouteType) -> Component:
 _starlette_router = create_router(StarletteResolver)
 
 
-def browser_router(*routes: RouteType) -> Component:
+def browser_router(*routes: Route) -> Component:
     """This is the recommended router for all ReactPy-Router web projects.
     It uses the JavaScript [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API)
     to manage the history stack.
 
     Args:
-        *routes (RouteType): A list of routes to be rendered by the router.
+        *routes (Route): A list of routes to be rendered by the router.
 
     Returns:
         A router component that renders the given routes.
@@ -54,8 +54,8 @@ def browser_router(*routes: RouteType) -> Component:
 
 @component
 def router(
-    *routes: RouteType,
-    resolver: Resolver[RouteType],
+    *routes: Route,
+    resolver: Resolver[Route],
 ) -> VdomDict | None:
     """A component that renders matching route(s) using the given resolver.
 
@@ -110,7 +110,7 @@ def on_first_load(event: dict[str, Any]) -> None:
     return None
 
 
-def _iter_routes(routes: Sequence[RouteType]) -> Iterator[RouteType]:
+def _iter_routes(routes: Sequence[Route]) -> Iterator[Route]:
     for parent in routes:
         for child in _iter_routes(parent.routes):
             yield replace(child, path=parent.path + child.path)  # type: ignore[misc]

src/reactpy_router/types.py

@@ -46,9 +46,6 @@ def __hash__(self) -> int:
         return hash((self.path, key, self.routes))
 
 
-RouteType = TypeVar("RouteType", bound=Route)
-"""A type variable for `Route`."""
-
 RouteType_contra = TypeVar("RouteType_contra", bound=Route, contravariant=True)
 """A contravariant type variable for `Route`."""
 
@@ -66,6 +63,7 @@ def __call__(self, *routes: RouteType_contra) -> Component:
         Returns:
             The resulting component after processing the routes.
         """
+        ...
 
 
 class Resolver(Protocol[RouteType_contra]):
@@ -81,6 +79,7 @@ def __call__(self, route: RouteType_contra) -> CompiledRoute:
         Returns:
             The compiled route.
         """
+        ...
 
 
 class CompiledRoute(Protocol):
@@ -104,6 +103,7 @@ def resolve(self, path: str) -> tuple[Any, dict[str, Any]] | None:
         Returns:
             A tuple containing the associated element and a dictionary of path parameters, or None if the path cannot be resolved.
         """
+        ...
 
 
 class ConversionInfo(TypedDict):