run hatch fmt

Author: Archmonger

.github/workflows/publish-py.yaml

@@ -22,7 +22,7 @@ jobs:
           pip install -r requirements/build-pkg.txt
       - name: Build Package
         run: |
-          hatch build
+          hatch build --clean
       - name: Publish to PyPI
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

docs/examples/python/basic-routing.py renamed to docs/examples/python/basic_routing.py

@@ -1,3 +1,4 @@
+import operator
 from typing import TypedDict
 
 from reactpy import component, html, run
@@ -41,7 +42,7 @@ def home():
 
 @component
 def all_messages():
-    last_messages = {", ".join(msg["with"]): msg for msg in sorted(message_data, key=lambda m: m["id"])}
+    last_messages = {", ".join(msg["with"]): msg for msg in sorted(message_data, key=operator.itemgetter("id"))}
 
     messages = []
     for msg in last_messages.values():

docs/examples/python/basic-routing-more-routes.py renamed to docs/examples/python/basic_routing_more_routes.py

@@ -1,3 +1,4 @@
+import operator
 from typing import TypedDict
 
 from reactpy import component, html, run
@@ -39,7 +40,7 @@ def home():
 
 @component
 def all_messages():
-    last_messages = {", ".join(msg["with"]): msg for msg in sorted(message_data, key=lambda m: m["id"])}
+    last_messages = {", ".join(msg["with"]): msg for msg in sorted(message_data, key=operator.itemgetter("id"))}
     messages = []
     for msg in last_messages.values():
         msg_hyperlink = link(

docs/examples/python/nested-routes.py renamed to docs/examples/python/nested_routes.py

@@ -13,5 +13,5 @@ You're now ready to start building your own ReactPy applications with URL routin
 === "components.py"
 
     ```python
-    {% include "../examples/python/basic-routing.py" %}
+    {% include "../examples/python/basic_routing.py" %}
     ```

docs/examples/python/route-links.py renamed to docs/examples/python/route_links.py

@@ -13,7 +13,7 @@ The [`use_search_params`][reactpy_router.use_search_params] hook can be used to
 === "components.py"
 
     ```python
-    {% include "../../examples/python/use-search-params.py" %}
+    {% include "../../examples/python/use_search_params.py" %}
     ```
 
 ## Use Parameters
@@ -23,5 +23,5 @@ The [`use_params`][reactpy_router.use_params] hook can be used to access route p
 === "components.py"
 
     ```python
-    {% include "../../examples/python/use-params.py" %}
+    {% include "../../examples/python/use_params.py" %}
     ```

docs/examples/python/route-parameters.py renamed to docs/examples/python/route_parameters.py

@@ -16,7 +16,7 @@ Here's a basic example showing how to use `#!python browser_router` with two rou
 === "components.py"
 
     ```python
-    {% include "../../examples/python/basic-routing.py" %}
+    {% include "../../examples/python/basic_routing.py" %}
     ```
 
 Here we'll note some special syntax in the route path for the second route. The `#!python "any"` type is a wildcard that will match any path. This is useful for creating a default page or error page such as "404 NOT FOUND".
@@ -65,5 +65,5 @@ Links between routes should be created using the [link][reactpy_router.link] com
 === "components.py"
 
     ```python
-    {% include "../../examples/python/route-links.py" %}
+    {% include "../../examples/python/route_links.py" %}
     ```

docs/examples/python/use-params.py renamed to docs/examples/python/use_params.py

@@ -36,7 +36,7 @@ The first step is to create a basic router that will display the home page when
 === "components.py"
 
     ```python
-    {% include "../../examples/python/basic-routing.py" %}
+    {% include "../../examples/python/basic_routing.py" %}
     ```
 
 When navigating to [`http://127.0.0.1:8000`](http://127.0.0.1:8000) you should see `Home Page 🏠`. However, if you go to any other route you will instead see `Missing Link 🔗‍💥`.
@@ -46,7 +46,7 @@ With this foundation you can start adding more routes.
 === "components.py"
 
     ```python
-    {% include "../../examples/python/basic-routing-more-routes.py" %}
+    {% include "../../examples/python/basic_routing_more_routes.py" %}
     ```
 
 With this change you can now also go to [`/messages`](http://127.0.0.1:8000/messages) to see `Messages 💬`.
@@ -58,7 +58,7 @@ Instead of using the standard `#!python reactpy.html.a` element to create links
 === "components.py"
 
     ```python
-    {% include "../../examples/python/route-links.py" %}
+    {% include "../../examples/python/route_links.py" %}
     ```
 
 Now, when you go to the home page, you can click `Messages` link to go to [`/messages`](http://127.0.0.1:8000/messages).
@@ -70,7 +70,7 @@ Routes can be nested in order to construct more complicated application structur
 === "components.py"
 
     ```python
-    {% include "../../examples/python/nested-routes.py" %}
+    {% include "../../examples/python/nested_routes.py" %}
     ```
 
 ## Adding Route Parameters
@@ -84,5 +84,5 @@ If we take this information and apply it to our growing example application we'd
 === "components.py"
 
     ```python
-    {% include "../../examples/python/route-parameters.py" %}
+    {% include "../../examples/python/route_parameters.py" %}
     ```

docs/examples/python/use-search-params.py renamed to docs/examples/python/use_search_params.py

@@ -113,7 +113,6 @@ lint.extend-ignore = [
   "SLF001",  # Private member accessed
 ]
 lint.preview = true
-lint.isort.known-first-party = ["src", "tests"]
 extend-exclude = [".venv/*", ".eggs/*", "build/*"]
 
 [tool.pytest.ini_options]

docs/src/index.md

@@ -2,16 +2,16 @@
 __version__ = "1.0.0"
 
 
-from .components import link, navigate, route
-from .hooks import use_params, use_search_params
-from .routers import browser_router, create_router
+from reactpy_router.components import link, navigate, route
+from reactpy_router.hooks import use_params, use_search_params
+from reactpy_router.routers import browser_router, create_router
 
 __all__ = (
+    "browser_router",
     "create_router",
     "link",
+    "navigate",
     "route",
-    "browser_router",
     "use_params",
     "use_search_params",
-    "navigate",
 )

docs/src/learn/hooks.md

@@ -1,19 +1,21 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Any
+from typing import TYPE_CHECKING, Any
 from urllib.parse import urljoin
 from uuid import uuid4
 
 from reactpy import component, html, use_connection
 from reactpy.backend.types import Location
-from reactpy.core.component import Component
-from reactpy.core.types import Key, VdomDict
 from reactpy.web.module import export, module_from_file
 
 from reactpy_router.hooks import _use_route_state
 from reactpy_router.types import Route
 
+if TYPE_CHECKING:
+    from reactpy.core.component import Component
+    from reactpy.core.types import Key, VdomDict
+
 History = export(
     module_from_file("reactpy-router", file=Path(__file__).parent / "static" / "bundle.js"),
     ("History"),
@@ -68,7 +70,8 @@ def _link(attributes: dict[str, Any], *children: Any) -> VdomDict:
     if "href" in attributes and "to" not in attributes:
         attributes["to"] = attributes.pop("href")
     if "to" not in attributes:  # pragma: no cover
-        raise ValueError("The `to` attribute is required for the `Link` component.")
+        msg = "The `to` attribute is required for the `Link` component."
+        raise ValueError(msg)
     to = attributes.pop("to")
 
     attrs = {

docs/src/learn/routers-routes-and-links.md

@@ -1,23 +1,27 @@
 from __future__ import annotations
 
-from typing import Any
+from typing import TYPE_CHECKING, Any
 from urllib.parse import parse_qs
 
 from reactpy import create_context, use_context, use_location
-from reactpy.types import Context
 
-from reactpy_router.types import RouteState
+from reactpy_router.types import RouteState  # noqa: TCH001
+
+if TYPE_CHECKING:
+    from reactpy.types import Context
+
 
 _route_state_context: Context[RouteState | None] = create_context(None)
 
 
 def _use_route_state() -> RouteState:
     route_state = use_context(_route_state_context)
     if route_state is None:  # pragma: no cover
-        raise RuntimeError(
+        msg = (
             "ReactPy-Router was unable to find a route context. Are you "
             "sure this hook/component is being called within a router?"
         )
+        raise RuntimeError(msg)
 
     return route_state
 

docs/src/learn/your-first-app.md

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
 import re
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 from reactpy_router.converters import CONVERTERS
-from reactpy_router.types import ConversionInfo, ConverterMapping, Route
+
+if TYPE_CHECKING:
+    from reactpy_router.types import ConversionInfo, ConverterMapping, Route
 
 __all__ = ["StarletteResolver"]
 
@@ -48,7 +50,8 @@ def parse_path(self, path: str) -> re.Pattern[str]:
             try:
                 conversion_info = self.registered_converters[param_type]
             except KeyError as e:
-                raise ValueError(f"Unknown conversion type {param_type!r} in {path!r}") from e
+                msg = f"Unknown conversion type {param_type!r} in {path!r}"
+                raise ValueError(msg) from e
 
             # Add the string before the match to the pattern
             pattern += re.escape(path[last_match_end : match.start()])

noxfile.py

@@ -4,18 +4,23 @@
 
 from dataclasses import replace
 from logging import getLogger
-from typing import Any, Iterator, Literal, Sequence, cast
+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.component import Component
 from reactpy.types import ComponentType, VdomDict
 
 from reactpy_router.components import FirstLoad, History
 from reactpy_router.hooks import RouteState, _route_state_context
 from reactpy_router.resolvers import StarletteResolver
-from reactpy_router.types import CompiledRoute, Resolver, Router, RouteType
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator, Sequence
+
+    from reactpy.core.component import Component
+
+    from reactpy_router.types import CompiledRoute, Resolver, Router, RouteType
 
 __all__ = ["browser_router", "create_router"]
 _logger = getLogger(__name__)

pyproject.toml

@@ -3,14 +3,18 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
-from typing import Any, Callable, Sequence, TypedDict, TypeVar
+from typing import TYPE_CHECKING, Any, Callable, TypedDict, TypeVar
 
-from reactpy.backend.types import Location
-from reactpy.core.component import Component
 from reactpy.core.vdom import is_vdom
-from reactpy.types import Key
 from typing_extensions import Protocol, Self, TypeAlias
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+    from reactpy.backend.types import Location
+    from reactpy.core.component import Component
+    from reactpy.types import Key
+
 ConversionFunc: TypeAlias = Callable[[str], Any]
 """A function that converts a string to a specific type."""
 

src/reactpy_router/__init__.py

@@ -17,9 +17,13 @@ def pytest_addoption(parser) -> None:
     )
 
 
+def pytest_sessionstart(session):
+    """Rebuild the project before running the tests to get the latest JavaScript"""
+    subprocess.run(["hatch", "build", "--clean"], check=True)
+
+
 @pytest.fixture(scope="session")
 async def display(backend, browser):
-    subprocess.run(["hatch", "build"], check=True)
     async with DisplayFixture(backend, browser) as display_fixture:
         display_fixture.page.set_default_timeout(10000)
         yield display_fixture

src/reactpy_router/components.py

@@ -46,7 +46,7 @@ def test_parse_path():
 
 def test_parse_path_unkown_conversion():
     resolver = StarletteResolver(route("/", None))
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError, match="Unknown conversion type 'unknown' in '/a/{b:unknown}/c'"):
         resolver.parse_path("/a/{b:unknown}/c")
 
 

src/reactpy_router/hooks.py

@@ -136,7 +136,7 @@ def sample():
 
     await display.show(sample)
 
-    for path, expected_params in [
+    for path, _expected_params in [
         ("/first/1", {"first": "1"}),
         ("/first/1/second/2", {"first": "1", "second": "2"}),
         ("/first/1/second/2/third/3", {"first": "1", "second": "2", "third": "3"}),