Rename StarletteResolver to ReactPyResolver.

Author: Archmonger

CHANGELOG.md

@@ -26,6 +26,7 @@ Don't forget to remove deprecated code on each major release!
 -   `link` element now calculates URL changes using the client.
 -   Refactoring related to `reactpy>=1.1.0` changes.
 -   Determination of the browser's initial URL is now deterministic.
+-   Rename `StarletteResolver` to `ReactPyResolver`.
 
 ### Fixed
 

src/reactpy_router/resolvers.py

@@ -9,13 +9,13 @@
 if TYPE_CHECKING:
     from reactpy_router.types import ConversionInfo, ConverterMapping, Route
 
-__all__ = ["StarletteResolver"]
+__all__ = ["ReactPyResolver"]
 
 
-class StarletteResolver:
-    """URL resolver that matches routes using starlette's URL routing syntax.
+class ReactPyResolver:
+    """URL resolver that can match a path against any given routes.
 
-    However, this resolver adds a few additional parameter types on top of Starlette's syntax."""
+    URL routing syntax for this resolver is based on Starlette, and supports a mixture of Starlette and Django parameter types."""
 
     def __init__(
         self,

src/reactpy_router/routers.py

@@ -13,7 +13,7 @@
 
 from reactpy_router.components import History
 from reactpy_router.hooks import RouteState, _route_state_context
-from reactpy_router.resolvers import StarletteResolver
+from reactpy_router.resolvers import ReactPyResolver
 from reactpy_router.types import MatchedRoute
 
 if TYPE_CHECKING:
@@ -36,7 +36,7 @@ def wrapper(*routes: Route) -> Component:
     return wrapper
 
 
-_starlette_router = create_router(StarletteResolver)
+_router = create_router(ReactPyResolver)
 
 
 def browser_router(*routes: Route) -> Component:
@@ -50,7 +50,7 @@ def browser_router(*routes: Route) -> Component:
     Returns:
         A router component that renders the given routes.
     """
-    return _starlette_router(*routes)
+    return _router(*routes)
 
 
 @component

tests/test_resolver.py

@@ -4,12 +4,12 @@
 import pytest
 
 from reactpy_router import route
-from reactpy_router.resolvers import StarletteResolver
+from reactpy_router.resolvers import ReactPyResolver
 from reactpy_router.types import MatchedRoute
 
 
 def test_resolve_any():
-    resolver = StarletteResolver(route("{404:any}", "Hello World"))
+    resolver = ReactPyResolver(route("{404:any}", "Hello World"))
     assert resolver.parse_path("{404:any}") == re.compile("^(?P<_numeric_404>.*)$")
     assert resolver.converter_mapping == {"_numeric_404": str}
     assert resolver.resolve("/hello/world") == MatchedRoute(
@@ -18,7 +18,7 @@ def test_resolve_any():
 
 
 def test_parse_path():
-    resolver = StarletteResolver(route("/", None))
+    resolver = ReactPyResolver(route("/", None))
     assert resolver.parse_path("/a/b/c") == re.compile("^/a/b/c$")
     assert resolver.converter_mapping == {}
 
@@ -48,13 +48,13 @@ def test_parse_path():
 
 
 def test_parse_path_unkown_conversion():
-    resolver = StarletteResolver(route("/", None))
+    resolver = ReactPyResolver(route("/", None))
     with pytest.raises(ValueError, match="Unknown conversion type 'unknown' in '/a/{b:unknown}/c'"):
         resolver.parse_path("/a/{b:unknown}/c")
 
 
 def test_parse_path_re_escape():
     """Check that we escape regex characters in the path"""
-    resolver = StarletteResolver(route("/", None))
+    resolver = ReactPyResolver(route("/", None))
     assert resolver.parse_path("/a/{b:int}/c.d") == re.compile(r"^/a/(?P<b>\d+)/c\.d$")
     assert resolver.converter_mapping == {"b": int}