Merge pull request #195 from ZeroIntensity/reactpy

This is going to break a lot of things, and basically all CI is going to fail. That's OK--this is an alpha library anyway. For now, we just want to focus on getting all this code on main so we can start working on fixing the C code.

Author: ZeroIntensity

.clang-format

@@ -0,0 +1 @@
+DisableFormat: true

.github/workflows/build.yml

@@ -1,18 +1,16 @@
-name: CI
+name: Build
 
 on:
     push:
         tags:
             - v*
-    pull_request:
-        branches:
-            - master
 
 concurrency:
     group: build-${{ github.head_ref }}
     cancel-in-progress: true
 
 env:
+    SKBUILD_CMAKE_BUILD_TYPE: "Release"
     CIBW_SKIP: >
         pp*
 

.github/workflows/memory_check.yml

@@ -1,4 +1,4 @@
-name: Memory Check
+name: Memory Problems
 
 on:
     push:
@@ -12,10 +12,13 @@ env:
     PYTHONUNBUFFERED: "1"
     FORCE_COLOR: "1"
     PYTHONIOENCODING: "utf8"
+    PYTHONMALLOC: "malloc"
+    PYTHONDEVMODE: "1"
+    HATCH_VERBOSE: "1"
 
 jobs:
     run:
-        name: Valgrind on Ubuntu
+        name: Run memory tests on Ubuntu
         runs-on: ubuntu-latest
 
         steps:
@@ -26,16 +29,19 @@ jobs:
               with:
                   python-version: 3.12
 
-            - name: Install PyTest
+            - name: Install Pytest
               run: |
-                  pip install pytest pytest-asyncio
+                  pip install pytest pytest-asyncio pytest-memray
               shell: bash
 
-            - name: Build project
+            - name: Build view.py
               run: pip install .[full]
 
             - name: Install Valgrind
               run: sudo apt-get update && sudo apt-get -y install valgrind
 
             - name: Run tests with Valgrind
-              run: valgrind --suppressions=valgrind-python.supp --error-exitcode=1 pytest -x
+              run: valgrind --error-exitcode=1 pytest
+
+            - name: Run tests with Memray
+              run: pytest --enable-leak-tracking

.github/workflows/tests.yml

@@ -16,6 +16,8 @@ env:
     PYTHONUNBUFFERED: "1"
     FORCE_COLOR: "1"
     PYTHONIOENCODING: "utf8"
+    PYTHONDEVMODE: "1"
+    HATCH_VERBOSE: "1"
 
 jobs:
     run:
@@ -24,8 +26,8 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                os: [ubuntu-latest, windows-latest, macos-12]
-                python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+                os: [ubuntu-latest, windows-latest, macos-latest]
+                python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
         steps:
             - uses: actions/checkout@v2
@@ -35,23 +37,11 @@ jobs:
               with:
                   python-version: ${{ matrix.python-version }}
 
-            - name:  Install PyTest
-              run:   |
-                     if [ "$RUNNER_OS" == "Windows" ]; then
-                          pip install pytest pytest-asyncio
-                     else
-                          pip install pytest pytest-asyncio pytest-memray
-                     fi
-              shell: bash
-    
-            - name: Build project
+            - name: Install Pytest
+              run: pip install pytest pytest-asyncio
+
+            - name: Build view.py
               run: pip install .[full]
 
-            - name:  Run tests
-              run:   |
-                     if [ "$RUNNER_OS" == "Windows" ]; then
-                          pytest
-                     else
-                          pytest --memray
-                     fi
-              shell: bash
+            - name: Run tests
+              run: pytest -x

.gitignore

@@ -1,29 +1,47 @@
+# Python
 __pycache__/
 .venv/
-ext/
-test.py
-sample.py
+38venv/
+39venv/
+311venv/
+
+# LSP
+.vscode/
 compile_flags.txt
+pyawaitable.h
+
+# View Configurations
 view.toml
 view.json
 view_config.py
-/app.py
+
+# Testing Files
+*.test
+test.py
 a.py
+.coverage
+.pytest-cache/
+.ruff-cache/
+.cache/
+
+# Logs
 *.log
+vgcore.*
+valgrind.txt*
+
+# JavaScript
 node_modules/
 *.lock
-site/
 benchmark.py
+package-lock.json
+client.js
+.next/
+
+# Builds
+site/
 dist/
