t-doc-common 0.22__tar.gz → 0.23.dev1__tar.gz

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/.hgtags

@@ -18,3 +18,4 @@ ad8e768d29c94dedd8d22db5d3447f9b5b810370 0.18
 dc75eb2f3b9b8554fcf4721f2bb91ac3912975c7 0.19
 d54da9f11060151a540e02c17be22fcffa5ee6f2 0.20
 bfa6d8647b36a02d24d7ebc20985aaa235385c2c 0.21
+b6a1b278f82ad0041ea9bebaa81850ffa9e6026a 0.22

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/PKG-INFO

@@ -1,12 +1,14 @@
 Metadata-Version: 2.3
 Name: t-doc-common
-Version: 0.22
+Version: 0.23.dev1
 Summary: Common functionality for t-doc
 Project-URL: Code, https://github.com/t-docs/common
 Project-URL: Documentation, https://t-doc.org/common/
 Project-URL: Homepage, https://t-doc.org/
 Author-email: Remy Blank <remy@c-space.org>
-License: MIT
+License-Expression: MIT
+License-File: LICENSE.txt
+License-File: LICENSES.deps.txt
 Classifier: Development Status :: 3 - Alpha
 Classifier: Framework :: Sphinx :: Extension
 Classifier: Intended Audience :: Developers

t_doc_common-0.23.dev1/tdoc/common/__init__.py

@@ -0,0 +1,5 @@
+# Copyright 2024 Remy Blank <remy@c-space.org>
+# SPDX-License-Identifier: MIT
+
+__project__ = 't-doc-common'
+__version__ = '0.23.dev1'

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/cli.py

@@ -3,24 +3,27 @@
 
 import argparse
 import contextlib
-from http import server
+from http import HTTPMethod, HTTPStatus
 import itertools
 from importlib import metadata
 import json
+import mimetypes
 import os
 import pathlib
+import posixpath
 import re
 import shutil
 import socket
+import socketserver
 import stat
 import subprocess
 import sys
 import threading
 import time
 from urllib import parse
+from wsgiref import simple_server, util as wsgiutil
 
-from .. import common
-from . import util
+from . import __project__, __version__, util
 
 # TODO: Implement incremental builds, by copying previous build output
 
@@ -86,8 +89,8 @@ def main(argv, stdin, stdout, stderr):
              "(default: %(default)s).")
     arg('--port', metavar='PORT', dest='port', default=8000, type=int,
         help="The port to bind the server to (default: %(default)s).")
-    arg('--protocol', metavar='VERSION', dest='protocol', default='HTTP/1.0',
-        help="The HTTP protocol version to conform to (default: %(default)s).")
+    arg('--restart-on-change', action='store_true', dest='restart_on_change',
+        help="Restart the server on changes.")
     arg('--watch', metavar='PATH', action='append', dest='watch', default=[],
         help="Additional directories to watch for changes.")
 
@@ -127,18 +130,24 @@ def cmd_serve(cfg):
 
     class Server(ServerBase):
         address_family = family
-    class Handler(HandlerBase):
-        protocol = cfg.protocol
 
-    with Server(addr, Handler, cfg=cfg) as srv:
+    with Application(cfg, addr) as app, Server(addr, RequestHandler) as srv:
+        app.server = srv
+        srv.set_app(app)
         try:
             srv.serve_forever()
         except KeyboardInterrupt:
+            cfg.restart_on_change = False
             cfg.stderr.write("Interrupted, exiting\n")
 
+    if cfg.restart_on_change:
+        cfg.stdout.flush()
+        cfg.stderr.flush()
+        os.execv(sys.argv[0], sys.argv)
+
 
 def cmd_version(cfg):
-    cfg.stdout.write(f"{common.__project__}-{common.__version__}\n")
+    cfg.stdout.write(f"{__project__}-{__version__}\n")
 
 
 def sphinx_build(cfg, target, *, build, tags=(), **kwargs):
