Replace mypy and black with ruff (#262)

Author: Archmonger

.github/workflows/test-docs.yml

@@ -29,4 +29,4 @@ jobs:
             - name: Check docs build
               run: hatch run docs:build
             - name: Check docs examples
-              run: hatch run docs:check_examples
+              run: hatch fmt docs --check

.github/workflows/test-python.yml

@@ -31,3 +31,18 @@ jobs:
               run: hatch test --python ${{ matrix.python-version }} --ds=test_app.settings_single_db -v
             - name: Run Multi-DB Tests
               run: hatch test --python ${{ matrix.python-version }} --ds=test_app.settings_multi_db -v
+
+    python-formatting:
+        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: Check Python formatting
+              run: hatch fmt src tests --check

CHANGELOG.md

@@ -10,11 +10,10 @@
 
 
 from channels.routing import ProtocolTypeRouter, URLRouter  # noqa: E402
+
 from reactpy_django import REACTPY_WEBSOCKET_ROUTE  # noqa: E402
 
-application = ProtocolTypeRouter(
-    {
-        "http": django_asgi_app,
-        "websocket": URLRouter([REACTPY_WEBSOCKET_ROUTE]),
-    }
-)
+application = ProtocolTypeRouter({
+    "http": django_asgi_app,
+    "websocket": URLRouter([REACTPY_WEBSOCKET_ROUTE]),
+})

docs/examples/html/pyscript-component.html renamed to docs/examples/html/pyscript_component.html

@@ -1,5 +1,6 @@
 # Broken load order, only used for linting
 from channels.routing import ProtocolTypeRouter, URLRouter
+
 from reactpy_django import REACTPY_WEBSOCKET_ROUTE
 
 django_asgi_app = ""
@@ -8,9 +9,7 @@
 # start
 from channels.auth import AuthMiddlewareStack  # noqa: E402
 
-application = ProtocolTypeRouter(
-    {
-        "http": django_asgi_app,
-        "websocket": AuthMiddlewareStack(URLRouter([REACTPY_WEBSOCKET_ROUTE])),
-    }
-)
+application = ProtocolTypeRouter({
+    "http": django_asgi_app,
+    "websocket": AuthMiddlewareStack(URLRouter([REACTPY_WEBSOCKET_ROUTE])),
+})

docs/examples/html/pyscript-initial-object.html renamed to docs/examples/html/pyscript_initial_object.html

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.components import django_css
 
 

docs/examples/html/pyscript-initial-string.html renamed to docs/examples/html/pyscript_initial_string.html

@@ -4,8 +4,6 @@
 @component
 def my_component():
     return html.div(
-        html.link(
-            {"rel": "stylesheet", "href": "https://example.com/external-styles.css"}
-        ),
+        html.link({"rel": "stylesheet", "href": "https://example.com/external-styles.css"}),
         html.button("My Button!"),
     )

docs/examples/html/pyscript-local-import.html renamed to docs/examples/html/pyscript_local_import.html

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.components import django_js
 
 

docs/examples/html/pyscript-multiple-files.html renamed to docs/examples/html/pyscript_multiple_files.html

@@ -1,5 +1,6 @@
-from example.models import TodoItem
 from reactpy import component
+
+from example.models import TodoItem
 from reactpy_django.hooks import use_query
 from reactpy_django.utils import django_query_postprocessor
 

docs/examples/html/pyscript-root.html renamed to docs/examples/html/pyscript_root.html

@@ -1,7 +1,8 @@
 from reactpy import component, html
-from reactpy_django.router import django_router
 from reactpy_router import route
 
+from reactpy_django.router import django_router
+
 
 @component
 def my_component():

docs/examples/html/pyscript-setup.html renamed to docs/examples/html/pyscript_setup.html

@@ -0,0 +1,3 @@
+"""This module exists only to satisfy type checkers.
+
+Do not use the files in this module as examples within the docs."""

docs/examples/html/pyscript-setup-config-object.html renamed to docs/examples/html/pyscript_setup_config_object.html

@@ -0,0 +1,6 @@
+"""This module exists only to satisfy type checkers.
+
+Do not use the files in this module as examples within the docs."""
+
+
+def child_component(): ...

docs/examples/html/pyscript-setup-config-string.html renamed to docs/examples/html/pyscript_setup_config_string.html

@@ -1,5 +1,8 @@
-from django.shortcuts import render
+"""This module exists only to satisfy type checkers.
 
+Do not use the files in this module as examples within the docs."""
 
-def index(request):
-    return render(request, "my_template.html")
+from python.hello_world_cbv import HelloWorld
+from python.hello_world_fbv import hello_world
+
+__all__ = ["HelloWorld", "hello_world"]

docs/examples/html/pyscript-setup-dependencies.html renamed to docs/examples/html/pyscript_setup_dependencies.html

@@ -1,4 +1,5 @@
 from django.urls import path
+
 from example import views
 
 urlpatterns = [

docs/examples/html/pyscript-setup-extra-js-object.html renamed to docs/examples/html/pyscript_setup_extra_js_object.html

@@ -0,0 +1,5 @@
+from django.shortcuts import render
+
+
+def index(request):
+    return render(request, "my_template.html")

docs/examples/html/pyscript-setup-extra-js-string.html renamed to docs/examples/html/pyscript_setup_extra_js_string.html

@@ -1,7 +1,7 @@
 from django.apps import AppConfig
-from reactpy_django.utils import register_iframe
 
-from . import views
+from example import views
+from reactpy_django.utils import register_iframe
 
 
 class ExampleAppConfig(AppConfig):

docs/examples/html/pyscript-setup-local-interpreter.html renamed to docs/examples/html/pyscript_setup_local_interpreter.html

@@ -1,7 +1,7 @@
 from django.apps import AppConfig
-from reactpy_django.utils import register_iframe
 
-from . import views
+from example import views
+from reactpy_django.utils import register_iframe
 
 
 class ExampleAppConfig(AppConfig):

docs/examples/html/pyscript-ssr-parent.html renamed to docs/examples/html/pyscript_ssr_parent.html

@@ -4,8 +4,7 @@
 
 @component
 def root():
-
-    def onClick(event):
+    def on_click(event):
         js.document.title = "New window title"
 
-    return html.button({"onClick": onClick}, "Click Me!")
+    return html.button({"onClick": on_click}, "Click Me!")

docs/examples/html/pyscript-tag.html renamed to docs/examples/html/pyscript_tag.html

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.components import pyscript_component
 
 

docs/examples/python/configure-asgi.py renamed to docs/examples/python/configure_asgi.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.components import pyscript_component
 
 

docs/examples/python/configure-asgi-middleware.py renamed to docs/examples/python/configure_asgi_middleware.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.components import pyscript_component
 
 

docs/examples/python/configure-channels-asgi-app.py renamed to docs/examples/python/configure_channels_asgi_app.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.components import pyscript_component
 
 

docs/examples/python/configure-channels-installed-app.py renamed to docs/examples/python/configure_channels_installed_app.py

@@ -1,9 +1,6 @@
-from typing import TYPE_CHECKING
-
 from reactpy import component, html
 
-if TYPE_CHECKING:
-    from .child import child_component
+from example.components import child_component
 
 
 @component

docs/examples/python/configure-installed-apps.py renamed to docs/examples/python/configure_installed_apps.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.components import pyscript_component
 
 

docs/examples/python/configure-urls.py renamed to docs/examples/python/configure_urls.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.html import pyscript
 
 example_source_code = """

docs/examples/python/django-css.py renamed to docs/examples/python/django_css.py

@@ -1,4 +1,5 @@
 from django.apps import AppConfig
+
 from reactpy_django.utils import register_component
 
 

docs/examples/python/django-css-external-link.py renamed to docs/examples/python/django_css_external_link.py

@@ -1,4 +1,5 @@
 from reactpy import component, hooks, html
+
 from reactpy_django.hooks import use_channel_layer
 
 

docs/examples/python/django-css-local-link.py renamed to docs/examples/python/django_css_local_link.py

@@ -1,4 +1,5 @@
 from reactpy import component, hooks, html
+
 from reactpy_django.hooks import use_channel_layer
 
 

docs/examples/python/django-js.py renamed to docs/examples/python/django_js.py

@@ -1,4 +1,5 @@
 from reactpy import component, hooks, html
+
 from reactpy_django.hooks import use_channel_layer
 
 

docs/examples/python/django-js-local-script.py renamed to docs/examples/python/django_js_local_script.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.hooks import use_connection
 
 

docs/examples/python/django-js-remote-script.py renamed to docs/examples/python/django_js_remote_script.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.hooks import use_location
 
 

docs/examples/python/django-query-postprocessor.py renamed to docs/examples/python/django_query_postprocessor.py

@@ -1,5 +1,6 @@
-from example.models import TodoItem
 from reactpy import component, html
+
+from example.models import TodoItem
 from reactpy_django.hooks import use_mutation
 
 

docs/examples/python/django-router.py renamed to docs/examples/python/django_router.py

@@ -1,15 +1,13 @@
 from reactpy import component
+
 from reactpy_django.hooks import use_mutation
 
 
-def example_mutation(value: int, other_value: bool = False):
-    ...
+def example_mutation(value: int, other_value: bool = False): ...
 
 
 @component
 def my_component():
     mutation = use_mutation(example_mutation)
 
     mutation(123, other_value=True)
-
-    ...

docs/examples/python/example/__init__.py

@@ -1,5 +1,6 @@
-from example.models import TodoItem
 from reactpy import component, html
+
+from example.models import TodoItem
 from reactpy_django.hooks import use_mutation, use_query
 
 
@@ -26,9 +27,7 @@ def submit_event(event):
     elif item_query.error or not item_query.data:
         rendered_items = html.h2("Error when loading!")
     else:
-        rendered_items = html.ul(
-            html.li(item.text, key=item.pk) for item in item_query.data
-        )
+        rendered_items = html.ul(html.li(item.text, key=item.pk) for item in item_query.data)
 
     # Handle all possible mutation states
     if item_mutation.loading:

docs/examples/python/example/components.py

@@ -1,5 +1,6 @@
-from example.models import TodoItem
 from reactpy import component, html
+
+from example.models import TodoItem
 from reactpy_django.hooks import use_mutation
 
 

docs/examples/python/example/views.py

@@ -1,10 +1,10 @@
 from reactpy import component, html
+
 from reactpy_django.hooks import use_mutation
 
 
 def execute_thread_safe_mutation(text):
     """This is an example mutation function that does some thread-safe operation."""
-    pass
 
 
 @component

docs/examples/python/example/urls.py renamed to docs/examples/python/first_urls.py

@@ -1,4 +1,5 @@
 from reactpy import component, html
+
 from reactpy_django.hooks import use_origin
 
 

docs/examples/python/first_view.py

@@ -1,6 +1,7 @@
 from channels.db import database_sync_to_async
-from example.models import TodoItem
 from reactpy import component, html
+
+from example.models import TodoItem
 from reactpy_django.hooks import use_query
 
 
@@ -17,8 +18,6 @@ def todo_list():
     elif item_query.error or not item_query.data:
         rendered_items = html.h2("Error when loading!")
     else:
-        rendered_items = html.ul(
-            [html.li(item.text, key=item.pk) for item in item_query.data]
-        )
+        rendered_items = html.ul([html.li(item.text, key=item.pk) for item in item_query.data])
 
     return html.div("Rendered items: ", rendered_items)

docs/examples/python/hello_world_app_config_cbv.py

@@ -1,4 +1,5 @@
 from reactpy import component
+
 from reactpy_django.hooks import use_query
 
 

docs/examples/python/hello_world_app_config_fbv.py

@@ -1,4 +1,5 @@
 from reactpy import component
+
 from reactpy_django.hooks import use_query
 
 
@@ -11,7 +12,6 @@ def my_postprocessor(data, example_kwarg=True):
 
 def execute_io_intensive_operation():
     """This is an example query function that does something IO intensive."""
-    pass
 
 
 @component

docs/examples/python/pyodide-js-module.py renamed to docs/examples/python/pyodide_js_module.py

@@ -1,10 +1,10 @@
 from reactpy import component
+
 from reactpy_django.hooks import use_query
 
 
 def execute_io_intensive_operation():
     """This is an example query function that does something IO intensive."""
-    pass
 
 
 @component

docs/examples/python/pyscript-component-initial-object.py renamed to docs/examples/python/pyscript_component_initial_object.py

@@ -1,5 +1,6 @@
-from example.models import TodoItem
 from reactpy import component
+
+from example.models import TodoItem
 from reactpy_django.hooks import use_query