-*.egg-info
 build/
-*.so
+*.egg-info/
 html/dist.css
-38venv
-39venv
-311venv
+*.so
 a.md
-new_app/
-vgcore.*
-.vscode/
-*.test

CHANGELOG.md

@@ -13,9 +13,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   Added support for coroutines in `PyAwaitable` (vendored)
 -   Finished websocket implementation
 -   Added the `custom` loader
--   Added support for returning `bytes` objects in the body.
+-   Added support for returning `bytes` objects in the body
+-   Added `nosanitize` and `repr` to the `ref` attribute of `<view>` tags in view template rendering
+-   `WebSocketDisconnect` is now raised instead of `WebSocketHandshakeError` in an unexpected WebSocket disconnect
+-   Added many, _many_, more docstrings
+-   Added the `app` attribute to `Context`
+-   Switched to PyMalloc under the hood
+-   Deprecated the `run()` utility
+-   Added support for asynchronous `__view_result__` functions
+-   Removed unstable `components` functions from top-level `view` module
+-   Added native support for `ReactPy` component routes
+-   Added the `expect_errors` utility
+-   Added the `HeaderDict` class
+-   Changed the `headers` attribute on `Context` to a `HeaderDict` instance of a `dict`
+-   Added the `call_result` utility
+-   Added the `ctx` parameter to `to_response`
+-   Removed broken hint when forgetting to call `load()`
+-   Added support for `isinstance` to `SupportsViewResult`
+-   Moved `to_response` to the `view.utils` module
+-   Added the `force` parameter to `run`
+-   Added the `view dev` command (live reload)
+-   Fixed redirection and disabling of HTTP server logging
+-   C API is now compliant with [PEP 7](https://peps.python.org/pep-0007/)
+-   Added `-g3` and `-O3` flag to the `_view` extension module (debugging information and optimizations)
+-   Removed use of Rich `escape()` in the message shown when a dependency is needed
+-   Query string client errors are now displayed during development mode
+-   `KeyboardInterrupt` is swallowed by the server coroutine, and a log message is now issued
+-   Typecode API now raises exceptions indicating a validation error (and now it's sent as a response with a query or body parse failure)
+-   `hatchling` and `scikit-build-core` are now used for build instead of `setuptools`
+-   Renamed the `view-admin` command to `view-py`
+-   **Breaking Change:** Renamed `Error` to `HTTPError`
+-   **Breaking Change:** `__view_result__` is now given a `Context` parameter
+-   **Breaking Change:** `to_response` is now asynchronous
+-   **Breaking Change:** Renamed `Response._custom` to `Response.translate_body`
 -   **Breaking Change:** Removed the `hijack` configuration setting
--   **Breaking Change:** Removed the `post_init` parameter from `new_app`, as well as renamed the `store_address` parameter to `store`.
+-   **Breaking Change:** Removed the `post_init` parameter from `new_app`, as well as renamed the `store_address` parameter to `store`
 -   **Breaking Change:** `load()` now takes routes via variadic arguments, instead of a list of routes.
 
 ## [1.0.0-alpha10] - 2024-5-26

CMakeLists.txt

@@ -0,0 +1,30 @@
+cmake_minimum_required(VERSION 3.15...3.26)
+project(${SKBUILD_PROJECT_NAME} LANGUAGES C)
+
+message(STATUS "CMAKE_BUILD_TYPE set to '${CMAKE_BUILD_TYPE}'")
+
+# Source code
+file(GLOB _view_SRC
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/_view/*.c
+)
+MESSAGE(DEBUG ${_view_SRC})
+
+# Find Python
+find_package(
+  Python
+  COMPONENTS Interpreter Development.Module
+  REQUIRED)
+
+# Link Python
+python_add_library(_view MODULE ${_view_SRC} WITH_SOABI)
+
+# Settings
+add_compile_definitions(PYAWAITABLE_PYAPI)
+
+# Add include directories
+target_include_directories(_view PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include/)
+target_include_directories(_view PUBLIC $ENV{PYAWAITABLE_INCLUDE_DIR})
+
+MESSAGE(STATUS "Everything looks good, let's install!")
+# Install extension module
+install(TARGETS _view DESTINATION .)

CONTRIBUTING.md

@@ -20,13 +20,14 @@ $ pip install .
 
 Congratulations, you have just started your development with view.py!
 
+Note that this cannot be an editable install (the `-e` flag), as `scikit-build-core` does not support it.
+
 ## Workflow
 
 First, you should create a new branch:
 
 ```
-$ git branch my_cool_feature
-$ git checkout my_cool_feature
+$ git switch -c my-cool-feature
 ```
 
 All of your code should be contained on this branch.
@@ -72,7 +73,7 @@ fancy = false
 server_logger = true
 ```
 
-These settings will stop view.py's fancy output from showing, as well as stopping the hijack of the ASGI logger, and you'll get the raw output.
+These settings will stop view.py's fancy output from showing, as well as stopping the hijack of the server's logger, and you'll get the raw server output.
 
 ## Writing Tests
 

MANIFEST.in

@@ -1,7 +1,12 @@
 # flake8: noqa
-# NOTE: anything in this file that is defined solely for typing purposes should be
-# prefixed with __ to tell the developer that its not an actual symbol defined by
-# the extension module
+
+"""
+_view - Type stubs for the view.py extension module.
+
+Anything in this file that is defined solely for typing purposes should be
+prefixed with __ to tell the developer that its not an actual symbol defined by
+the extension module.
+"""
 
 from ipaddress import IPv4Address as __IPv4Address
 from ipaddress import IPv6Address as __IPv6Address
@@ -14,6 +19,7 @@ from typing import Literal as __Literal
 from typing import NoReturn as __NoReturn
 from typing import TypeVar as __TypeVar
 
+from view.app import App
 from view.routing import RouteData as __RouteData
 from view.typing import AsgiDict as __AsgiDict
 from view.typing import AsgiReceive as __AsgiReceive
@@ -119,13 +125,16 @@ class ViewApp:
     def _supply_parsers(self, query: __Parser, json: __Parser, /) -> None: ...
     def _register_error(self, error: type, /) -> None: ...
 
-def test_awaitable(coro: __Coroutine[__Any, __Any, __T], /) -> __Awaitable[__T]: ...
+def test_awaitable(
+    coro: __Coroutine[__Any, __Any, __T], /
+) -> __Awaitable[__T]: ...
 
 class Context:
     def __init__(self) -> __NoReturn: ...
 
+    app: App
     cookies: dict[str, str]
-    headers: dict[str, str]
+    headers: HeaderDict
     client: __IPv4Address | __IPv6Address | None
     server: __IPv4Address | __IPv6Address | None
     method: __StrMethodASGI
@@ -152,5 +161,14 @@ class ViewWebSocket:
 class InvalidStatusError(RuntimeError): ...
 class WebSocketHandshakeError(RuntimeError): ...
 
-def setup_route_log(func: __Callable[[int | str, str, str], None]) -> None: ...
-def register_ws_cls(tp: type[__Any]) -> None: ...
+def setup_route_log(func: __Callable[[int | str, str, str], None], warn: __Callable[[str], None], /) -> None: ...
+def register_ws_cls(
+    tp: type[__Any], ws_handshake_err: type[__Any], ws_err: type[__Any], /,
+) -> None: ...
+
+class HeaderDict:
+    def __init__(self) -> __NoReturn: ...
+    def __setitem__(self, key: str, value: str, /) -> None: ...
+    def __getitem__(self, key: str, /) -> str | list[str]: ...
+
+def dummy_context(app: ViewApp | None) -> Context: ...

_view.pyi

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<view ref="prerender_head" nosanitize />
+<script src="src/reactpy.tsx" type="module"></script>
+<p hidden id="_view-route-hook">
+    <view ref="hook" />
+</p>
+<view ref="prerender_body" nosanitize />
+
+</html>

client/index.html

@@ -0,0 +1,21 @@
+{
+    "private": true,
+    "type": "module",
+    "scripts": {
+        "dev": "vite",
+        "build": "tsc && vite build",
+        "preview": "vite preview"
+    },
+    "devDependencies": {
+        "@types/react": "^18.3.3",
+        "@types/react-dom": "^18.3.0",
+        "typescript": "^5.4.5",
+        "vite": "^5.2.0",
+        "vite-plugin-singlefile": "^2.0.1"
+    },
+    "dependencies": {
+        "@reactpy/client": "^0.3.1",
+        "react": "^18.3.1",
+        "react-dom": "^18.3.1"
+    }
+}