@@ -154,9 +163,47 @@ def sphinx_build(cfg, target, *, build, tags=(), **kwargs):
                           stderr=cfg.stderr, **kwargs)
 
 
-class ServerBase(server.ThreadingHTTPServer):
-    def __init__(self, *args, cfg, **kwargs):
+class ServerBase(socketserver.ThreadingMixIn, simple_server.WSGIServer):
+    daemon_threads = True
+
+    def server_bind(self):
+        with contextlib.suppress(Exception):
+            self.socket.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 0)
+        return super().server_bind()
+
+
+class RequestHandler(simple_server.WSGIRequestHandler):
+    def log_request(self, code='-', size='-'):
+        pass
+
+    def log_message(self, format, *args):
+        self.server.application.cfg.stderr.write("%s - - [%s] %s\n" % (
+            self.address_string(), self.log_date_time_string(),
+            (format % args).translate(self._control_char_table)))
+
+
+def status_str(status):
+    return f'{status} {status.phrase}'
+
+
+def error(respond, status):
+    respond(status_str(status), [
+        ('Content-Type', 'text/plain;charset=utf-8'),
+    ])
+    return [status.description.encode('utf-8')]
+
+
+def try_stat(path):
+    try:
+        return path.stat()
+    except OSError:
+        return None
+
+
+class Application:
+    def __init__(self, cfg, addr):
         self.cfg = cfg
+        self.addr = addr
         self.lock = threading.Condition(threading.Lock())
         self.directory = self.build_dir(0) / 'html'
         self.upgrade_msg = None
@@ -168,28 +215,13 @@ class ServerBase(server.ThreadingHTTPServer):
         self.builder.start()
         self.checker = threading.Thread(target=self.check_upgrade, daemon=True)
         self.checker.start()
-        super().__init__(*args, **kwargs)
-
-    def server_bind(self):
-        with contextlib.suppress(Exception):
-            self.socket.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 0)
-        return super().server_bind()
-
-    def finish_request(self, request, client_addr):
-        with self.lock: directory = self.directory
-        self.RequestHandlerClass(request, client_addr, self,
-                                 directory=directory)
-
-    IGNORED_EXCEPTIONS = (BrokenPipeError, ConnectionAbortedError)
+        self.apps = {'*build': self.handle_build}
 
-    def handle_error(self, request, client_addr):
-        if not isinstance(sys.exception(), self.IGNORED_EXCEPTIONS):
-            super().handle_error(request, client_addr)
+    def __enter__(self): return self
 
-    def server_close(self):
+    def __exit__(self, typ, value, tb):
         with self.lock: self.stop = True
         self.builder.join()
-        return super().server_close()
 
     def watch_and_build(self):
         interval = self.cfg.interval * 1_000_000_000
@@ -209,6 +241,11 @@ class ServerBase(server.ThreadingHTTPServer):
                 prev = mtime + delay - interval
                 continue
             if prev_mtime != 0:
+                if self.cfg.restart_on_change:
+                    self.cfg.stdout.write(
+                        "\nSource change detected, restarting\n")
+                    self.server.shutdown()
+                    break
                 self.cfg.stdout.write(
                     "\nSource change detected, rebuilding\n")
             prev_mtime = mtime
@@ -267,7 +304,7 @@ class ServerBase(server.ThreadingHTTPServer):
         shutil.rmtree(build, onexc=on_error)
 
     def print_serving(self):
-        host, port = self.socket.getsockname()[:2]
+        host, port = self.addr[:2]
         if ':' in host: host = f'[{host}]'
         self.cfg.stdout.write(self.cfg.ansi("Serving at <@{LBLUE}%s@{NORM}>\n")
                               % f"http://{host}:{port}/")
@@ -276,14 +313,14 @@ class ServerBase(server.ThreadingHTTPServer):
 
     def check_upgrade(self):
         try:
