potentially working check workflows

Archmonger · Archmonger · commit 9369442b9ca2 · 2025-01-19T21:11:40.000-08:00
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -15,34 +15,32 @@ jobs:
         uses: ./.github/workflows/.hatch-run.yml
         with:
             job-name: "python-{0}"
-            hatch-run: "test-py"
+            run-cmd: "hatch test --cover"
     lint-py:
         uses: ./.github/workflows/.hatch-run.yml
         with:
             job-name: "python-{0}"
-            hatch-run: "lint-py"
+            run-cmd: "hatch run python:check"
     test-py-matrix:
         uses: ./.github/workflows/.hatch-run.yml
         with:
             job-name: "python-{0} {1}"
-            hatch-run: "test-py --no-cov"
+            run-cmd: "hatch test"
             runs-on: '["ubuntu-latest", "macos-latest", "windows-latest"]'
             python-version: '["3.9", "3.10", "3.11"]'
     test-docs:
         uses: ./.github/workflows/.hatch-run.yml
         with:
             job-name: "python-{0}"
-            hatch-run: "test-docs"
-            # as of Dec 2023 lxml does have wheels for 3.12
-            # https://bugs.launchpad.net/lxml/+bug/2040440
+            run-cmd: "hatch run docs:check"
             python-version: '["3.11"]'
     test-js:
         uses: ./.github/workflows/.hatch-run.yml
         with:
             job-name: "{1}"
-            hatch-run: "test-js"
+            run-cmd: "hatch run javascript:test"
     lint-js:
         uses: ./.github/workflows/.hatch-run.yml
         with:
             job-name: "{1}"
-            hatch-run: "lint-js"
+            run-cmd: "hatch run javascript:check"
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
-## The MIT License (MIT)
+The MIT License (MIT)
 
-#### Copyright (c) Reactive Python and affiliates.
+Copyright (c) Reactive Python and affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
diff --git a/docs/README.md b/docs/README.md
@@ -1,20 +1,3 @@
 # ReactPy's Documentation
 
