plain 0.76.0__tar.gz → 0.77.0__tar.gz

{plain-0.76.0 → plain-0.77.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain
-Version: 0.76.0
+Version: 0.77.0
 Summary: A web framework for building products with Python.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
@@ -9,6 +9,7 @@ Requires-Dist: click>=8.0.0
 Requires-Dist: jinja2>=3.1.2
 Requires-Dist: opentelemetry-api>=1.34.1
 Requires-Dist: opentelemetry-semantic-conventions>=0.55b1
+Requires-Dist: watchfiles>=0.18.0
 Description-Content-Type: text/markdown
 
 # Plain

{plain-0.76.0 → plain-0.77.0}/plain/CHANGELOG.md

@@ -1,5 +1,18 @@
 # plain changelog
 
+## [0.77.0](https://github.com/dropseed/plain/releases/plain@0.77.0) (2025-10-13)
+
+### What's changed
+
+- The `plain server --reload` now uses `watchfiles` for improved cross-platform file watching ([92e95c5032](https://github.com/dropseed/plain/commit/92e95c5032))
+- Server reloader now watches `.env*` files for changes and triggers automatic reload ([92e95c5032](https://github.com/dropseed/plain/commit/92e95c5032))
+- HTML template additions and deletions now trigger automatic server reload when using `--reload` ([f2f31c288b](https://github.com/dropseed/plain/commit/f2f31c288b))
+- Internal server worker type renamed from "gthread" to "thread" for clarity ([6470748e91](https://github.com/dropseed/plain/commit/6470748e91))
+
+### Upgrade instructions
+
+- No changes required
+
 ## [0.76.0](https://github.com/dropseed/plain/releases/plain@0.76.0) (2025-10-12)
 
 ### What's changed

{plain-0.76.0 → plain-0.77.0}/plain/cli/server.py

@@ -58,12 +58,6 @@ from plain.cli.runtime import without_runtime_setup
     is_flag=True,
     help="Restart workers when code changes (dev only)",
 )
-@click.option(
-    "--reload-extra-file",
-    multiple=True,
-    type=click.Path(exists=True),
-    help="Additional files to watch for reload (can be used multiple times)",
-)
 @click.option(
     "--access-log",
     default="-",
@@ -109,7 +103,6 @@ def server(
     keyfile: str | None,
     log_level: str,
     reload: bool,
-    reload_extra_file: tuple[str, ...],
     access_log: str,
     error_log: str,
     log_format: str,
@@ -130,7 +123,6 @@ def server(
         timeout=timeout,
         max_requests=max_requests,
         reload=reload,
-        reload_extra_files=list(reload_extra_file) if reload_extra_file else [],
         pidfile=pidfile,
         certfile=certfile,
         keyfile=keyfile,

plain-0.77.0/plain/internal/reloader.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+import os
+import os.path
+import re
+import sys
+import threading
+from collections.abc import Callable
+
+import watchfiles
+
+COMPILED_EXT_RE = re.compile(r"py[co]$")
+
+
+class Reloader(threading.Thread):
+    """File change reloader using watchfiles for cross-platform native file watching."""
+
+    def __init__(self, callback: Callable[[str], None], watch_html: bool) -> None:
+        super().__init__()
+        self.daemon = True
+        self._callback = callback
+        self._watch_html = watch_html
+
+    def get_watch_paths(self) -> set[str]:
+        """Get all directories to watch for changes."""
+        paths = set()
+
+        # Get directories from loaded Python modules
+        for module in tuple(sys.modules.values()):
+            if not hasattr(module, "__file__") or not module.__file__:
+                continue
+            # Convert .pyc/.pyo to .py and get directory
+            file_path = COMPILED_EXT_RE.sub("py", module.__file__)
+            dir_path = os.path.dirname(os.path.abspath(file_path))
+            if os.path.isdir(dir_path):
+                paths.add(dir_path)
+
+        # Add current working directory for .env files
+        cwd = os.getcwd()
+        if os.path.isdir(cwd):
+            paths.add(cwd)
+
+        return paths
+
+    def run(self) -> None:
+        """Watch for file changes and trigger callback."""
+        watch_paths = self.get_watch_paths()
+
+        for changes in watchfiles.watch(*watch_paths, rust_timeout=1000):
+            for change_type, file_path in changes:
+                should_reload = False
+                filename = os.path.basename(file_path)
+
+                # Python files: reload on modify/add
+                if change_type in (watchfiles.Change.modified, watchfiles.Change.added):
+                    if file_path.endswith(".py"):
+                        should_reload = True
+
+                # .env files: reload on modify/add/delete
+                if change_type in (
+                    watchfiles.Change.modified,
+                    watchfiles.Change.added,
+                    watchfiles.Change.deleted,
+                ):
+                    if filename.startswith(".env"):
+                        should_reload = True
+
+                # HTML files: only reload on add/delete (Jinja auto-reloads modifications)
+                if self._watch_html and change_type in (
+                    watchfiles.Change.added,
+                    watchfiles.Change.deleted,
+                ):
+                    if file_path.endswith(".html"):
+                        should_reload = True
+
+                if should_reload:
+                    self._callback(file_path)

{plain-0.76.0 → plain-0.77.0}/plain/server/README.md

@@ -39,8 +39,7 @@ Common options:
 - `--workers` / `-w` - Number of worker processes (default: 1, or `$WEB_CONCURRENCY` env var)
 - `--threads` - Number of threads per worker (default: 1)
 - `--timeout` / `-t` - Worker timeout in seconds (default: 30)
-- `--reload` - Enable auto-reload on code changes (default: False)
-- `--reload-extra-file` - Additional files to watch for reloading (can be used multiple times)
+- `--reload` - Enable auto-reload on code changes, including `.env*` files (default: False)
 - `--certfile` - Path to SSL certificate file
 - `--keyfile` - Path to SSL key file
 - `--log-level` - Logging level: debug, info, warning, error, critical (default: info)

{plain-0.76.0 → plain-0.77.0}/plain/server/arbiter.py

@@ -490,7 +490,7 @@ class Arbiter:
         # Process Child
         worker.pid = os.getpid()
         try:
-            self.log.info("Plain server worker started pid=%s", worker.pid)
+            self.log.info("Server worker started pid=%s", worker.pid)
             worker.init_process()
             sys.exit(0)
         except SystemExit:
@@ -506,7 +506,7 @@ class Arbiter:
                 sys.exit(self.WORKER_BOOT_ERROR)
             sys.exit(-1)
         finally:
-            self.log.info("Worker exiting (pid: %s)", worker.pid)
+            self.log.info("Server worker exiting (pid: %s)", worker.pid)
             try:
                 worker.tmp.close()
             except Exception:

{plain-0.76.0 → plain-0.77.0}/plain/server/config.py

@@ -10,6 +10,8 @@ import os
 from dataclasses import dataclass
 
 from . import util
+from .workers.sync import SyncWorker
+from .workers.thread import ThreadWorker
 
 
 @dataclass
@@ -27,7 +29,6 @@ class Config:
     timeout: int
     max_requests: int
     reload: bool
-    reload_extra_files: list[str]
     pidfile: str | None
     certfile: str | None
     keyfile: str | None
@@ -41,20 +42,19 @@ class Config:
     def worker_class_str(self) -> str:
         # Auto-select based on threads
         if self.threads > 1:
-            return "gthread"
+            return "thread"
         return "sync"
 
     @property
     def worker_class(self) -> type:
         # Auto-select based on threads
         if self.threads > 1:
-            uri = "plain.server.workers.gthread.ThreadWorker"
+            worker_class = ThreadWorker
         else:
-            uri = "plain.server.workers.sync.SyncWorker"
+            worker_class = SyncWorker
 
-        worker_class = util.load_class(uri)
         if hasattr(worker_class, "setup"):
-            worker_class.setup()  # type: ignore[call-non-callable]  # hasattr check doesn't narrow type
+            worker_class.setup()
         return worker_class
 
     @property

{plain-0.76.0 → plain-0.77.0}/plain/server/util.py

@@ -10,8 +10,6 @@ import email.utils
 import errno
 import fcntl
 import html
-import importlib
-import inspect
 import io
 import os
 import random
@@ -20,14 +18,11 @@ import socket
 import sys
 import textwrap
 import time
-import traceback
 import urllib.parse
 import warnings
 from collections.abc import Callable
 from typing import Any
 
-from .workers import SUPPORTED_WORKERS
-
 # Server and Date aren't technically hop-by-hop
 # headers, but they are in the purview of the
 # origin server which the WSGI spec says we should
@@ -44,55 +39,6 @@ hop_headers = set(
     """.split()
 )
 
-
-def load_class(
-    uri: str | type,
-    default: str = "plain.server.workers.sync.SyncWorker",
-    section: str = "plain.server.workers",
-) -> type:
-    if inspect.isclass(uri):
-        return uri  # type: ignore[return-value]
-
-    components = uri.split(".")  # type: ignore[union-attr]
-    if len(components) == 1:
-        # Handle short names like "sync" or "gthread"
-        if uri.startswith("#"):  # type: ignore[union-attr]
-            uri = uri[1:]  # type: ignore[union-attr]
-
-        if uri in SUPPORTED_WORKERS:
-            components = SUPPORTED_WORKERS[uri].split(".")
-        else:
-            exc_msg = f"Worker type {uri!r} not found in SUPPORTED_WORKERS"
-            raise RuntimeError(exc_msg)
-
-    klass = components.pop(-1)
-
-    try:
-        mod = importlib.import_module(".".join(components))
-    except Exception:
-        exc = traceback.format_exc()
-        msg = "class uri %r invalid or not found: \n\n[%s]"
-        raise RuntimeError(msg % (uri, exc))
-    return getattr(mod, klass)
-
-
-positionals = (
-    inspect.Parameter.POSITIONAL_ONLY,
-    inspect.Parameter.POSITIONAL_OR_KEYWORD,
-)
-
-
-def get_arity(f: Callable[..., Any]) -> int:
-    sig = inspect.signature(f)
-    arity = 0
-
-    for param in sig.parameters.values():
-        if param.kind in positionals:
-            arity += 1
-
-    return arity
-
-
 if sys.platform.startswith("win"):
 
     def _waitfor(
@@ -317,19 +263,6 @@ def has_fileno(obj: Any) -> bool:
     return True
 
 
-def warn(msg: str) -> None:
-    print("!!!", file=sys.stderr)
-
-    lines = msg.splitlines()
-    for i, line in enumerate(lines):
-        if i == 0:
-            line = f"WARNING: {line}"
-        print(f"!!! {line}", file=sys.stderr)
-
-    print("!!!\n", file=sys.stderr)
-    sys.stderr.flush()
-
-
 def make_fail_app(msg: str | bytes) -> Callable[..., Any]:
     msg = to_bytestring(msg)
 

plain-0.77.0/plain/server/workers/__init__.py

@@ -0,0 +1,6 @@
+#
+#
+# This file is part of gunicorn released under the MIT license.
+# See the LICENSE for more information.
+#
+# Vendored and modified for Plain.

{plain-0.76.0 → plain-0.77.0}/plain/server/workers/base.py

@@ -17,6 +17,8 @@ from random import randint
 from ssl import SSLError
 from typing import TYPE_CHECKING, Any
 
+from plain.internal.reloader import Reloader
+
 from .. import util
 from ..http.errors import (
     ConfigurationProblem,
@@ -32,7 +34,6 @@ from ..http.errors import (
     UnsupportedTransferCoding,
 )
 from ..http.wsgi import Response, default_environ
-from ..reloader import reloader_engines
 from .workertmp import WorkerTmp
 
 if TYPE_CHECKING:
@@ -143,16 +144,13 @@ class Worker:
         if self.cfg.reload:
 
             def changed(fname: str) -> None:
-                self.log.info("Worker reloading: %s modified", fname)
+                self.log.debug("Server worker reloading: %s modified", fname)
                 self.alive = False
                 os.write(self.PIPE[1], b"1")
                 time.sleep(0.1)
                 sys.exit(0)
 
-            reloader_cls = reloader_engines["auto"]
-            self.reloader = reloader_cls(
-                extra_files=self.cfg.reload_extra_files, callback=changed
-            )
+            self.reloader = Reloader(callback=changed, watch_html=True)
 
         self.load_wsgi()
         if self.reloader:
@@ -177,7 +175,6 @@ class Worker:
             # delete the traceback after use.
             try:
                 _, exc_val, exc_tb = sys.exc_info()
-                self.reloader.add_extra_file(exc_val.filename)
 
                 tb_string = io.StringIO()
                 traceback.print_tb(exc_tb, file=tb_string)

{plain-0.76.0 → plain-0.77.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain"
-version = "0.76.0"
+version = "0.77.0"
 description = "A web framework for building products with Python."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"
@@ -9,6 +9,7 @@ dependencies = [
     "click>=8.0.0",
     "opentelemetry-api>=1.34.1",
     "opentelemetry-semantic-conventions>=0.55b1",
+    "watchfiles>=0.18.0",
 ]
 requires-python = ">=3.13"
 

plain-0.76.0/plain/server/reloader.py

@@ -1,158 +0,0 @@
-from __future__ import annotations
-
-#
-#
-# This file is part of gunicorn released under the MIT license.
-# See the LICENSE for more information.
-#
-# Vendored and modified for Plain.
-import os
-import os.path
-import re
-import sys
-import threading
-import time
-from collections.abc import Callable, Iterable
-
-COMPILED_EXT_RE = re.compile(r"py[co]$")
-
-
-class Reloader(threading.Thread):
-    def __init__(
-        self,
-        extra_files: Iterable[str] | None = None,
-        interval: int = 1,
-        callback: Callable[[str], None] | None = None,
-    ) -> None:
-        super().__init__()
-        self.daemon = True
-        self._extra_files: set[str] = set(extra_files or ())
-        self._interval = interval
-        self._callback = callback
-
-    def add_extra_file(self, filename: str) -> None:
-        self._extra_files.add(filename)
-
-    def get_files(self) -> list[str]:
-        fnames = [
-            COMPILED_EXT_RE.sub("py", module.__file__)  # type: ignore[arg-type]
-            for module in tuple(sys.modules.values())
-            if getattr(module, "__file__", None)
-        ]
-
-        fnames.extend(self._extra_files)
-
-        return fnames
-
-    def run(self) -> None:
-        mtimes: dict[str, float] = {}
-        while True:
-            for filename in self.get_files():
-                try:
-                    mtime = os.stat(filename).st_mtime
-                except OSError:
-                    continue
-                old_time = mtimes.get(filename)
-                if old_time is None:
-                    mtimes[filename] = mtime
-                    continue
-                elif mtime > old_time:
-                    if self._callback:
-                        self._callback(filename)
-            time.sleep(self._interval)
-
-
-has_inotify = False
-if sys.platform.startswith("linux"):
-    try:
-        import inotify.constants
-        from inotify.adapters import Inotify
-
-        has_inotify = True
-    except ImportError:
-        pass
-
-
-if has_inotify:
-
-    class InotifyReloader(threading.Thread):
-        event_mask = (
-            inotify.constants.IN_CREATE
-            | inotify.constants.IN_DELETE
-            | inotify.constants.IN_DELETE_SELF
-            | inotify.constants.IN_MODIFY
-            | inotify.constants.IN_MOVE_SELF
-            | inotify.constants.IN_MOVED_FROM
-            | inotify.constants.IN_MOVED_TO
-        )
-
-        def __init__(
-            self,
-            extra_files: Iterable[str] | None = None,
-            callback: Callable[[str], None] | None = None,
-        ) -> None:
-            super().__init__()
-            self.daemon = True
-            self._callback = callback
-            self._dirs: set[str] = set()
-            self._watcher = Inotify()
-
-            if extra_files:
-                for extra_file in extra_files:
-                    self.add_extra_file(extra_file)
-
-        def add_extra_file(self, filename: str) -> None:
-            dirname = os.path.dirname(filename)
-
-            if dirname in self._dirs:
-                return None
-
-            self._watcher.add_watch(dirname, mask=self.event_mask)
-            self._dirs.add(dirname)
-
-        def get_dirs(self) -> set[str]:
-            fnames = [
-                os.path.dirname(
-                    os.path.abspath(COMPILED_EXT_RE.sub("py", module.__file__))  # type: ignore[arg-type]
-                )
-                for module in tuple(sys.modules.values())
-                if getattr(module, "__file__", None)
-            ]
-
-            return set(fnames)
-
-        def run(self) -> None:
-            self._dirs = self.get_dirs()
-
-            for dirname in self._dirs:
-                if os.path.isdir(dirname):
-                    self._watcher.add_watch(dirname, mask=self.event_mask)
-
-            for event in self._watcher.event_gen():  # type: ignore[attr-defined]
-                if event is None:
-                    continue
-
-                filename = event[3]  # type: ignore[index]
-
-                self._callback(filename)  # type: ignore[misc]
-
-else:
-
-    class InotifyReloader:
-        def __init__(
-            self,
-            extra_files: Iterable[str] | None = None,
-            callback: Callable[[str], None] | None = None,
-        ) -> None:
-            raise ImportError(
-                "You must have the inotify module installed to use the inotify reloader"
-            )
-
-
-preferred_reloader = InotifyReloader if has_inotify else Reloader
-
-reloader_engines = {
-    "auto": preferred_reloader,
-    "poll": Reloader,
-    "inotify": InotifyReloader,
-}

plain-0.76.0/plain/server/workers/__init__.py

@@ -1,12 +0,0 @@
-#
-#
-# This file is part of gunicorn released under the MIT license.
-# See the LICENSE for more information.
-#
-# Vendored and modified for Plain.
-
-# Supported workers
-SUPPORTED_WORKERS = {
-    "sync": "plain.server.workers.sync.SyncWorker",
-    "gthread": "plain.server.workers.gthread.ThreadWorker",
-}