-            project = common.__project__
-            upgrades, editable = pip_check_upgrades(self.cfg, project)
-            if project not in upgrades: return
+            upgrades, editable = pip_check_upgrades(self.cfg, __project__)
+            if __project__ not in upgrades: return
             msg = self.cfg.ansi(
                 "@{LYELLOW}A t-doc upgrade is available:@{NORM} "
                 "%s @{CYAN}%s@{NORM} => @{CYAN}%s@{NORM}\n"
                 "See <@{LBLUE}https://t-doc.org/common/%s#upgrade@{NORM}>\n"
-                % (project, metadata.version(project), upgrades[project],
+                % (__project__, metadata.version(__project__),
+                    upgrades[__project__],
                    'development' if editable else 'install'))
             with self.lock:
                 self.upgrade_msg = msg
@@ -291,37 +328,68 @@ class ServerBase(server.ThreadingHTTPServer):
         except Exception:
             if self.cfg.debug: raise
 
+    def __call__(self, env, respond):
+        script_name, path_info = env['SCRIPT_NAME'], env['PATH_INFO']
+        name = wsgiutil.shift_path_info(env)
+        if (handler := self.apps.get(name)) is not None:
+            return handler(env, respond)
+        env['SCRIPT_NAME'], env['PATH_INFO'] = script_name, path_info
+        return self.handle_default(env, respond)
+
+    def handle_default(self, env, respond):
+        env['wsgi.multithread'] = True
+        if (method := env['REQUEST_METHOD']) not in (HTTPMethod.HEAD,
+                                                     HTTPMethod.GET):
+            return error(respond, HTTPStatus.NOT_IMPLEMENTED)
+        path = self.file_path(env['PATH_INFO'])
+        if (st := try_stat(path)) is None:
+            return error(respond, HTTPStatus.NOT_FOUND)
+
+        if stat.S_ISDIR(st.st_mode):
+            parts = parse.urlsplit(env['PATH_INFO'])
+            if not parts.path.endswith('/'):
+                location = parse.urlunsplit(
+                    (parts[:2] + (parts[2] + '/',) + parts[3:]))
+                respond(status_str(HTTPStatus.MOVED_PERMANENTLY), [
+                    ('Location', location),
+                    ('Content-Length', '0'),
+                ])
+                return []
+            path = path / 'index.html'
+            if (st := try_stat(path)) is None:
+                return error(respond, HTTPStatus.NOT_FOUND)
+
+        if not stat.S_ISREG(st.st_mode):
+            return error(respond, HTTPStatus.NOT_FOUND)
+        mime_type = mimetypes.guess_type(path)[0]
+        if not mime_type: mime_type = 'application/octet-stream'
+        respond(status_str(HTTPStatus.OK), [
+            ('Content-Type', mime_type),
+            ('Content-Length', str(st.st_size)),
+        ])
+        if method == HTTPMethod.HEAD: return []
+        wrapper = env.get('wsgi.file_wrapper', wsgiutil.FileWrapper)
+        return wrapper(open(path, 'rb'))
+
+    def file_path(self, path):
+        trailing = path.rstrip().endswith('/')
+        try:
+            path = parse.unquote(path, errors='surrogatepass')
+        except UnicodeDecodeError:
+            path = parse.unquote(path)
+        with self.lock: res = self.directory
+        for part in filter(None, posixpath.normpath(path).split('/')):
+            if pathlib.Path(part).parent.name or part in (os.curdir, os.pardir):
+                continue
+            res = res / part
+        return res / '' if trailing else res
 
-class HandlerBase(server.SimpleHTTPRequestHandler):
-    def log_request(self, code='-', size='-'):
-        pass
-
-    def log_message(self, format, *args):
-        self.server.cfg.stderr.write("%s - - [%s] %s\n" % (
-            self.address_string(), self.log_date_time_string(),
-            (format % args).translate(self._control_char_table)))
-
-    def do_GET(self):
-        if not self.dispatch_star_handler(True):
-            super().do_GET()
-
-    def do_HEAD(self):
-        if not self.dispatch_star_handler(False):
-            super().do_HEAD()
-
-    def dispatch_star_handler(self, write_content):
-        url = parse.urlparse(self.path)
-        if not url.path.startswith('/*'): return
-        if handler := getattr(self, f'handle_star_{url.path[2:]}', None):
-            content = handler(url, write_content)
-            if write_content and content: self.wfile.write(content)
-        else:
-            self.send_error(server.HTTPStatus.NOT_FOUND)
-        return True
-
-    def handle_star_build(self, url, write_content):
+    def handle_build(self, env, respond):
+        if (method := env['REQUEST_METHOD']) not in (HTTPMethod.HEAD,
+                                                     HTTPMethod.GET):
+            yield from error(respond, HTTPStatus.NOT_IMPLEMENTED)
         t = None
-        for k, v in parse.parse_qsl(url.query):
+        for k, v in parse.parse_qsl(env.get('QUERY_STRING', '')):
             if k == 't':
                 t = v
                 break
@@ -330,20 +398,20 @@ class HandlerBase(server.SimpleHTTPRequestHandler):
         # content length is needed upfront, we return a fixed size, and
         # terminate the request if the padding exceeds the available space.
         size = 600
-        self.send_response(server.HTTPStatus.OK)
-        self.send_header('Content-type', 'text/plain')
-        self.send_header('Content-Length', str(size))
-        self.end_headers()
-        if not write_content: return
-        with self.server.lock:
-            while ((mtime := self.server.build_mtime) is None
+        respond(status_str(HTTPStatus.OK), [
+            ('Content-Type', 'text/plain;charset=utf-8'),
+            ('Content-Length', str(size)),
+        ])
+        if method == HTTPMethod.HEAD: return
+        with self.lock:
+            while ((mtime := self.build_mtime) is None
                    or t == build_tag(mtime)) and size > 0:
-                if self.server.lock.wait(timeout=1): continue
-                self.wfile.write(b' ')
+                if self.lock.wait(timeout=1): continue
+                yield b' '
                 size -= 1
         tag = build_tag(mtime).encode('utf-8')
         if len(tag) > size: tag = b''  # Not enough remaining capacity
-        return b' ' * (size - len(tag)) + tag
+        yield b' ' * (size - len(tag)) + tag
 
 
 def build_tag(mtime):

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/defaults.py

@@ -24,7 +24,7 @@ extensions = [
     'sphinx.ext.todo',
     'sphinx_copybutton',
     'sphinx_design',
-    'tdoc.common',
+    'tdoc.common.ext',
     'tdoc.common.ext.defaults',
     'tdoc.common.ext.exec',
     'tdoc.common.ext.iframe',

{t_doc_common-0.22/tdoc/common → t_doc_common-0.23.dev1/tdoc/common/ext}/__init__.py

@@ -7,14 +7,13 @@ import pathlib
 from sphinx import config, locale
 from sphinx.util import fileutil, logging
 
-__project__ = 't-doc-common'
-__version__ = '0.22'
+from .. import __version__
 
 _log = logging.getLogger(__name__)
 _messages = 'tdoc'
 _ = locale.get_translation(_messages)
 
-_common = pathlib.Path(__file__).absolute().parent
+_base = pathlib.Path(__file__).absolute().parent.parent
 
 _license_urls = {
     'CC0-1.0': 'https://creativecommons.org/publicdomain/zero/1.0/',
@@ -61,8 +60,8 @@ def setup(app):
     app.add_config_value('tdoc_enable_sab', 'no', 'html',
                          config.ENUM('no', 'cross-origin-isolation', 'sabayon'))
 
-    app.add_html_theme('t-doc', str(_common))
-    app.add_message_catalog(_messages, str(_common / 'locale'))
+    app.add_html_theme('t-doc', str(_base))
+    app.add_message_catalog(_messages, str(_base / 'locale'))
 
     app.connect('config-inited', on_config_inited)
     app.connect('builder-inited', on_builder_inited)
@@ -81,7 +80,7 @@ def setup(app):
 def on_config_inited(app, config):
     cv = config.values['html_title']
     super(cv.__class__, cv).__setattr__('default', lambda c: c.project)
-    config.templates_path.append(str(_common / 'templates'))
+    config.templates_path.append(str(_base / 'templates'))
 
     # Override defaults in html_theme_options.
     opts = config.html_theme_options
@@ -100,8 +99,8 @@ def on_config_inited(app, config):
 
 def on_builder_inited(app):
     # Add our own static paths.
-    app.config.html_static_path.append(str(_common / 'static'))
-    app.config.html_static_path.append(str(_common / 'static.gen'))
+    app.config.html_static_path.append(str(_base / 'static'))
+    app.config.html_static_path.append(str(_base / 'static.gen'))
 
     # Add a default static path.
     if '_static' not in app.config.html_static_path:
@@ -133,5 +132,5 @@ def write_static_files(app, builder):
 
     # The file must be at the root of the website, to avoid limiting the scope
     # of the service worker to _static.
-    fileutil.copy_asset_file(_common / 'scripts' / 'tdoc-worker.js',
+    fileutil.copy_asset_file(_base / 'scripts' / 'tdoc-worker.js',
                              builder.outdir, force=True)

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/ext/defaults.py

@@ -6,7 +6,7 @@ import types
 from docutils.parsers.rst import directives
 from sphinx.util import docutils, logging
 
-from .. import __version__, report_exceptions
+from . import __version__, report_exceptions
 
 _log = logging.getLogger(__name__)
 

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/ext/exec.py

@@ -10,7 +10,7 @@ from docutils.parsers.rst import directives
 from sphinx.directives import code
 from sphinx.util import logging, osutil
 
-from .. import __version__, format_attrs, format_data_attrs, report_exceptions
+from . import __version__, format_attrs, format_data_attrs, report_exceptions
 
 _log = logging.getLogger(__name__)
 _base = pathlib.Path(__file__).absolute().parent.parent

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/ext/iframe.py

@@ -5,7 +5,7 @@ from docutils import nodes
 from docutils.parsers.rst import directives
 from sphinx.util import docutils, logging
 
-from .. import __version__, report_exceptions
+from . import __version__, report_exceptions
 
 _log = logging.getLogger(__name__)
 

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/ext/metadata.py

@@ -6,7 +6,7 @@ import yaml
 from docutils import nodes
 from sphinx.util import docutils, logging
 
-from .. import __version__, report_exceptions
+from . import __version__, report_exceptions
 
 _log = logging.getLogger(__name__)
 

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/ext/num.py

@@ -6,7 +6,7 @@ from sphinx import errors
 from sphinx.environment import collectors
 from sphinx.util import docutils, logging, nodes as sphinx_nodes
 
-from .. import __version__
+from . import __version__
 
 _log = logging.getLogger(__name__)
 

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/ext/solution.py

@@ -6,7 +6,7 @@ from docutils.parsers.rst import directives
 from docutils.parsers.rst.directives import admonitions
 from sphinx.util import logging
 
-from .. import _, __version__
+from . import _, __version__
 
 _log = logging.getLogger(__name__)
 

{t_doc_common-0.22 → t_doc_common-0.23.dev1}/tdoc/common/static/tdoc/styles.css.jinja

@@ -336,8 +336,9 @@ div.tdoc-exec div.tdoc-exec-controls {
 .article-header-buttons button.pst-navbar-icon {
     height: inherit;
 }
-.article-header-buttons .svg-inline--fa {
-    vertical-align: middle;
+.article-header-buttons .btn__icon-container {
+    display: flex;
+    align-items: center;
 }
 
 /* Prevent the wrapper background set by pygments from being visible if the