-We provide two main ways to run the docs. Both use
-[`nox`](https://pypi.org/project/nox/):
-
-- `nox -s docs` - displays the docs and rebuilds when files are modified.
-- `nox -s docs-in-docker` - builds a docker image and runs the docs from there.
-
-If any changes to the core of the documentation are made (i.e. to non-`*.rst` files),
-then you should run a manual test of the documentation using the `docs_in_docker`
-session.
-
-If you wish to build and run the docs by hand you need to perform two commands, each
-being run from the root of the repository:
-
-- `sphinx-build -b html docs/source docs/build`
-- `python scripts/run_docs.py`
-
-The first command constructs the static HTML and any Javascript. The latter actually
-runs the web server that serves the content.
+...
diff --git a/docs/poetry.lock b/docs/poetry.lock
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -7,8 +7,8 @@ readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.9"
-reactpy = { path = "../src/py/reactpy", extras = ["starlette", "sanic", "fastapi", "flask", "tornado", "testing"], develop = false }
 furo = "2022.04.07"
+reactpy = { path = "..", extras = ["all"], develop = false }
 sphinx = "*"
 sphinx-autodoc-typehints = "*"
 sphinx-copybutton = "*"
diff --git a/docs/source/_custom_js/package-lock.json b/docs/source/_custom_js/package-lock.json
diff --git a/docs/source/_exts/autogen_api_docs.py b/docs/source/_exts/autogen_api_docs.py
@@ -8,7 +8,7 @@
 
 HERE = Path(__file__).parent
 SRC = HERE.parent.parent.parent / "src"
-PYTHON_PACKAGE = SRC / "py" / "reactpy" / "reactpy"
+PYTHON_PACKAGE = SRC / "reactpy"
 
 AUTO_DIR = HERE.parent / "_auto"
 AUTO_DIR.mkdir(exist_ok=True)
diff --git a/pyproject.toml b/pyproject.toml
@@ -132,29 +132,48 @@ cov = ["test-cov {args}", "cov-report"]
 [tool.hatch.envs.default.env-vars]
 REACTPY_DEBUG_MODE = "1"
 
+#######################################
+# >>> Hatch Documentation Scripts <<< #
+#######################################
+[tool.hatch.envs.docs]
+template = "docs"
+dependencies = ["poetry"]
+detached = true
+
+[tool.hatch.envs.docs.scripts]
+build = [
+  "cd docs && poetry install",
+  "cd docs && poetry run sphinx-build -a -T -W --keep-going -b doctest source build",
+]
+docker_build = [
+  "hatch run docs:build",
+  "cd docs && docker build . --file ./docs/Dockerfile --tag reactpy-docs:latest",
+]
+check = [
+  "cd docs && poetry install",
+  "cd docs && poetry run sphinx-build -a -T -W --keep-going -b doctest source build",
+  "cd docs && docker build . --file docs/Dockerfile",
+]
+
 ################################
 # >>> Hatch Python Scripts <<< #
 ################################
 
-[tool.hatch.envs.lint]
+[tool.hatch.envs.python]
 extra-dependencies = [
-  "black==24.1.1",
-  "ruff==0.0.278",
-  "flake8==7.0.0",
+  "ruff",
   "toml",
-  "flake8-pyproject",
-  "mypy",
-  "types-toml",
   "mypy==1.8",
+  "types-toml",
   "types-click",
   "types-tornado",
   "types-flask",
   "types-requests",
 ]
 
 [tool.hatch.envs.python.scripts]
-# TODO: Replace mypy with pylint
-type_check = "mypy --strict src/reactpy"
+# TODO: Replace mypy with pyright
+check = ["mypy --strict src/reactpy", "hatch fmt src/reactpy --check"]
 
 ############################
 # >>> Hatch JS Scripts <<< #
@@ -236,7 +255,7 @@ omit = ["reactpy/__main__.py"]
 [tool.ruff]
 target-version = "py39"
 line-length = 88
-select = [
+lint.select = [
   "A",
   "ARG",
   "B",
@@ -250,7 +269,6 @@ select = [
   # "FBT",
   "I",
   "ICN",
-  "ISC",
   "N",
   "PLC",
   "PLE",
@@ -265,7 +283,7 @@ select = [
   "W",
   "YTT",
 ]
-ignore = [
+lint.ignore = [
   # TODO: turn this on later
   "N802",
   "N806", # allow TitleCase functions/variables
@@ -299,22 +317,22 @@ ignore = [
   "PLR0913",
   "PLR0915",
 ]
-unfixable = [
+lint.unfixable = [
   # Don't touch unused imports
   "F401",
 ]
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 known-first-party = ["reactpy"]
 
-[tool.ruff.flake8-tidy-imports]
+[tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "all"
 
 [tool.flake8]
 select = ["RPY"]                                                  # only need to check with reactpy-flake8
 exclude = ["**/node_modules/*", ".eggs/*", ".tox/*", "**/venv/*"]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
 "**/tests/**/*" = ["PLR2004", "S101", "TID252"]
 "docs/**/*.py" = [
diff --git a/src/reactpy/_console/rewrite_camel_case_props.py b/src/reactpy/_console/rewrite_camel_case_props.py
@@ -2,7 +2,6 @@
 
 import ast
 import re
-import sys
 from copy import copy
 from keyword import kwlist
 from pathlib import Path
@@ -23,9 +22,6 @@
 @click.argument("paths", nargs=-1, type=click.Path(exists=True))
 def rewrite_camel_case_props(paths: list[str]) -> None:
     """Rewrite camelCase props to snake_case"""
-    if sys.version_info < (3, 9):  # nocov
-        msg = "This command requires Python>=3.9"
-        raise RuntimeError(msg)
 
     for p in map(Path, paths):
         for f in [p] if p.is_file() else p.rglob("*.py"):
diff --git a/src/reactpy/_console/rewrite_keys.py b/src/reactpy/_console/rewrite_keys.py
@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import ast
-import sys
 from pathlib import Path
 
 import click
@@ -45,9 +44,6 @@ def rewrite_keys(paths: list[str]) -> None:
     just above its changes. As such it requires manual intervention to put those
     comments back in their original location.
     """
-    if sys.version_info < (3, 9):  # nocov
-        msg = "This command requires Python>=3.9"
-        raise RuntimeError(msg)
 
     for p in map(Path, paths):
         for f in [p] if p.is_file() else p.rglob("*.py"):
diff --git a/src/reactpy/_warnings.py b/src/reactpy/_warnings.py
@@ -13,7 +13,7 @@ def warn(*args: Any, **kwargs: Any) -> Any:
 
 
 if TYPE_CHECKING:
-    warn = _warn  # noqa: F811
+    warn = _warn
 
 
 def _frame_depth_in_module() -> int:
diff --git a/src/reactpy/backend/tornado.py b/src/reactpy/backend/tornado.py
@@ -162,7 +162,7 @@ def _setup_single_view_dispatcher_route(
     ]
 
 
-class IndexHandler(RequestHandler):
+class IndexHandler(RequestHandler):  # type: ignore
     _index_html: str
 
     def initialize(self, index_html: str) -> None:
@@ -172,7 +172,7 @@ async def get(self, _: str) -> None:
         self.finish(self._index_html)
 
 
-class ModelStreamHandler(WebSocketHandler):
+class ModelStreamHandler(WebSocketHandler):  # type: ignore
     """A web-socket handler that serves up a new model stream to each new client"""
 
     _dispatch_future: Future[None]
@@ -202,7 +202,7 @@ async def recv() -> Any:
                         value=Connection(
                             scope=_FAKE_WSGI_CONTAINER.environ(self.request),
                             location=Location(
-                                pathname=f"/{path[len(self._url_prefix):]}",
+                                pathname=f"/{path[len(self._url_prefix) :]}",
                                 search=(
                                     f"?{self.request.query}"
                                     if self.request.query
diff --git a/src/reactpy/core/component.py b/src/reactpy/core/component.py
@@ -8,7 +8,7 @@
 
 
 def component(
-    function: Callable[..., ComponentType | VdomDict | str | None]
+    function: Callable[..., ComponentType | VdomDict | str | None],
 ) -> Callable[..., Component]:
     """A decorator for defining a new component.
 
diff --git a/src/reactpy/core/events.py b/src/reactpy/core/events.py
@@ -48,8 +48,8 @@ def event(
     .. code-block:: python
 
         @event(stop_propagation=True, prevent_default=True)
-        def my_callback(*data):
-            ...
+        def my_callback(*data): ...
+
 
         element = reactpy.html.button({"onClick": my_callback})
 
diff --git a/src/reactpy/core/vdom.py b/src/reactpy/core/vdom.py
@@ -282,7 +282,7 @@ def separate_attributes_and_children(
 
 
 def separate_attributes_and_event_handlers(
-    attributes: Mapping[str, Any]
+    attributes: Mapping[str, Any],
 ) -> tuple[dict[str, Any], EventHandlerDict]:
     separated_attributes = {}
     separated_event_handlers: dict[str, EventHandlerType] = {}
@@ -295,8 +295,7 @@ def separate_attributes_and_event_handlers(
         elif (
             # isinstance check on protocols is slow - use function attr pre-check as a
             # quick filter before actually performing slow EventHandlerType type check
-            hasattr(v, "function")
-            and isinstance(v, EventHandlerType)
+            hasattr(v, "function") and isinstance(v, EventHandlerType)
         ):
             handler = v
         else:
diff --git a/src/reactpy/html.py b/src/reactpy/html.py
@@ -458,6 +458,7 @@ def _script(
         .. code-block:: python
 
             import json
+
             my_script = html.script(f"console.log({json.dumps(user_bio)});")
 
         This would prevent the injection of Javascript code by escaping the ``user_bio``
diff --git a/src/reactpy/testing/backend.py b/src/reactpy/testing/backend.py
@@ -174,18 +174,22 @@ def _hotswap(update_on_change: bool = False) -> tuple[_MountFunc, ComponentConst
             show, root = reactpy.hotswap()
             PerClientStateServer(root).run_in_thread("localhost", 8765)
 
+
             @reactpy.component
             def DivOne(self):
                 return {"tagName": "div", "children": [1]}
 
+
             show(DivOne)
 
             # displaying the output now will show DivOne
 
+
             @reactpy.component
             def DivTwo(self):
                 return {"tagName": "div", "children": [2]}
 
+
             show(DivTwo)
 
             # displaying the output now will show DivTwo
diff --git a/tests/test_console/test_rewrite_camel_case_props.py b/tests/test_console/test_rewrite_camel_case_props.py
@@ -1,4 +1,3 @@
-import sys
 from pathlib import Path
 from textwrap import dedent
 
@@ -10,9 +9,6 @@
     rewrite_camel_case_props,
 )
 
-if sys.version_info < (3, 9):
-    pytestmark = pytest.mark.skip(reason="ast.unparse is Python>=3.9")
-
 
 def test_rewrite_camel_case_props_declarations(tmp_path):
     runner = CliRunner()
diff --git a/tests/test_console/test_rewrite_keys.py b/tests/test_console/test_rewrite_keys.py
