Compare commits
21 Commits
ef8da4e6cc
...
dev
Author | SHA1 | Date | |
---|---|---|---|
f158698380
|
|||
56c8e796b7
|
|||
8f0320f262
|
|||
ee6e645cc1
|
|||
544229b7a6
|
|||
6acf6d1d6e
|
|||
02737bf9b4
|
|||
29bdad09bf
|
|||
16dbd3a82a
|
|||
33a3858b02
|
|||
e2e4083321
|
|||
2ca7f8e908
|
|||
7d9cae76c1
|
|||
a4b3d10c66
|
|||
011042bc15
|
|||
5229ed167b
|
|||
5fde70418b
|
|||
ec45c719ee
|
|||
94670e5aaf
|
|||
707c74f042
|
|||
49a9bad07f
|
74
.gitea/workflows/build.yaml
Normal file
74
.gitea/workflows/build.yaml
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
name: CI
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
jobs:
|
||||||
|
build_pip_package:
|
||||||
|
name: "Build Pip package"
|
||||||
|
runs-on: woryzen
|
||||||
|
steps:
|
||||||
|
- name: Checkout sources
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
fetch-tags: true
|
||||||
|
- uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
cache: 'pip'
|
||||||
|
- name: Bugis Core
|
||||||
|
run: |
|
||||||
|
cd core
|
||||||
|
python -m venv .venv
|
||||||
|
.venv/bin/pip install -r requirements-dev.txt
|
||||||
|
.venv/bin/python -m build
|
||||||
|
.venv/bin/pip install .
|
||||||
|
.venv/bin/python -m mypy -p src
|
||||||
|
.venv/bin/python -m unittest discover -s tests
|
||||||
|
- name: Publish artifacts
|
||||||
|
env:
|
||||||
|
TWINE_REPOSITORY_URL: ${{ vars.PYPI_REGISTRY_URL }}
|
||||||
|
TWINE_USERNAME: ${{ vars.PUBLISHER_USERNAME }}
|
||||||
|
TWINE_PASSWORD: ${{ secrets.PUBLISHER_TOKEN }}
|
||||||
|
run: |
|
||||||
|
cd core
|
||||||
|
.venv/bin/python -m twine upload --repository gitea dist/*{.whl,tar.gz}
|
||||||
|
build_docker_image:
|
||||||
|
name: "Build Docker image"
|
||||||
|
runs-on: woryzen
|
||||||
|
steps:
|
||||||
|
- name: Checkout sources
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
fetch-tags: true
|
||||||
|
- name: Get package version
|
||||||
|
run: |
|
||||||
|
echo VERSION=$(python -m setuptools_scm) >> "$GITHUB_ENV"
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3.4.0
|
||||||
|
with:
|
||||||
|
driver: docker-container
|
||||||
|
platforms: |
|
||||||
|
linux/amd64
|
||||||
|
linux/arm64
|
||||||
|
- name: Login to Gitea container registry
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: gitea.woggioni.net
|
||||||
|
username: woggioni
|
||||||
|
password: ${{ secrets.PUBLISHER_TOKEN }}
|
||||||
|
- name: Build and push bugis images
|
||||||
|
uses: docker/build-push-action@v6
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
platforms: |
|
||||||
|
linux/amd64
|
||||||
|
linux/arm64
|
||||||
|
push: true
|
||||||
|
pull: true
|
||||||
|
tags: |
|
||||||
|
"gitea.woggioni.net/woggioni/bugis:latest"
|
||||||
|
"gitea.woggioni.net/woggioni/bugis:${{ env.VERSION }}"
|
||||||
|
cache-from: type=registry,ref=gitea.woggioni.net/woggioni/bugis:buildx
|
||||||
|
cache-to: type=registry,mode=max,compression=zstd,image-manifest=true,oci-mediatypes=true,ref=gitea.woggioni.net/woggioni/bugis:buildx
|
7
.gitignore
vendored
Normal file
7
.gitignore
vendored
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
.venv
|
||||||
|
__pycache__
|
||||||
|
*.pyc
|
||||||
|
_version.py
|
||||||
|
*.egg-info
|
||||||
|
/build
|
||||||
|
/dist
|
42
Dockerfile
Normal file
42
Dockerfile
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
FROM alpine:latest AS base
|
||||||
|
LABEL org.opencontainers.image.authors=oggioni.walter@gmail.com
|
||||||
|
RUN --mount=type=cache,target=/var/cache/apk apk update
|
||||||
|
RUN --mount=type=cache,target=/var/cache/apk apk add python3 py3-pip graphviz
|
||||||
|
|
||||||
|
FROM base AS build
|
||||||
|
RUN --mount=type=cache,target=/var/cache/apk apk add musl-dev gcc graphviz-dev git
|
||||||
|
RUN adduser -D luser
|
||||||
|
USER luser
|
||||||
|
WORKDIR /home/luser
|
||||||
|
COPY --chown=luser:users ./requirements-dev.txt ./requirements-dev.txt
|
||||||
|
COPY --chown=luser:users ./requirements-run.txt ./requirements-run.txt
|
||||||
|
WORKDIR /home/luser/
|
||||||
|
RUN python -m venv .venv
|
||||||
|
RUN --mount=type=cache,target=/home/luser/.cache/pip,uid=1000,gid=1000 .venv/bin/pip wheel -w /home/luser/wheel pygraphviz
|
||||||
|
RUN --mount=type=cache,target=/home/luser/.cache/pip,uid=1000,gid=1000 .venv/bin/pip install -r requirements-dev.txt /home/luser/wheel/*.whl
|
||||||
|
COPY --chown=luser:users . /home/luser/bugis
|
||||||
|
WORKDIR /home/luser/bugis
|
||||||
|
RUN rm -rf .venv dist build
|
||||||
|
RUN --mount=type=cache,target=/home/luser/.cache/pip,uid=1000,gid=1000 /home/luser/.venv/bin/python -m build
|
||||||
|
|
||||||
|
FROM base AS release
|
||||||
|
RUN mkdir /srv/http
|
||||||
|
RUN adduser -D -h /var/lib/bugis -u 1000 bugis
|
||||||
|
USER bugis
|
||||||
|
WORKDIR /var/lib/bugis
|
||||||
|
COPY --chown=bugis:users conf/pip.conf ./.pip/pip.conf
|
||||||
|
RUN python -m venv .venv
|
||||||
|
RUN --mount=type=cache,target=/var/bugis/.cache/pip,uid=1000,gid=1000 --mount=type=bind,ro,from=build,source=/home/luser/requirements-run.txt,target=/requirements-run.txt --mount=type=bind,ro,from=build,source=/home/luser/wheel,target=/wheel .venv/bin/pip install -r /requirements-run.txt /wheel/*.whl
|
||||||
|
RUN --mount=type=cache,target=/var/bugis/.cache/pip,uid=1000,gid=1000 --mount=type=bind,ro,from=build,source=/home/luser/bugis/dist,target=/dist .venv/bin/pip install /dist/*.whl
|
||||||
|
VOLUME /srv/http
|
||||||
|
WORKDIR /srv/http
|
||||||
|
|
||||||
|
ENV GRANIAN_HOST=0.0.0.0
|
||||||
|
ENV GRANIAN_PORT=8000
|
||||||
|
ENV GRANIAN_INTERFACE=asgi
|
||||||
|
ENV GRANIAN_LOOP=asyncio
|
||||||
|
ENV GRANIAN_LOG_ENABLED=false
|
||||||
|
ENV GRANIAN_LOG_ACCESS_ENABLED=true
|
||||||
|
ENTRYPOINT ["/var/lib/bugis/.venv/bin/python", "-m", "granian", "bugis.asgi:application"]
|
||||||
|
EXPOSE 8000/tcp
|
||||||
|
|
47
README.md
47
README.md
@@ -1,11 +1,40 @@
|
|||||||
# Run
|
|
||||||
|
## How to
|
||||||
|
|
||||||
|
### Build the docker image
|
||||||
```bash
|
```bash
|
||||||
uwsgi --need-plugin /usr/lib/uwsgi/python_plugin.so \
|
docker build -t gitea.woggioni.net/woggioni/bugis:latest .
|
||||||
--need-plugin /usr/lib/uwsgi/gevent_plugin.so \
|
|
||||||
-H venv \
|
|
||||||
--http :1180 \
|
|
||||||
-w md2html.uwsgi_handler \
|
|
||||||
--http-keepalive \
|
|
||||||
--http-auto-chunked \
|
|
||||||
--gevent 10
|
|
||||||
```
|
```
|
||||||
|
### Build the pip package
|
||||||
|
```bash
|
||||||
|
pyproject-build
|
||||||
|
```
|
||||||
|
|
||||||
|
### Run in docker
|
||||||
|
```bash
|
||||||
|
docker run --rm -v /your/document/directory:/srv/http --user $(id -u):$(id -g) -p 127.0.0.1:8000:8000 gitea.woggioni.net/woggioni/bugis:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
### Run in docker with `nginx` and `plantUML` server
|
||||||
|
|
||||||
|
```bash
|
||||||
|
STATIC_ROOT=/your/document/directory UID=$(id -u) GID=$(id -g) docker compose up --build
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install with pipx
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pipx install -r requirements-run.txt .
|
||||||
|
```
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pipx install --extra-index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple/ bugis[run]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Run from cli
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bugis -a 127.0.0.1 -p 8000
|
||||||
|
```
|
@@ -1,10 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
set -e
|
|
||||||
|
|
||||||
venv/bin/python -m build
|
|
||||||
mkdir -p docker/build
|
|
||||||
cp dist/md2html-*.whl docker/build/
|
|
||||||
cp docker/Dockerfile docker/build/Dockerfile
|
|
||||||
cp docker/uwsgi.ini docker/build/uwsgi.ini
|
|
||||||
|
|
||||||
docker build docker/build --tag alpine:md2html
|
|
54
cli/pyproject.toml
Normal file
54
cli/pyproject.toml
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=61.0", "setuptools-scm>=8"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "bugis_cli"
|
||||||
|
dynamic = ["version"]
|
||||||
|
authors = [
|
||||||
|
{ name="Walter Oggioni", email="oggioni.walter@gmail.com" },
|
||||||
|
]
|
||||||
|
description = "Markdown to HTML renderer"
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.10"
|
||||||
|
classifiers = [
|
||||||
|
'Development Status :: 3 - Alpha',
|
||||||
|
'Topic :: Utilities',
|
||||||
|
'License :: OSI Approved :: MIT License',
|
||||||
|
'Intended Audience :: System Administrators',
|
||||||
|
'Intended Audience :: Developers',
|
||||||
|
'Environment :: Console',
|
||||||
|
'License :: OSI Approved :: MIT License',
|
||||||
|
'Programming Language :: Python :: 3',
|
||||||
|
]
|
||||||
|
|
||||||
|
dependencies = [
|
||||||
|
"granian",
|
||||||
|
"bugis"
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"build", "mypy", "ipdb", "twine"
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
"Homepage" = "https://github.com/woggioni/bugis"
|
||||||
|
"Bug Tracker" = "https://github.com/woggioni/bugis/issues"
|
||||||
|
|
||||||
|
[tool.mypy]
|
||||||
|
python_version = "3.12"
|
||||||
|
disallow_untyped_defs = true
|
||||||
|
show_error_codes = true
|
||||||
|
no_implicit_optional = true
|
||||||
|
warn_return_any = true
|
||||||
|
warn_unused_ignores = true
|
||||||
|
exclude = ["scripts", "docs", "test"]
|
||||||
|
strict = true
|
||||||
|
|
||||||
|
[tool.setuptools_scm]
|
||||||
|
root='..'
|
||||||
|
version_file = "src/bugis/cli/_version.py"
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
bugis = "bugis.cli:main"
|
171
cli/requirements-dev.txt
Normal file
171
cli/requirements-dev.txt
Normal file
@@ -0,0 +1,171 @@
|
|||||||
|
#
|
||||||
|
# This file is autogenerated by pip-compile with Python 3.12
|
||||||
|
# by the following command:
|
||||||
|
#
|
||||||
|
# pip-compile --extra=dev --output-file=requirements-dev.txt
|
||||||
|
#
|
||||||
|
--index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
|
--extra-index-url https://pypi.org/simple
|
||||||
|
|
||||||
|
aiofiles==24.1.0
|
||||||
|
# via bugis
|
||||||
|
anyio==4.6.2.post1
|
||||||
|
# via httpx
|
||||||
|
asttokens==2.4.1
|
||||||
|
# via stack-data
|
||||||
|
bugis==0.2.2
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
build==1.2.2.post1
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
certifi==2024.8.30
|
||||||
|
# via
|
||||||
|
# httpcore
|
||||||
|
# httpx
|
||||||
|
# requests
|
||||||
|
cffi==1.17.1
|
||||||
|
# via cryptography
|
||||||
|
charset-normalizer==3.4.0
|
||||||
|
# via requests
|
||||||
|
click==8.1.7
|
||||||
|
# via granian
|
||||||
|
cryptography==43.0.3
|
||||||
|
# via secretstorage
|
||||||
|
decorator==5.1.1
|
||||||
|
# via
|
||||||
|
# ipdb
|
||||||
|
# ipython
|
||||||
|
docutils==0.21.2
|
||||||
|
# via readme-renderer
|
||||||
|
executing==2.1.0
|
||||||
|
# via stack-data
|
||||||
|
granian==1.6.3
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
h11==0.14.0
|
||||||
|
# via httpcore
|
||||||
|
h2==4.1.0
|
||||||
|
# via httpx
|
||||||
|
hpack==4.0.0
|
||||||
|
# via h2
|
||||||
|
httpcore==1.0.6
|
||||||
|
# via httpx
|
||||||
|
httpx[http2]==0.27.2
|
||||||
|
# via bugis
|
||||||
|
hyperframe==6.0.1
|
||||||
|
# via h2
|
||||||
|
idna==3.10
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
# requests
|
||||||
|
importlib-metadata==8.5.0
|
||||||
|
# via twine
|
||||||
|
ipdb==0.13.13
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
ipython==8.29.0
|
||||||
|
# via ipdb
|
||||||
|
jaraco-classes==3.4.0
|
||||||
|
# via keyring
|
||||||
|
jaraco-context==6.0.1
|
||||||
|
# via keyring
|
||||||
|
jaraco-functools==4.1.0
|
||||||
|
# via keyring
|
||||||
|
jedi==0.19.1
|
||||||
|
# via ipython
|
||||||
|
jeepney==0.8.0
|
||||||
|
# via
|
||||||
|
# keyring
|
||||||
|
# secretstorage
|
||||||
|
keyring==25.5.0
|
||||||
|
# via twine
|
||||||
|
markdown==3.7
|
||||||
|
# via bugis
|
||||||
|
markdown-it-py==3.0.0
|
||||||
|
# via rich
|
||||||
|
matplotlib-inline==0.1.7
|
||||||
|
# via ipython
|
||||||
|
mdurl==0.1.2
|
||||||
|
# via markdown-it-py
|
||||||
|
more-itertools==10.5.0
|
||||||
|
# via
|
||||||
|
# jaraco-classes
|
||||||
|
# jaraco-functools
|
||||||
|
mypy==1.13.0
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
mypy-extensions==1.0.0
|
||||||
|
# via mypy
|
||||||
|
nh3==0.2.18
|
||||||
|
# via readme-renderer
|
||||||
|
packaging==24.1
|
||||||
|
# via build
|
||||||
|
parso==0.8.4
|
||||||
|
# via jedi
|
||||||
|
pexpect==4.9.0
|
||||||
|
# via ipython
|
||||||
|
pkginfo==1.10.0
|
||||||
|
# via twine
|
||||||
|
prompt-toolkit==3.0.48
|
||||||
|
# via ipython
|
||||||
|
ptyprocess==0.7.0
|
||||||
|
# via pexpect
|
||||||
|
pure-eval==0.2.3
|
||||||
|
# via stack-data
|
||||||
|
pwo==0.0.4
|
||||||
|
# via bugis
|
||||||
|
pycparser==2.22
|
||||||
|
# via cffi
|
||||||
|
pygments==2.18.0
|
||||||
|
# via
|
||||||
|
# bugis
|
||||||
|
# ipython
|
||||||
|
# readme-renderer
|
||||||
|
# rich
|
||||||
|
pygraphviz==1.14
|
||||||
|
# via bugis
|
||||||
|
pyproject-hooks==1.2.0
|
||||||
|
# via build
|
||||||
|
pyyaml==6.0.2
|
||||||
|
# via bugis
|
||||||
|
readme-renderer==44.0
|
||||||
|
# via twine
|
||||||
|
requests==2.32.3
|
||||||
|
# via
|
||||||
|
# requests-toolbelt
|
||||||
|
# twine
|
||||||
|
requests-toolbelt==1.0.0
|
||||||
|
# via twine
|
||||||
|
rfc3986==2.0.0
|
||||||
|
# via twine
|
||||||
|
rich==13.9.3
|
||||||
|
# via twine
|
||||||
|
secretstorage==3.3.3
|
||||||
|
# via keyring
|
||||||
|
six==1.16.0
|
||||||
|
# via asttokens
|
||||||
|
sniffio==1.3.1
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
stack-data==0.6.3
|
||||||
|
# via ipython
|
||||||
|
traitlets==5.14.3
|
||||||
|
# via
|
||||||
|
# ipython
|
||||||
|
# matplotlib-inline
|
||||||
|
twine==5.1.1
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
typing-extensions==4.12.2
|
||||||
|
# via
|
||||||
|
# mypy
|
||||||
|
# pwo
|
||||||
|
urllib3==2.2.3
|
||||||
|
# via
|
||||||
|
# requests
|
||||||
|
# twine
|
||||||
|
uvloop==0.21.0
|
||||||
|
# via granian
|
||||||
|
watchdog==5.0.3
|
||||||
|
# via bugis
|
||||||
|
wcwidth==0.2.13
|
||||||
|
# via prompt-toolkit
|
||||||
|
zipp==3.20.2
|
||||||
|
# via importlib-metadata
|
59
cli/requirements.txt
Normal file
59
cli/requirements.txt
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
#
|
||||||
|
# This file is autogenerated by pip-compile with Python 3.12
|
||||||
|
# by the following command:
|
||||||
|
#
|
||||||
|
# pip-compile --output-file=requirements.txt
|
||||||
|
#
|
||||||
|
--index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
|
--extra-index-url https://pypi.org/simple
|
||||||
|
|
||||||
|
aiofiles==24.1.0
|
||||||
|
# via bugis
|
||||||
|
anyio==4.6.2.post1
|
||||||
|
# via httpx
|
||||||
|
bugis==0.2.2
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
certifi==2024.8.30
|
||||||
|
# via
|
||||||
|
# httpcore
|
||||||
|
# httpx
|
||||||
|
click==8.1.7
|
||||||
|
# via granian
|
||||||
|
granian==1.6.3
|
||||||
|
# via bugis_cli (pyproject.toml)
|
||||||
|
h11==0.14.0
|
||||||
|
# via httpcore
|
||||||
|
h2==4.1.0
|
||||||
|
# via httpx
|
||||||
|
hpack==4.0.0
|
||||||
|
# via h2
|
||||||
|
httpcore==1.0.6
|
||||||
|
# via httpx
|
||||||
|
httpx[http2]==0.27.2
|
||||||
|
# via bugis
|
||||||
|
hyperframe==6.0.1
|
||||||
|
# via h2
|
||||||
|
idna==3.10
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
markdown==3.7
|
||||||
|
# via bugis
|
||||||
|
pwo==0.0.4
|
||||||
|
# via bugis
|
||||||
|
pygments==2.18.0
|
||||||
|
# via bugis
|
||||||
|
pygraphviz==1.14
|
||||||
|
# via bugis
|
||||||
|
pyyaml==6.0.2
|
||||||
|
# via bugis
|
||||||
|
sniffio==1.3.1
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
typing-extensions==4.12.2
|
||||||
|
# via pwo
|
||||||
|
uvloop==0.21.0
|
||||||
|
# via granian
|
||||||
|
watchdog==5.0.3
|
||||||
|
# via bugis
|
118
cli/src/bugis/cli/__init__.py
Normal file
118
cli/src/bugis/cli/__init__.py
Normal file
@@ -0,0 +1,118 @@
|
|||||||
|
from os import environ
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Optional, Sequence
|
||||||
|
import argparse
|
||||||
|
import yaml
|
||||||
|
from granian import Granian
|
||||||
|
from pwo import Maybe
|
||||||
|
|
||||||
|
from bugis.configuration import instance, Configuration
|
||||||
|
from granian.constants import HTTPModes, ThreadModes, Loops
|
||||||
|
from dataclasses import asdict
|
||||||
|
from typing import Any, Mapping
|
||||||
|
|
||||||
|
def main(args: Optional[Sequence[str]] = None) -> None:
|
||||||
|
parser = argparse.ArgumentParser(description="A simple CLI program to render Markdown files")
|
||||||
|
default_configuration_file = (Maybe.of_nullable(environ.get('XDG_CONFIG_HOME'))
|
||||||
|
.map(lambda it: Path(it))
|
||||||
|
.map(lambda it: it / 'bugis' / 'bugis.yaml')
|
||||||
|
.or_else_get(
|
||||||
|
lambda: Maybe.of_nullable(environ.get('HOME'))
|
||||||
|
.map(lambda it: Path(it) / '.config' / 'bugis' / 'bugis.yaml').or_none())
|
||||||
|
.filter(Path.exists)
|
||||||
|
.or_none()
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-c',
|
||||||
|
'--configuration',
|
||||||
|
help='Path to the configuration file',
|
||||||
|
default=default_configuration_file,
|
||||||
|
type=Path,
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-a',
|
||||||
|
'--address',
|
||||||
|
help='Server bind address',
|
||||||
|
default='127.0.0.1',
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-p',
|
||||||
|
'--port',
|
||||||
|
help='Server port',
|
||||||
|
default='8000',
|
||||||
|
type=int
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--access-log',
|
||||||
|
help='Enable access log',
|
||||||
|
action='store_true',
|
||||||
|
dest='log_access'
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--logging-configuration',
|
||||||
|
help='Logging configuration file',
|
||||||
|
dest='log_config_file'
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-w', '--workers',
|
||||||
|
help='Number of worker processes',
|
||||||
|
default='1',
|
||||||
|
dest='workers',
|
||||||
|
type=int
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-t', '--threads',
|
||||||
|
help='Number of threads per worker',
|
||||||
|
default='1',
|
||||||
|
dest='threads',
|
||||||
|
type=int
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--http',
|
||||||
|
help='HTTP protocol version',
|
||||||
|
dest='http',
|
||||||
|
type=lambda it: HTTPModes(it),
|
||||||
|
choices=[str(mode) for mode in HTTPModes],
|
||||||
|
default='auto',
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--threading-mode',
|
||||||
|
help='Threading mode',
|
||||||
|
dest='threading_mode',
|
||||||
|
type=lambda it: ThreadModes(it),
|
||||||
|
choices=[str(mode) for mode in ThreadModes],
|
||||||
|
default=ThreadModes.workers
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--loop',
|
||||||
|
help='Loop',
|
||||||
|
dest='loop',
|
||||||
|
type=lambda it: Loops(it),
|
||||||
|
choices=[str(mode) for mode in Loops]
|
||||||
|
)
|
||||||
|
arguments = parser.parse_args(args)
|
||||||
|
|
||||||
|
def parse(configuration: Path) -> Any:
|
||||||
|
with open(configuration, 'r') as f:
|
||||||
|
return yaml.safe_load(f)
|
||||||
|
|
||||||
|
def assign(it: Configuration) -> None:
|
||||||
|
global instance
|
||||||
|
instance = it
|
||||||
|
|
||||||
|
Maybe.of_nullable(arguments.configuration).map(parse).if_present(assign)
|
||||||
|
conf = instance
|
||||||
|
|
||||||
|
granian_conf = asdict(conf).setdefault('granian', dict())
|
||||||
|
for k, v in vars(arguments).items():
|
||||||
|
if v is not None:
|
||||||
|
granian_conf[k] = v
|
||||||
|
if arguments.log_config_file:
|
||||||
|
with open(arguments.log_config_file, 'r') as f:
|
||||||
|
granian_conf['log_dictconfig'] = yaml.safe_load(f)
|
||||||
|
granian_conf = Configuration.GranianConfiguration.from_dict(granian_conf)
|
||||||
|
|
||||||
|
Granian(
|
||||||
|
"bugis.asgi:application",
|
||||||
|
**asdict(granian_conf)
|
||||||
|
).serve()
|
4
cli/src/bugis/cli/__main__.py
Normal file
4
cli/src/bugis/cli/__main__.py
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
from . import main
|
||||||
|
import sys
|
||||||
|
|
||||||
|
main(sys.argv[1:])
|
30
cli/src/bugis/cli/default-conf/logging.yaml
Normal file
30
cli/src/bugis/cli/default-conf/logging.yaml
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
version: 1
|
||||||
|
disable_existing_loggers: False
|
||||||
|
handlers:
|
||||||
|
console:
|
||||||
|
class : logging.StreamHandler
|
||||||
|
formatter: default
|
||||||
|
level : INFO
|
||||||
|
stream : ext://sys.stderr
|
||||||
|
access:
|
||||||
|
class : logging.StreamHandler
|
||||||
|
formatter: access
|
||||||
|
level : INFO
|
||||||
|
stream : ext://sys.stdout
|
||||||
|
formatters:
|
||||||
|
default:
|
||||||
|
format: '{asctime}.{msecs:0<3.0f} [{levelname}] ({processName:s}/{threadName:s}) - {name} - {message}'
|
||||||
|
style: '{'
|
||||||
|
datefmt: '%Y-%m-%d %H:%M:%S'
|
||||||
|
access:
|
||||||
|
format: '%(message)s'
|
||||||
|
loggers:
|
||||||
|
root:
|
||||||
|
handlers: [console]
|
||||||
|
_granian:
|
||||||
|
level: INFO
|
||||||
|
propagate: False
|
||||||
|
granian.access:
|
||||||
|
handlers: [ access ]
|
||||||
|
level: INFO
|
||||||
|
propagate: False
|
14
conf/nginx-bugis.conf
Normal file
14
conf/nginx-bugis.conf
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
server {
|
||||||
|
listen 8080;
|
||||||
|
http2 on;
|
||||||
|
|
||||||
|
server_name localhost;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://granian:8000;
|
||||||
|
proxy_http_version 1.1;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_read_timeout 60s;
|
||||||
|
}
|
||||||
|
}
|
3
conf/pip.conf
Normal file
3
conf/pip.conf
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
[global]
|
||||||
|
index-url = https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
|
extra-index-url = https://pypi.org/simple
|
46
core/conf/logging.json
Normal file
46
core/conf/logging.json
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
{
|
||||||
|
"version": 1,
|
||||||
|
"disable_existing_loggers": false,
|
||||||
|
"handlers": {
|
||||||
|
"console": {
|
||||||
|
"class": "logging.StreamHandler",
|
||||||
|
"formatter": "default",
|
||||||
|
"level": "DEBUG",
|
||||||
|
"stream": "ext://sys.stderr"
|
||||||
|
},
|
||||||
|
"access": {
|
||||||
|
"class": "logging.StreamHandler",
|
||||||
|
"formatter": "access",
|
||||||
|
"level": "DEBUG",
|
||||||
|
"stream": "ext://sys.stdout"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"formatters": {
|
||||||
|
"default": {
|
||||||
|
"format": "{asctime}.{msecs:0<3.0f} [{levelname}] ({processName:s}/{threadName:s}) - {name} - {message}",
|
||||||
|
"style": "{",
|
||||||
|
"datefmt": "%Y-%m-%d %H:%M:%S"
|
||||||
|
},
|
||||||
|
"access": {
|
||||||
|
"format": "%(message)s"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"loggers": {
|
||||||
|
"root": {
|
||||||
|
"handlers": [
|
||||||
|
"console"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"_granian": {
|
||||||
|
"level": "DEBUG",
|
||||||
|
"propagate": false
|
||||||
|
},
|
||||||
|
"granian.access": {
|
||||||
|
"handlers": [
|
||||||
|
"access"
|
||||||
|
],
|
||||||
|
"level": "DEBUG",
|
||||||
|
"propagate": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
20
core/example/hello.py
Normal file
20
core/example/hello.py
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
from bugis.core import BugisApp, HttpContext
|
||||||
|
|
||||||
|
|
||||||
|
class Hello(BugisApp):
|
||||||
|
|
||||||
|
async def handle_request(self, ctx: HttpContext) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, 'Hello World')
|
||||||
|
|
||||||
|
|
||||||
|
app = BugisApp()
|
||||||
|
|
||||||
|
|
||||||
|
@app.GET('/hello')
|
||||||
|
@app.GET('/hello2')
|
||||||
|
async def handle_request(ctx: HttpContext) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, 'Hello World')
|
55
core/pyproject.toml
Normal file
55
core/pyproject.toml
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=61.0", "setuptools-scm>=8"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "bugis_core"
|
||||||
|
dynamic = ["version"]
|
||||||
|
authors = [
|
||||||
|
{ name="Walter Oggioni", email="oggioni.walter@gmail.com" },
|
||||||
|
]
|
||||||
|
description = "Markdown to HTML renderer"
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.10"
|
||||||
|
classifiers = [
|
||||||
|
'Development Status :: 3 - Alpha',
|
||||||
|
'Topic :: Utilities',
|
||||||
|
'License :: OSI Approved :: MIT License',
|
||||||
|
'Intended Audience :: System Administrators',
|
||||||
|
'Intended Audience :: Developers',
|
||||||
|
'Environment :: Console',
|
||||||
|
'License :: OSI Approved :: MIT License',
|
||||||
|
'Programming Language :: Python :: 3',
|
||||||
|
]
|
||||||
|
|
||||||
|
dependencies = [
|
||||||
|
"pwo",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"build", "mypy", "ipdb", "twine", "granian", "httpx"
|
||||||
|
]
|
||||||
|
|
||||||
|
rsgi = [
|
||||||
|
"granian"
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
"Homepage" = "https://github.com/woggioni/bugis"
|
||||||
|
"Bug Tracker" = "https://github.com/woggioni/bugis/issues"
|
||||||
|
|
||||||
|
[tool.mypy]
|
||||||
|
python_version = "3.12"
|
||||||
|
disallow_untyped_defs = true
|
||||||
|
show_error_codes = true
|
||||||
|
no_implicit_optional = true
|
||||||
|
warn_return_any = true
|
||||||
|
warn_unused_ignores = true
|
||||||
|
exclude = ["scripts", "docs", "test"]
|
||||||
|
strict = true
|
||||||
|
|
||||||
|
[tool.setuptools_scm]
|
||||||
|
root='..'
|
||||||
|
version_file = "src/bugis/core/_version.py"
|
||||||
|
|
138
core/requirements-dev.txt
Normal file
138
core/requirements-dev.txt
Normal file
@@ -0,0 +1,138 @@
|
|||||||
|
#
|
||||||
|
# This file is autogenerated by pip-compile with Python 3.12
|
||||||
|
# by the following command:
|
||||||
|
#
|
||||||
|
# pip-compile --extra=dev --output-file=requirements-dev.txt
|
||||||
|
#
|
||||||
|
--index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
|
--extra-index-url https://pypi.org/simple
|
||||||
|
|
||||||
|
aiofiles==24.1.0
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
asttokens==2.4.1
|
||||||
|
# via stack-data
|
||||||
|
build==1.2.2.post1
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
certifi==2024.8.30
|
||||||
|
# via requests
|
||||||
|
cffi==1.17.1
|
||||||
|
# via cryptography
|
||||||
|
charset-normalizer==3.4.0
|
||||||
|
# via requests
|
||||||
|
cryptography==43.0.3
|
||||||
|
# via secretstorage
|
||||||
|
decorator==5.1.1
|
||||||
|
# via
|
||||||
|
# ipdb
|
||||||
|
# ipython
|
||||||
|
docutils==0.21.2
|
||||||
|
# via readme-renderer
|
||||||
|
executing==2.1.0
|
||||||
|
# via stack-data
|
||||||
|
idna==3.10
|
||||||
|
# via requests
|
||||||
|
importlib-metadata==8.5.0
|
||||||
|
# via twine
|
||||||
|
ipdb==0.13.13
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
ipython==8.29.0
|
||||||
|
# via ipdb
|
||||||
|
jaraco-classes==3.4.0
|
||||||
|
# via keyring
|
||||||
|
jaraco-context==6.0.1
|
||||||
|
# via keyring
|
||||||
|
jaraco-functools==4.1.0
|
||||||
|
# via keyring
|
||||||
|
jedi==0.19.1
|
||||||
|
# via ipython
|
||||||
|
jeepney==0.8.0
|
||||||
|
# via
|
||||||
|
# keyring
|
||||||
|
# secretstorage
|
||||||
|
keyring==25.5.0
|
||||||
|
# via twine
|
||||||
|
markdown-it-py==3.0.0
|
||||||
|
# via rich
|
||||||
|
matplotlib-inline==0.1.7
|
||||||
|
# via ipython
|
||||||
|
mdurl==0.1.2
|
||||||
|
# via markdown-it-py
|
||||||
|
more-itertools==10.5.0
|
||||||
|
# via
|
||||||
|
# jaraco-classes
|
||||||
|
# jaraco-functools
|
||||||
|
mypy==1.13.0
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
mypy-extensions==1.0.0
|
||||||
|
# via mypy
|
||||||
|
nh3==0.2.18
|
||||||
|
# via readme-renderer
|
||||||
|
packaging==24.1
|
||||||
|
# via build
|
||||||
|
parso==0.8.4
|
||||||
|
# via jedi
|
||||||
|
pexpect==4.9.0
|
||||||
|
# via ipython
|
||||||
|
pkginfo==1.10.0
|
||||||
|
# via twine
|
||||||
|
prompt-toolkit==3.0.48
|
||||||
|
# via ipython
|
||||||
|
ptyprocess==0.7.0
|
||||||
|
# via pexpect
|
||||||
|
pure-eval==0.2.3
|
||||||
|
# via stack-data
|
||||||
|
pwo==0.0.5
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
pycparser==2.22
|
||||||
|
# via cffi
|
||||||
|
pygments==2.18.0
|
||||||
|
# via
|
||||||
|
# ipython
|
||||||
|
# readme-renderer
|
||||||
|
# rich
|
||||||
|
pyproject-hooks==1.2.0
|
||||||
|
# via build
|
||||||
|
pyyaml==6.0.2
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
readme-renderer==44.0
|
||||||
|
# via twine
|
||||||
|
requests==2.32.3
|
||||||
|
# via
|
||||||
|
# requests-toolbelt
|
||||||
|
# twine
|
||||||
|
requests-toolbelt==1.0.0
|
||||||
|
# via twine
|
||||||
|
rfc3986==2.0.0
|
||||||
|
# via twine
|
||||||
|
rich==13.9.3
|
||||||
|
# via twine
|
||||||
|
secretstorage==3.3.3
|
||||||
|
# via keyring
|
||||||
|
six==1.16.0
|
||||||
|
# via asttokens
|
||||||
|
sortedcontainers==2.4.0
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
stack-data==0.6.3
|
||||||
|
# via ipython
|
||||||
|
traitlets==5.14.3
|
||||||
|
# via
|
||||||
|
# ipython
|
||||||
|
# matplotlib-inline
|
||||||
|
twine==5.1.1
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
types-pyyaml==6.0.12.20240917
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
typing-extensions==4.12.2
|
||||||
|
# via
|
||||||
|
# mypy
|
||||||
|
# pwo
|
||||||
|
urllib3==2.2.3
|
||||||
|
# via
|
||||||
|
# requests
|
||||||
|
# twine
|
||||||
|
watchdog==5.0.3
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
wcwidth==0.2.13
|
||||||
|
# via prompt-toolkit
|
||||||
|
zipp==3.20.2
|
||||||
|
# via importlib-metadata
|
21
core/requirements.txt
Normal file
21
core/requirements.txt
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
#
|
||||||
|
# This file is autogenerated by pip-compile with Python 3.12
|
||||||
|
# by the following command:
|
||||||
|
#
|
||||||
|
# pip-compile --output-file=requirements.txt
|
||||||
|
#
|
||||||
|
--index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
|
--extra-index-url https://pypi.org/simple
|
||||||
|
|
||||||
|
aiofiles==24.1.0
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
pwo==0.0.5
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
pyyaml==6.0.2
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
sortedcontainers==2.4.0
|
||||||
|
# via bugis_core (pyproject.toml)
|
||||||
|
typing-extensions==4.12.2
|
||||||
|
# via pwo
|
||||||
|
watchdog==5.0.3
|
||||||
|
# via bugis_core (pyproject.toml)
|
15
core/src/bugis/core/__init__.py
Normal file
15
core/src/bugis/core/__init__.py
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
from ._app import BugisApp
|
||||||
|
from ._http_method import HttpMethod
|
||||||
|
from ._http_context import HttpContext
|
||||||
|
from ._tree import Tree, PathIterator
|
||||||
|
from ._path_handler import PathHandler
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
'HttpMethod',
|
||||||
|
'BugisApp',
|
||||||
|
'HttpContext',
|
||||||
|
'Tree',
|
||||||
|
'PathHandler',
|
||||||
|
'PathIterator'
|
||||||
|
]
|
149
core/src/bugis/core/_app.py
Normal file
149
core/src/bugis/core/_app.py
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from asyncio import Queue, AbstractEventLoop
|
||||||
|
from asyncio import get_running_loop
|
||||||
|
from logging import getLogger
|
||||||
|
from typing import Callable, Awaitable, Any, Mapping, Sequence, Optional, Unpack, Tuple, TYPE_CHECKING
|
||||||
|
from pathlib import Path, PurePath
|
||||||
|
from pwo import Maybe, AsyncQueueIterator
|
||||||
|
from hashlib import md5
|
||||||
|
from ._http_context import HttpContext
|
||||||
|
from ._http_method import HttpMethod
|
||||||
|
from ._types import StrOrStrings
|
||||||
|
from base64 import b64encode, b64decode
|
||||||
|
from mimetypes import guess_type
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from _typeshed import StrOrBytesPath
|
||||||
|
try:
|
||||||
|
from ._rsgi import RsgiContext
|
||||||
|
from granian._granian import RSGIHTTPProtocol, RSGIHTTPScope # type: ignore
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
from ._asgi import AsgiContext
|
||||||
|
from ._tree import Tree
|
||||||
|
from ._types.asgi import LifespanScope, HTTPScope as ASGIHTTPScope, WebSocketScope
|
||||||
|
|
||||||
|
log = getLogger(__name__)
|
||||||
|
|
||||||
|
type HttpHandler = Callable[[HttpContext, Unpack[Any]], Awaitable[None]]
|
||||||
|
|
||||||
|
|
||||||
|
class AbstractBugisApp(ABC):
|
||||||
|
async def __call__(self,
|
||||||
|
scope: ASGIHTTPScope | WebSocketScope | LifespanScope,
|
||||||
|
receive: Callable[[], Awaitable[Any]],
|
||||||
|
send: Callable[[Mapping[str, Any]], Awaitable[None]]) -> None:
|
||||||
|
loop = get_running_loop()
|
||||||
|
if scope['type'] == 'lifespan':
|
||||||
|
while True:
|
||||||
|
message = await receive()
|
||||||
|
if message['type'] == 'lifespan.startup':
|
||||||
|
self.setup(loop)
|
||||||
|
await send({'type': 'lifespan.startup.complete'})
|
||||||
|
elif message['type'] == 'lifespan.shutdown':
|
||||||
|
self.shutdown(loop)
|
||||||
|
await send({'type': 'lifespan.shutdown.complete'})
|
||||||
|
elif scope['type'] == 'http':
|
||||||
|
queue: Queue[Optional[bytes]] = Queue()
|
||||||
|
ctx = AsgiContext(scope, receive, send, AsyncQueueIterator(queue))
|
||||||
|
request_handling = loop.create_task(self.handle_request(ctx))
|
||||||
|
while True:
|
||||||
|
message = await receive()
|
||||||
|
if message['type'] == 'http.request':
|
||||||
|
Maybe.of(message['body']).filter(lambda it: len(it) > 0).if_present(queue.put_nowait)
|
||||||
|
if not message.get('more_body', False):
|
||||||
|
queue.put_nowait(None)
|
||||||
|
await request_handling
|
||||||
|
break
|
||||||
|
elif message['type'] == 'http.disconnect':
|
||||||
|
request_handling.cancel()
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
|
def setup(self, loop: AbstractEventLoop) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def shutdown(self, loop: AbstractEventLoop) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def handle_request(self, ctx: HttpContext) -> None:
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
|
def __rsgi_init__(self, loop: AbstractEventLoop) -> None:
|
||||||
|
self.setup(loop)
|
||||||
|
|
||||||
|
def __rsgi_del__(self, loop: AbstractEventLoop) -> None:
|
||||||
|
self.shutdown(loop)
|
||||||
|
|
||||||
|
async def __rsgi__(self, scope: RSGIHTTPScope, protocol: RSGIHTTPProtocol) -> None:
|
||||||
|
ctx = RsgiContext(scope, protocol)
|
||||||
|
await self.handle_request(ctx)
|
||||||
|
|
||||||
|
|
||||||
|
class BugisApp(AbstractBugisApp):
|
||||||
|
_tree: Tree
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self._tree = Tree()
|
||||||
|
|
||||||
|
async def handle_request(self, ctx: HttpContext) -> None:
|
||||||
|
result = self._tree.get_handler(ctx.path, ctx.method)
|
||||||
|
if result is not None:
|
||||||
|
handler, captured = result
|
||||||
|
await handler.handle_request(ctx, captured)
|
||||||
|
else:
|
||||||
|
await ctx.send_empty(404)
|
||||||
|
pass
|
||||||
|
|
||||||
|
def route(self,
|
||||||
|
paths: StrOrStrings,
|
||||||
|
methods: Optional[HttpMethod | Sequence[HttpMethod]] = None,
|
||||||
|
recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
|
||||||
|
def wrapped(handler: HttpHandler) -> HttpHandler:
|
||||||
|
nonlocal methods
|
||||||
|
nonlocal paths
|
||||||
|
_methods: Tuple[Optional[HttpMethod], ...]
|
||||||
|
if methods is None:
|
||||||
|
_methods = (None,)
|
||||||
|
elif isinstance(methods, HttpMethod):
|
||||||
|
_methods = (methods,)
|
||||||
|
else:
|
||||||
|
_methods = tuple(methods)
|
||||||
|
_paths: Tuple[str, ...]
|
||||||
|
if isinstance(paths, str):
|
||||||
|
_paths = (paths,)
|
||||||
|
else:
|
||||||
|
_paths = tuple(paths)
|
||||||
|
for method in _methods:
|
||||||
|
for path in _paths:
|
||||||
|
self._tree.register(path, method, handler, recursive)
|
||||||
|
return handler
|
||||||
|
|
||||||
|
return wrapped
|
||||||
|
|
||||||
|
def GET(self, path: str, recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
return self.route(path, (HttpMethod.GET,), recursive)
|
||||||
|
|
||||||
|
def POST(self, path: str, recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
return self.route(path, (HttpMethod.POST,), recursive)
|
||||||
|
|
||||||
|
def PUT(self, path: str, recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
return self.route(path, (HttpMethod.PUT,), recursive)
|
||||||
|
|
||||||
|
def DELETE(self, path: str, recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
return self.route(path, (HttpMethod.DELETE,), recursive)
|
||||||
|
|
||||||
|
def OPTIONS(self, path: str, recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
return self.route(path, (HttpMethod.OPTIONS,), recursive)
|
||||||
|
|
||||||
|
def HEAD(self, path: str, recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
return self.route(path, (HttpMethod.HEAD,), recursive)
|
||||||
|
|
||||||
|
def PATCH(self, path: str, recursive: bool = False) -> Callable[[HttpHandler], HttpHandler]:
|
||||||
|
return self.route(path, (HttpMethod.PATCH,), recursive)
|
||||||
|
|
||||||
|
|
148
core/src/bugis/core/_asgi.py
Normal file
148
core/src/bugis/core/_asgi.py
Normal file
@@ -0,0 +1,148 @@
|
|||||||
|
from typing import (
|
||||||
|
Sequence,
|
||||||
|
Tuple,
|
||||||
|
Dict,
|
||||||
|
Mapping,
|
||||||
|
Callable,
|
||||||
|
Any,
|
||||||
|
AsyncIterator,
|
||||||
|
Awaitable,
|
||||||
|
AsyncGenerator,
|
||||||
|
Optional,
|
||||||
|
List,
|
||||||
|
Iterable
|
||||||
|
)
|
||||||
|
|
||||||
|
from pwo import Maybe
|
||||||
|
from pathlib import Path
|
||||||
|
from ._http_method import HttpMethod
|
||||||
|
from ._http_context import HttpContext
|
||||||
|
from ._types import StrOrStrings
|
||||||
|
from ._types.asgi import HTTPScope
|
||||||
|
|
||||||
|
|
||||||
|
def decode_headers(headers: Iterable[Tuple[bytes, bytes]]) -> Dict[str, Sequence[str]]:
|
||||||
|
result: Dict[str, List[str]] = dict()
|
||||||
|
for key, value in headers:
|
||||||
|
key_str: str
|
||||||
|
value_str: str
|
||||||
|
if isinstance(key, bytes):
|
||||||
|
key_str = key.decode()
|
||||||
|
elif isinstance(key, str):
|
||||||
|
key_str = key
|
||||||
|
else:
|
||||||
|
raise NotImplementedError('This should never happen')
|
||||||
|
if isinstance(value, bytes):
|
||||||
|
value_str = value.decode()
|
||||||
|
elif isinstance(value, str):
|
||||||
|
value_str = value
|
||||||
|
else:
|
||||||
|
raise NotImplementedError('This should never happen')
|
||||||
|
ls = result.setdefault(key_str.lower(), list())
|
||||||
|
ls.append(value_str)
|
||||||
|
return {
|
||||||
|
k: tuple(v) for k, v in result.items()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def encode_headers(headers: Mapping[str, StrOrStrings]) -> Tuple[Tuple[bytes, bytes], ...]:
|
||||||
|
result = []
|
||||||
|
for key, value in headers.items():
|
||||||
|
if isinstance(value, str):
|
||||||
|
result.append((key.encode(), value.encode()))
|
||||||
|
elif isinstance(value, Sequence):
|
||||||
|
for single_value in value:
|
||||||
|
result.append((key.encode(), single_value.encode()))
|
||||||
|
return tuple(result)
|
||||||
|
|
||||||
|
|
||||||
|
class AsgiContext(HttpContext):
|
||||||
|
pathsend: bool
|
||||||
|
receive: Callable[[], Awaitable[Any]]
|
||||||
|
send: Callable[[Mapping[str, Any]], Awaitable[None]]
|
||||||
|
scheme: str
|
||||||
|
method: HttpMethod
|
||||||
|
path: str
|
||||||
|
query_string: str
|
||||||
|
headers: Mapping[str, Sequence[str]]
|
||||||
|
client: Optional[Tuple[str, int]]
|
||||||
|
server: Optional[Tuple[str, Optional[int]]]
|
||||||
|
request_body: AsyncIterator[bytes]
|
||||||
|
|
||||||
|
def __init__(self,
|
||||||
|
scope: HTTPScope,
|
||||||
|
receive: Callable[[], Awaitable[Any]],
|
||||||
|
send: Callable[[Mapping[str, Any]], Awaitable[None]],
|
||||||
|
request_body_iterator: AsyncIterator[bytes]):
|
||||||
|
self.receive = receive
|
||||||
|
self.send = send
|
||||||
|
self.pathsend = (Maybe.of_nullable(scope.get('extensions'))
|
||||||
|
.map(lambda it: it.get("http.response.pathsend"))
|
||||||
|
.is_present)
|
||||||
|
self.path = scope['path']
|
||||||
|
self.query_string = scope['query_string'].decode()
|
||||||
|
self.method = HttpMethod(scope['method'])
|
||||||
|
self.scheme = scope['scheme']
|
||||||
|
self.client = scope['client']
|
||||||
|
self.server = scope['server']
|
||||||
|
self.headers = decode_headers(scope['headers'])
|
||||||
|
self.request_body = request_body_iterator
|
||||||
|
|
||||||
|
async def stream_body(self,
|
||||||
|
status: int,
|
||||||
|
body_generator: AsyncGenerator[bytes, None],
|
||||||
|
headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
await self._send_head(status, headers)
|
||||||
|
async for chunk in body_generator:
|
||||||
|
await self.send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': chunk,
|
||||||
|
'more_body': True
|
||||||
|
})
|
||||||
|
await self.send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': '',
|
||||||
|
'more_body': False
|
||||||
|
})
|
||||||
|
|
||||||
|
async def send_bytes(self, status: int, body: bytes, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
await self._send_head(status, headers)
|
||||||
|
await self.send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': body,
|
||||||
|
})
|
||||||
|
|
||||||
|
async def send_str(self, status: int, body: str, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
await self._send_head(status, headers)
|
||||||
|
await self.send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': body.encode(),
|
||||||
|
})
|
||||||
|
|
||||||
|
async def _send_head(self, status: int, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
await self.send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': status,
|
||||||
|
'headers': Maybe.of_nullable(headers).map(encode_headers).or_else(tuple())
|
||||||
|
})
|
||||||
|
|
||||||
|
async def send_file(self,
|
||||||
|
status: int,
|
||||||
|
path: Path,
|
||||||
|
headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
if self.pathsend:
|
||||||
|
await self._send_head(status, headers)
|
||||||
|
await self.send({
|
||||||
|
'type': 'http.response.pathsend',
|
||||||
|
'path': path
|
||||||
|
})
|
||||||
|
else:
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
|
async def send_empty(self, status: int, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
await self._send_head(status, headers)
|
||||||
|
await self.send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': '',
|
||||||
|
'more_body': False
|
||||||
|
})
|
52
core/src/bugis/core/_http_context.py
Normal file
52
core/src/bugis/core/_http_context.py
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
from typing import (
|
||||||
|
Callable,
|
||||||
|
Awaitable,
|
||||||
|
Tuple,
|
||||||
|
AsyncIterator,
|
||||||
|
AsyncGenerator,
|
||||||
|
Mapping,
|
||||||
|
Sequence,
|
||||||
|
Any,
|
||||||
|
Optional
|
||||||
|
)
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from ._http_method import HttpMethod
|
||||||
|
from ._types.base import StrOrStrings
|
||||||
|
|
||||||
|
|
||||||
|
class HttpContext(ABC):
|
||||||
|
pathsend: bool
|
||||||
|
receive: Callable[[None], Awaitable[Any]]
|
||||||
|
send: Callable[[Mapping[str, Any]], Awaitable[None]]
|
||||||
|
scheme: str
|
||||||
|
method: HttpMethod
|
||||||
|
path: str
|
||||||
|
query_string: str
|
||||||
|
headers: Mapping[str, Sequence[str]]
|
||||||
|
client: Optional[Tuple[str, int]]
|
||||||
|
server: Optional[Tuple[str, Optional[int]]]
|
||||||
|
request_body: AsyncIterator[bytes]
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def stream_body(self,
|
||||||
|
status: int,
|
||||||
|
body_generator: AsyncGenerator[bytes, None],
|
||||||
|
headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def send_bytes(self, status: int, body: bytes, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
async def send_str(self, status: int, body: str, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
await self.send_bytes(status, body.encode(), headers)
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def send_file(self, status: int, path: Path, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def send_empty(self, status: int, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
pass
|
11
core/src/bugis/core/_http_method.py
Normal file
11
core/src/bugis/core/_http_method.py
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
from enum import StrEnum
|
||||||
|
|
||||||
|
|
||||||
|
class HttpMethod(StrEnum):
|
||||||
|
OPTIONS = 'OPTIONS'
|
||||||
|
HEAD = 'HEAD'
|
||||||
|
GET = 'GET'
|
||||||
|
POST = 'POST'
|
||||||
|
PUT = 'PUT'
|
||||||
|
DELETE = 'DELETE'
|
||||||
|
PATCH = 'PATCH'
|
12
core/src/bugis/core/_node.py
Normal file
12
core/src/bugis/core/_node.py
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import (
|
||||||
|
Optional,
|
||||||
|
Dict,
|
||||||
|
List,
|
||||||
|
)
|
||||||
|
from ._types import NodeType
|
||||||
|
from ._path_handler import PathHandler
|
||||||
|
from ._path_matcher import PathMatcher
|
||||||
|
|
||||||
|
|
||||||
|
|
33
core/src/bugis/core/_path_handler.py
Normal file
33
core/src/bugis/core/_path_handler.py
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from typing import (
|
||||||
|
Sequence,
|
||||||
|
Dict,
|
||||||
|
Optional
|
||||||
|
)
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from ._http_context import HttpContext
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Matches:
|
||||||
|
|
||||||
|
kwargs: Dict[str, str] = field(default_factory=dict)
|
||||||
|
|
||||||
|
path: Optional[Sequence[str]] = None
|
||||||
|
|
||||||
|
unmatched_paths: Sequence[str] = field(default_factory=list)
|
||||||
|
|
||||||
|
|
||||||
|
class PathHandler(ABC):
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
async def handle_request(self, ctx: HttpContext, captured: Matches) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
@property
|
||||||
|
@abstractmethod
|
||||||
|
def recursive(self) -> bool:
|
||||||
|
raise NotImplementedError()
|
||||||
|
|
||||||
|
|
||||||
|
type PathHandlers = (PathHandler | Sequence[PathHandler])
|
97
core/src/bugis/core/_path_matcher.py
Normal file
97
core/src/bugis/core/_path_matcher.py
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
from fnmatch import fnmatch
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from typing import Optional, Sequence, Dict, List, Union
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from ._path_handler import PathHandler
|
||||||
|
from ._types import NodeType, PathMatcherResult
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Node:
|
||||||
|
key: NodeType
|
||||||
|
parent: Optional[Union['Node', 'PathMatcher']]
|
||||||
|
children: Dict[NodeType, 'Node']
|
||||||
|
handlers: List[PathHandler]
|
||||||
|
path_matchers: List['PathMatcher']
|
||||||
|
|
||||||
|
|
||||||
|
class PathMatcher(ABC):
|
||||||
|
parent: Optional[Union['Node', 'PathMatcher']]
|
||||||
|
children: Dict[NodeType, Node]
|
||||||
|
handlers: List[PathHandler]
|
||||||
|
path_matchers: List['PathMatcher']
|
||||||
|
|
||||||
|
def __init__(self,
|
||||||
|
parent: Optional[Union['Node', 'PathMatcher']],
|
||||||
|
children: Dict[NodeType, Node],
|
||||||
|
handlers: List[PathHandler],
|
||||||
|
path_matchers: List['PathMatcher']
|
||||||
|
):
|
||||||
|
self.parent = parent
|
||||||
|
self.children = children
|
||||||
|
self.handlers = handlers
|
||||||
|
self.path_matchers = path_matchers
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def match(self, path: Sequence[str]) -> Optional[PathMatcherResult]:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class StrMatcher(PathMatcher):
|
||||||
|
name: str
|
||||||
|
|
||||||
|
def __init__(self,
|
||||||
|
name: str,
|
||||||
|
parent: Optional[Node | PathMatcher],
|
||||||
|
children: Dict[NodeType, Node],
|
||||||
|
handlers: List[PathHandler],
|
||||||
|
path_matchers: List[PathMatcher],
|
||||||
|
):
|
||||||
|
super().__init__(parent, children, handlers, path_matchers)
|
||||||
|
self.name = name
|
||||||
|
|
||||||
|
def match(self, path: Sequence[str]) -> Optional[PathMatcherResult]:
|
||||||
|
if len(path):
|
||||||
|
return {self.name: path[0]}
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class IntMatcher(PathMatcher):
|
||||||
|
name: str
|
||||||
|
|
||||||
|
def __init__(self,
|
||||||
|
name: str,
|
||||||
|
parent: Optional[Node | PathMatcher],
|
||||||
|
children: Dict[NodeType, Node],
|
||||||
|
handlers: List[PathHandler],
|
||||||
|
path_matchers: List[PathMatcher],
|
||||||
|
):
|
||||||
|
super().__init__(parent, children, handlers, path_matchers)
|
||||||
|
self.name = name
|
||||||
|
|
||||||
|
def match(self, path: Sequence[str]) -> Optional[PathMatcherResult]:
|
||||||
|
if len(path) > 0:
|
||||||
|
try:
|
||||||
|
return {self.name: int(path[0])}
|
||||||
|
except ValueError:
|
||||||
|
return None
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
class GlobMatcher(PathMatcher):
|
||||||
|
pattern: str
|
||||||
|
|
||||||
|
def __init__(self,
|
||||||
|
pattern: str,
|
||||||
|
parent: Optional[Node | PathMatcher],
|
||||||
|
children: Dict[NodeType, Node],
|
||||||
|
handlers: List[PathHandler],
|
||||||
|
path_matchers: List[PathMatcher],
|
||||||
|
):
|
||||||
|
super().__init__(parent, children, handlers, path_matchers)
|
||||||
|
self.pattern = pattern
|
||||||
|
|
||||||
|
def match(self, path: Sequence[str]) -> Optional[PathMatcherResult]:
|
||||||
|
return path if fnmatch('/'.join(path), self.pattern) else None
|
107
core/src/bugis/core/_rsgi.py
Normal file
107
core/src/bugis/core/_rsgi.py
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
from functools import reduce
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import (
|
||||||
|
Any,
|
||||||
|
Sequence,
|
||||||
|
Mapping,
|
||||||
|
AsyncIterator,
|
||||||
|
Tuple,
|
||||||
|
AsyncGenerator,
|
||||||
|
Optional,
|
||||||
|
List,
|
||||||
|
Dict,
|
||||||
|
Callable,
|
||||||
|
cast
|
||||||
|
)
|
||||||
|
|
||||||
|
from granian._granian import RSGIHTTPProtocol, RSGIHTTPScope
|
||||||
|
from pwo import Maybe
|
||||||
|
|
||||||
|
from ._types import StrOrStrings
|
||||||
|
from ._http_context import HttpContext
|
||||||
|
from ._http_method import HttpMethod
|
||||||
|
|
||||||
|
|
||||||
|
class RsgiContext(HttpContext):
|
||||||
|
protocol: RSGIHTTPProtocol
|
||||||
|
scheme: str
|
||||||
|
method: HttpMethod
|
||||||
|
path: str
|
||||||
|
query_string: str
|
||||||
|
headers: Mapping[str, Sequence[str]]
|
||||||
|
client: Optional[Tuple[str, int]]
|
||||||
|
server: Optional[Tuple[str, Optional[int]]]
|
||||||
|
request_body: AsyncIterator[bytes]
|
||||||
|
head = Optional[Tuple[int, Sequence[Tuple[str, str]]]]
|
||||||
|
|
||||||
|
def __init__(self, scope: RSGIHTTPScope, protocol: RSGIHTTPProtocol):
|
||||||
|
self.scheme = scope.scheme
|
||||||
|
self.path = scope.path
|
||||||
|
self.method = HttpMethod(scope.method)
|
||||||
|
self.query_string = scope.query_string
|
||||||
|
|
||||||
|
def acc(d: Dict[str, List[str]], t: Tuple[str, str]) -> Dict[str, List[str]]:
|
||||||
|
d.setdefault(t[0].lower(), list()).append(t[1])
|
||||||
|
return d
|
||||||
|
|
||||||
|
fun = cast(Callable[[Mapping[str, Sequence[str]], tuple[str, str]], Mapping[str, Sequence[str]]], acc)
|
||||||
|
self.headers = reduce(fun, scope.headers.items(), {})
|
||||||
|
self.client = (Maybe.of(scope.client.split(':'))
|
||||||
|
.map(lambda it: (it[0], int(it[1])))
|
||||||
|
.or_else_throw(RuntimeError))
|
||||||
|
self.server = (Maybe.of(scope.server.split(':'))
|
||||||
|
.map(lambda it: (it[0], int(it[1])))
|
||||||
|
.or_else_throw(RuntimeError))
|
||||||
|
self.request_body = aiter(protocol)
|
||||||
|
self.protocol = protocol
|
||||||
|
|
||||||
|
# @staticmethod
|
||||||
|
# def _rearrange_headers(headers: Mapping[str, Sequence[str]]) -> List[Tuple[str, str]]:
|
||||||
|
# return list(
|
||||||
|
# ((key, value) for key, values in headers.items() for value in values)
|
||||||
|
# )
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _rearrange_headers(headers: Mapping[str, StrOrStrings]) -> List[Tuple[str, str]]:
|
||||||
|
result = []
|
||||||
|
for key, value in headers.items():
|
||||||
|
if isinstance(value, str):
|
||||||
|
result.append((key, value))
|
||||||
|
elif isinstance(value, Sequence):
|
||||||
|
for single_value in value:
|
||||||
|
result.append((key, single_value))
|
||||||
|
return result
|
||||||
|
|
||||||
|
async def stream_body(self,
|
||||||
|
status: int,
|
||||||
|
body_generator: AsyncGenerator[bytes, None],
|
||||||
|
headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
transport = self.protocol.response_stream(status,
|
||||||
|
Maybe.of_nullable(headers)
|
||||||
|
.map(self._rearrange_headers)
|
||||||
|
.or_else([]))
|
||||||
|
async for chunk in body_generator:
|
||||||
|
await transport.send_bytes(chunk)
|
||||||
|
|
||||||
|
async def send_bytes(self, status: int, body: bytes, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
rearranged_headers = Maybe.of_nullable(headers).map(RsgiContext._rearrange_headers).or_else(list())
|
||||||
|
if len(body) > 0:
|
||||||
|
self.protocol.response_bytes(status, rearranged_headers, body)
|
||||||
|
else:
|
||||||
|
self.protocol.response_empty(status, rearranged_headers)
|
||||||
|
|
||||||
|
async def send_str(self, status: int, body: str, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
rearranged_headers = Maybe.of_nullable(headers).map(RsgiContext._rearrange_headers).or_else(list())
|
||||||
|
if len(body) > 0:
|
||||||
|
self.protocol.response_str(status, rearranged_headers, body)
|
||||||
|
else:
|
||||||
|
self.protocol.response_empty(status, rearranged_headers)
|
||||||
|
|
||||||
|
async def send_file(self, status: int, path: Path, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
rearranged_headers = (Maybe.of_nullable(headers).map(RsgiContext._rearrange_headers)
|
||||||
|
.or_else(list()))
|
||||||
|
self.protocol.response_file(status, rearranged_headers, str(path))
|
||||||
|
|
||||||
|
async def send_empty(self, status: int, headers: Optional[Mapping[str, StrOrStrings]] = None) -> None:
|
||||||
|
rearranged_headers = Maybe.of_nullable(headers).map(RsgiContext._rearrange_headers).or_else(list())
|
||||||
|
self.protocol.response_empty(status, rearranged_headers)
|
224
core/src/bugis/core/_tree.py
Normal file
224
core/src/bugis/core/_tree.py
Normal file
@@ -0,0 +1,224 @@
|
|||||||
|
from itertools import chain
|
||||||
|
from typing import (
|
||||||
|
Sequence,
|
||||||
|
Awaitable,
|
||||||
|
Callable,
|
||||||
|
Optional,
|
||||||
|
Generator,
|
||||||
|
Self,
|
||||||
|
List,
|
||||||
|
Tuple,
|
||||||
|
Mapping,
|
||||||
|
Any,
|
||||||
|
)
|
||||||
|
from typing_extensions import Unpack
|
||||||
|
from urllib.parse import urlparse
|
||||||
|
|
||||||
|
from pwo import Maybe, index_of_with_escape
|
||||||
|
|
||||||
|
from ._http_context import HttpContext
|
||||||
|
from ._http_method import HttpMethod
|
||||||
|
from ._path_handler import PathHandler
|
||||||
|
from ._path_matcher import PathMatcher, IntMatcher, GlobMatcher, StrMatcher, Node
|
||||||
|
from ._path_handler import Matches
|
||||||
|
from ._types import NodeType
|
||||||
|
|
||||||
|
|
||||||
|
class Tree:
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.root = Node('/', None, {}, [], [])
|
||||||
|
|
||||||
|
def search(self, path: Generator[str, None, None], method: HttpMethod) \
|
||||||
|
-> Optional[Tuple[Node | PathMatcher, Matches]]:
|
||||||
|
paths: List[str] = list(path)
|
||||||
|
result: Node | PathMatcher = self.root
|
||||||
|
|
||||||
|
matches = Matches()
|
||||||
|
it, i = iter((it for it in paths)), -1
|
||||||
|
while True:
|
||||||
|
node = result
|
||||||
|
leaf, i = next(it, None), i + 1
|
||||||
|
if leaf is None:
|
||||||
|
break
|
||||||
|
child = node.children.get(leaf)
|
||||||
|
if child is None and isinstance(leaf, str):
|
||||||
|
for matcher in node.path_matchers:
|
||||||
|
match = matcher.match(paths[i:])
|
||||||
|
if match is not None:
|
||||||
|
if isinstance(match, Mapping):
|
||||||
|
matches.kwargs.update(match)
|
||||||
|
elif isinstance(match, Sequence):
|
||||||
|
matches.path = match
|
||||||
|
result = matcher
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
result = child
|
||||||
|
child = result.children.get(method)
|
||||||
|
if child is not None:
|
||||||
|
result = child
|
||||||
|
matches.unmatched_paths = paths[i:]
|
||||||
|
return None if result == self.root else (result, matches)
|
||||||
|
|
||||||
|
def add(self, path: Generator[str, None, None], method: Optional[HttpMethod], *path_handlers: PathHandler) -> Node | PathMatcher:
|
||||||
|
lineage: Generator[NodeType, None, None] = (it for it in
|
||||||
|
chain(path,
|
||||||
|
Maybe.of_nullable(method)
|
||||||
|
.map(lambda it: [it])
|
||||||
|
.or_else([])))
|
||||||
|
result: Node | PathMatcher = self.root
|
||||||
|
it = iter(lineage)
|
||||||
|
|
||||||
|
while True:
|
||||||
|
node = result
|
||||||
|
leaf = next(it, None)
|
||||||
|
if leaf is None:
|
||||||
|
break
|
||||||
|
child = node.children.get(leaf)
|
||||||
|
if child is None:
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
result = child
|
||||||
|
key = leaf
|
||||||
|
while key is not None:
|
||||||
|
new_node = self.parse(key, result)
|
||||||
|
if isinstance(new_node, Node):
|
||||||
|
result.children[key] = new_node
|
||||||
|
else:
|
||||||
|
result.path_matchers.append(new_node)
|
||||||
|
result = new_node
|
||||||
|
key = next(it, None)
|
||||||
|
|
||||||
|
result.handlers = list(chain(result.handlers, path_handlers))
|
||||||
|
return result
|
||||||
|
|
||||||
|
def register(self,
|
||||||
|
path: str,
|
||||||
|
method: Optional[HttpMethod],
|
||||||
|
callback: Callable[[HttpContext, Unpack[Any]], Awaitable[None]],
|
||||||
|
recursive: bool) -> None:
|
||||||
|
class Handler(PathHandler):
|
||||||
|
|
||||||
|
async def handle_request(self, ctx: HttpContext, captured: Matches) -> None:
|
||||||
|
args = Maybe.of_nullable(captured.path).map(lambda it: [it]).or_else([])
|
||||||
|
await callback(ctx, *args, **captured.kwargs)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def recursive(self) -> bool:
|
||||||
|
return recursive
|
||||||
|
|
||||||
|
handler = Handler()
|
||||||
|
self.add((p for p in PathIterator(path)), method, handler)
|
||||||
|
|
||||||
|
def find_node(self, path: Generator[str, None, None], method: HttpMethod = HttpMethod.GET) \
|
||||||
|
-> Optional[Tuple[Node | PathMatcher, Matches]]:
|
||||||
|
return (Maybe.of_nullable(self.search(path, method))
|
||||||
|
.filter(lambda it: len(it[0].handlers) > 0)
|
||||||
|
.or_none())
|
||||||
|
|
||||||
|
def get_handler(self, url: str, method: HttpMethod = HttpMethod.GET) \
|
||||||
|
-> Optional[Tuple[PathHandler, Matches]]:
|
||||||
|
path = urlparse(url).path
|
||||||
|
result: Optional[Tuple[Node | PathMatcher, Matches]] = self.find_node((p for p in PathIterator(path)), method)
|
||||||
|
if result is None:
|
||||||
|
return None
|
||||||
|
node, captured = result
|
||||||
|
# requested = (p for p in PathIterator(path))
|
||||||
|
# found = reversed([n for n in NodeAncestryIterator(node) if n != self.root])
|
||||||
|
# unmatched: List[str] = []
|
||||||
|
# for r, f in zip(requested, found):
|
||||||
|
# if f is None:
|
||||||
|
# unmatched.append(r)
|
||||||
|
for handler in node.handlers:
|
||||||
|
if len(captured.unmatched_paths) == 0:
|
||||||
|
return handler, captured
|
||||||
|
elif handler.recursive:
|
||||||
|
return handler, captured
|
||||||
|
# if handler.match(unmatched, method):
|
||||||
|
# return (handler, unmatched)
|
||||||
|
return None
|
||||||
|
|
||||||
|
def parse(self, leaf: str, parent: Optional[Node | PathMatcher]) -> Node | PathMatcher:
|
||||||
|
start = 0
|
||||||
|
result = index_of_with_escape(leaf, '${', '\\', 0)
|
||||||
|
if result >= 0:
|
||||||
|
start = result + 2
|
||||||
|
end = leaf.index('}', start + 2)
|
||||||
|
definition = leaf[start:end]
|
||||||
|
try:
|
||||||
|
colon = definition.index(':')
|
||||||
|
except ValueError:
|
||||||
|
colon = None
|
||||||
|
if colon is None:
|
||||||
|
key = definition
|
||||||
|
kind = 'str'
|
||||||
|
else:
|
||||||
|
key = definition[:colon]
|
||||||
|
kind = definition[colon+1:] if colon is not None else 'str'
|
||||||
|
if kind == 'str':
|
||||||
|
return StrMatcher(name=key, parent=parent, children={}, handlers=[], path_matchers=[])
|
||||||
|
elif kind == 'int':
|
||||||
|
return IntMatcher(name=key, parent=parent, children={}, handlers=[], path_matchers=[])
|
||||||
|
else:
|
||||||
|
raise ValueError(f"Unknown kind: '{kind}'")
|
||||||
|
result = index_of_with_escape(leaf, '*', '\\', 0)
|
||||||
|
if result >= 0:
|
||||||
|
return GlobMatcher(pattern=leaf, parent=parent, children={}, handlers=[], path_matchers=[])
|
||||||
|
else:
|
||||||
|
return Node(key=leaf, parent=parent, children={}, handlers=[], path_matchers=[])
|
||||||
|
|
||||||
|
|
||||||
|
class PathIterator:
|
||||||
|
path: str
|
||||||
|
cursor: int
|
||||||
|
|
||||||
|
def __init__(self, path: str):
|
||||||
|
self.path = path
|
||||||
|
self.cursor = 0
|
||||||
|
|
||||||
|
def __iter__(self) -> Self:
|
||||||
|
return self
|
||||||
|
|
||||||
|
def advance_cursor(self, next_value: int) -> None:
|
||||||
|
if next_value < len(self.path):
|
||||||
|
self.cursor = next_value
|
||||||
|
else:
|
||||||
|
self.cursor = -1
|
||||||
|
|
||||||
|
def __next__(self) -> str:
|
||||||
|
if self.cursor < 0:
|
||||||
|
raise StopIteration()
|
||||||
|
else:
|
||||||
|
while self.cursor >= 0:
|
||||||
|
next_separator = self.path.find('/', self.cursor)
|
||||||
|
if next_separator < 0:
|
||||||
|
result = self.path[self.cursor:]
|
||||||
|
self.cursor = next_separator
|
||||||
|
return result
|
||||||
|
elif next_separator == self.cursor:
|
||||||
|
self.advance_cursor(next_separator + 1)
|
||||||
|
else:
|
||||||
|
result = self.path[self.cursor:next_separator]
|
||||||
|
self.advance_cursor(next_separator + 1)
|
||||||
|
return result
|
||||||
|
raise StopIteration()
|
||||||
|
|
||||||
|
|
||||||
|
class NodeAncestryIterator:
|
||||||
|
node: Node | PathMatcher
|
||||||
|
|
||||||
|
def __init__(self, node: Node):
|
||||||
|
self.node = node
|
||||||
|
|
||||||
|
def __iter__(self) -> Self:
|
||||||
|
return self
|
||||||
|
|
||||||
|
def __next__(self) -> Node | PathMatcher:
|
||||||
|
parent = self.node.parent
|
||||||
|
if parent is None:
|
||||||
|
raise StopIteration()
|
||||||
|
else:
|
||||||
|
self.node = parent
|
||||||
|
return parent
|
91
core/src/bugis/core/_types/__init__.py
Normal file
91
core/src/bugis/core/_types/__init__.py
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
from typing import (
|
||||||
|
TypedDict,
|
||||||
|
Literal,
|
||||||
|
Iterable,
|
||||||
|
Tuple,
|
||||||
|
Optional,
|
||||||
|
NotRequired,
|
||||||
|
Dict,
|
||||||
|
Any,
|
||||||
|
Union,
|
||||||
|
Mapping,
|
||||||
|
Sequence
|
||||||
|
)
|
||||||
|
|
||||||
|
from .base import StrOrStrings, PathMatcherResult
|
||||||
|
|
||||||
|
from bugis.core._http_method import HttpMethod
|
||||||
|
|
||||||
|
type NodeType = (str | HttpMethod)
|
||||||
|
|
||||||
|
|
||||||
|
class ASGIVersions(TypedDict):
|
||||||
|
spec_version: str
|
||||||
|
version: Union[Literal["2.0"], Literal["3.0"]]
|
||||||
|
|
||||||
|
|
||||||
|
class HTTPScope(TypedDict):
|
||||||
|
type: Literal["http"]
|
||||||
|
asgi: ASGIVersions
|
||||||
|
http_version: str
|
||||||
|
method: str
|
||||||
|
scheme: str
|
||||||
|
path: str
|
||||||
|
raw_path: bytes
|
||||||
|
query_string: bytes
|
||||||
|
root_path: str
|
||||||
|
headers: Iterable[Tuple[bytes, bytes]]
|
||||||
|
client: Optional[Tuple[str, int]]
|
||||||
|
server: Optional[Tuple[str, Optional[int]]]
|
||||||
|
state: NotRequired[Dict[str, Any]]
|
||||||
|
extensions: Optional[Dict[str, Dict[object, object]]]
|
||||||
|
|
||||||
|
|
||||||
|
class WebSocketScope(TypedDict):
|
||||||
|
type: Literal["websocket"]
|
||||||
|
asgi: ASGIVersions
|
||||||
|
http_version: str
|
||||||
|
scheme: str
|
||||||
|
path: str
|
||||||
|
raw_path: bytes
|
||||||
|
query_string: bytes
|
||||||
|
root_path: str
|
||||||
|
headers: Iterable[Tuple[bytes, bytes]]
|
||||||
|
client: Optional[Tuple[str, int]]
|
||||||
|
server: Optional[Tuple[str, Optional[int]]]
|
||||||
|
subprotocols: Iterable[str]
|
||||||
|
state: NotRequired[Dict[str, Any]]
|
||||||
|
extensions: Optional[Dict[str, Dict[object, object]]]
|
||||||
|
|
||||||
|
|
||||||
|
class LifespanScope(TypedDict):
|
||||||
|
type: Literal["lifespan"]
|
||||||
|
asgi: ASGIVersions
|
||||||
|
state: NotRequired[Dict[str, Any]]
|
||||||
|
|
||||||
|
|
||||||
|
class RSGI:
|
||||||
|
class Scope(TypedDict):
|
||||||
|
proto: Literal['http'] # = 'http'
|
||||||
|
rsgi_version: str
|
||||||
|
http_version: str
|
||||||
|
server: str
|
||||||
|
client: str
|
||||||
|
scheme: str
|
||||||
|
method: str
|
||||||
|
path: str
|
||||||
|
query_string: str
|
||||||
|
headers: Mapping[str, str]
|
||||||
|
authority: Optional[str]
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
'HttpMethod',
|
||||||
|
'HTTPScope',
|
||||||
|
'LifespanScope',
|
||||||
|
'RSGI',
|
||||||
|
'ASGIVersions',
|
||||||
|
'WebSocketScope',
|
||||||
|
'NodeType',
|
||||||
|
'StrOrStrings'
|
||||||
|
]
|
57
core/src/bugis/core/_types/asgi.py
Normal file
57
core/src/bugis/core/_types/asgi.py
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
from typing import (
|
||||||
|
Sequence,
|
||||||
|
TypedDict,
|
||||||
|
Literal,
|
||||||
|
Iterable,
|
||||||
|
Tuple,
|
||||||
|
Optional,
|
||||||
|
NotRequired,
|
||||||
|
Dict,
|
||||||
|
Any,
|
||||||
|
Union
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class ASGIVersions(TypedDict):
|
||||||
|
spec_version: str
|
||||||
|
version: Union[Literal["2.0"], Literal["3.0"]]
|
||||||
|
|
||||||
|
|
||||||
|
class HTTPScope(TypedDict):
|
||||||
|
type: Literal["http"]
|
||||||
|
asgi: ASGIVersions
|
||||||
|
http_version: str
|
||||||
|
method: str
|
||||||
|
scheme: str
|
||||||
|
path: str
|
||||||
|
raw_path: bytes
|
||||||
|
query_string: bytes
|
||||||
|
root_path: str
|
||||||
|
headers: Iterable[Tuple[bytes, bytes]]
|
||||||
|
client: Optional[Tuple[str, int]]
|
||||||
|
server: Optional[Tuple[str, Optional[int]]]
|
||||||
|
state: NotRequired[Dict[str, Any]]
|
||||||
|
extensions: Optional[Dict[str, Dict[object, object]]]
|
||||||
|
|
||||||
|
|
||||||
|
class WebSocketScope(TypedDict):
|
||||||
|
type: Literal["websocket"]
|
||||||
|
asgi: ASGIVersions
|
||||||
|
http_version: str
|
||||||
|
scheme: str
|
||||||
|
path: str
|
||||||
|
raw_path: bytes
|
||||||
|
query_string: bytes
|
||||||
|
root_path: str
|
||||||
|
headers: Iterable[Tuple[bytes, bytes]]
|
||||||
|
client: Optional[Tuple[str, int]]
|
||||||
|
server: Optional[Tuple[str, Optional[int]]]
|
||||||
|
subprotocols: Iterable[str]
|
||||||
|
state: NotRequired[Dict[str, Any]]
|
||||||
|
extensions: Optional[Dict[str, Dict[object, object]]]
|
||||||
|
|
||||||
|
|
||||||
|
class LifespanScope(TypedDict):
|
||||||
|
type: Literal["lifespan"]
|
||||||
|
asgi: ASGIVersions
|
||||||
|
state: NotRequired[Dict[str, Any]]
|
4
core/src/bugis/core/_types/base.py
Normal file
4
core/src/bugis/core/_types/base.py
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
from typing import Sequence, Mapping, Any
|
||||||
|
|
||||||
|
type StrOrStrings = (str | Sequence[str])
|
||||||
|
type PathMatcherResult = Mapping[str, Any] | Sequence[str]
|
26
core/src/bugis/core/_types/rsgi.py
Normal file
26
core/src/bugis/core/_types/rsgi.py
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
from typing import (
|
||||||
|
Sequence,
|
||||||
|
TypedDict,
|
||||||
|
Literal,
|
||||||
|
Iterable,
|
||||||
|
Tuple,
|
||||||
|
Optional,
|
||||||
|
NotRequired,
|
||||||
|
Dict,
|
||||||
|
Any,
|
||||||
|
Union,
|
||||||
|
Mapping,
|
||||||
|
)
|
||||||
|
|
||||||
|
class HTTPScope(TypedDict):
|
||||||
|
proto: Literal['http']
|
||||||
|
rsgi_version: str
|
||||||
|
http_version: str
|
||||||
|
server: str
|
||||||
|
client: str
|
||||||
|
scheme: str
|
||||||
|
method: str
|
||||||
|
path: str
|
||||||
|
query_string: str
|
||||||
|
headers: Mapping[str, str]
|
||||||
|
authority: Optional[str]
|
127
core/tests/test_asgi.py
Normal file
127
core/tests/test_asgi.py
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
import unittest
|
||||||
|
import json
|
||||||
|
import httpx
|
||||||
|
from pwo import async_test
|
||||||
|
from bugis.core import BugisApp, HttpContext, HttpMethod
|
||||||
|
from typing import Sequence
|
||||||
|
|
||||||
|
|
||||||
|
class AsgiTest(unittest.TestCase):
|
||||||
|
app: BugisApp
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.app = BugisApp()
|
||||||
|
|
||||||
|
@self.app.GET('/hello')
|
||||||
|
@self.app.GET('/hello2')
|
||||||
|
@self.app.route('/hello3')
|
||||||
|
async def handle_request(ctx: HttpContext) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, 'Hello World!')
|
||||||
|
|
||||||
|
@self.app.route(('/foo/bar',), HttpMethod.PUT, recursive=True)
|
||||||
|
async def handle_request(ctx: HttpContext) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, ctx.path)
|
||||||
|
|
||||||
|
@self.app.route(('/foo/*',), HttpMethod.PUT, recursive=True)
|
||||||
|
async def handle_request(ctx: HttpContext, path: Sequence[str]) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, json.dumps(path))
|
||||||
|
|
||||||
|
@self.app.GET('/employee/${employee_id}')
|
||||||
|
async def handle_request(ctx: HttpContext, employee_id: str) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, employee_id)
|
||||||
|
|
||||||
|
@self.app.GET('/square/${x:int}')
|
||||||
|
async def handle_request(ctx: HttpContext, x: int) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, str(x * x))
|
||||||
|
|
||||||
|
@self.app.GET('/department/${department_id:int}/employee/${employee_id:int}')
|
||||||
|
async def handle_request(ctx: HttpContext, department_id: int, employee_id: int) -> None:
|
||||||
|
async for chunk in ctx.request_body:
|
||||||
|
print(chunk)
|
||||||
|
await ctx.send_str(200, json.dumps({
|
||||||
|
'department_id': department_id,
|
||||||
|
'employee_id': employee_id
|
||||||
|
}))
|
||||||
|
|
||||||
|
@async_test
|
||||||
|
async def test_hello(self):
|
||||||
|
transport = httpx.ASGITransport(app=self.app)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(transport=transport, base_url="http://127.0.0.1:80") as client:
|
||||||
|
r = await client.get("/hello")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
self.assertEqual(r.text, "Hello World!")
|
||||||
|
|
||||||
|
r = await client.get("/hello2")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
self.assertEqual(r.text, "Hello World!")
|
||||||
|
|
||||||
|
r = await client.post("/hello3")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
self.assertEqual(r.text, "Hello World!")
|
||||||
|
|
||||||
|
r = await client.get("/hello4")
|
||||||
|
self.assertEqual(r.status_code, 404)
|
||||||
|
self.assertTrue(len(r.text) == 0)
|
||||||
|
|
||||||
|
@async_test
|
||||||
|
async def test_foo(self):
|
||||||
|
transport = httpx.ASGITransport(app=self.app)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(transport=transport, base_url="http://127.0.0.1:80") as client:
|
||||||
|
r = await client.put("/foo/fizz/baz")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
response = json.loads(r.text)
|
||||||
|
self.assertEqual(['fizz', 'baz'], response)
|
||||||
|
|
||||||
|
@async_test
|
||||||
|
async def test_foo_bar(self):
|
||||||
|
transport = httpx.ASGITransport(app=self.app)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(transport=transport, base_url="http://127.0.0.1:80") as client:
|
||||||
|
r = await client.put("/foo/bar/baz")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
self.assertEqual('/foo/bar/baz', r.text)
|
||||||
|
|
||||||
|
@async_test
|
||||||
|
async def test_employee(self):
|
||||||
|
transport = httpx.ASGITransport(app=self.app)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(transport=transport, base_url="http://127.0.0.1:80") as client:
|
||||||
|
r = await client.get("/employee/101325")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
self.assertEqual(r.text, '101325')
|
||||||
|
|
||||||
|
@async_test
|
||||||
|
async def test_square(self):
|
||||||
|
transport = httpx.ASGITransport(app=self.app)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(transport=transport, base_url="http://127.0.0.1:80") as client:
|
||||||
|
x = 30
|
||||||
|
r = await client.get(f"/square/{x}")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
self.assertEqual(r.text, str(x * x))
|
||||||
|
|
||||||
|
@async_test
|
||||||
|
async def test_department_employee(self):
|
||||||
|
transport = httpx.ASGITransport(app=self.app)
|
||||||
|
|
||||||
|
async with httpx.AsyncClient(transport=transport, base_url="http://127.0.0.1:80") as client:
|
||||||
|
r = await client.get("department/189350/employee/101325")
|
||||||
|
self.assertEqual(r.status_code, 200)
|
||||||
|
response = json.loads(r.text)
|
||||||
|
self.assertEqual({
|
||||||
|
'department_id': 189350,
|
||||||
|
'employee_id': 101325
|
||||||
|
}, response)
|
||||||
|
|
38
core/tests/test_ciao.py
Normal file
38
core/tests/test_ciao.py
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
import unittest
|
||||||
|
|
||||||
|
|
||||||
|
# Define some test cases
|
||||||
|
class TestAddition(unittest.TestCase):
|
||||||
|
def test_add_positive(self):
|
||||||
|
self.assertEqual(1 + 2, 3)
|
||||||
|
|
||||||
|
def test_add_negative(self):
|
||||||
|
self.assertEqual(-1 + (-1), -2)
|
||||||
|
|
||||||
|
|
||||||
|
class TestSubtraction(unittest.TestCase):
|
||||||
|
def test_subtract_positive(self):
|
||||||
|
self.assertEqual(5 - 3, 2)
|
||||||
|
|
||||||
|
def test_subtract_negative(self):
|
||||||
|
self.assertEqual(-5 - (-2), -3)
|
||||||
|
|
||||||
|
|
||||||
|
# Now let's create a TestSuite
|
||||||
|
def suite():
|
||||||
|
suite = unittest.TestSuite()
|
||||||
|
|
||||||
|
# Add tests to the suite
|
||||||
|
suite.addTest(TestAddition('test_add_positive'))
|
||||||
|
suite.addTest(TestAddition('test_add_negative'))
|
||||||
|
suite.addTest(TestSubtraction('test_subtract_positive'))
|
||||||
|
# suite.addTest(TestSubtraction('test_subtract_negative'))
|
||||||
|
# suite.addTest(TestSubtraction('test_subtract_negative2'))
|
||||||
|
|
||||||
|
return suite
|
||||||
|
|
||||||
|
|
||||||
|
# Running the suite
|
||||||
|
if __name__ == "__main__":
|
||||||
|
runner = unittest.TextTestRunner()
|
||||||
|
runner.run(suite())
|
83
core/tests/test_tree.py
Normal file
83
core/tests/test_tree.py
Normal file
@@ -0,0 +1,83 @@
|
|||||||
|
from typing import Sequence, Tuple, Optional, List
|
||||||
|
|
||||||
|
from bugis.core import Tree, PathHandler, HttpContext, HttpMethod, PathIterator
|
||||||
|
from bugis.core import HttpMethod
|
||||||
|
from pwo import Maybe
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
|
||||||
|
class PathIteratorTest(unittest.TestCase):
|
||||||
|
cases: Tuple[Tuple[str, Tuple[str, ...]], ...] = (
|
||||||
|
('/', tuple()),
|
||||||
|
('root/foo', ('root', 'foo')),
|
||||||
|
('/root', ('root',)),
|
||||||
|
('/root', ('root',)),
|
||||||
|
('/root/', ('root',)),
|
||||||
|
('/root/bar/', ('root', 'bar')),
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_path_iterator(self):
|
||||||
|
for (case, expected) in self.cases:
|
||||||
|
with self.subTest(case) as _:
|
||||||
|
components = tuple((c for c in PathIterator(case)))
|
||||||
|
self.assertEqual(expected, components)
|
||||||
|
|
||||||
|
|
||||||
|
class TreeTest(unittest.TestCase):
|
||||||
|
tree: Tree
|
||||||
|
handlers: List[PathHandler]
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.tree = Tree()
|
||||||
|
|
||||||
|
class TestHandler(PathHandler):
|
||||||
|
|
||||||
|
def handle_request(self, ctx: HttpContext):
|
||||||
|
pass
|
||||||
|
|
||||||
|
@property
|
||||||
|
def recursive(self) -> bool:
|
||||||
|
return True
|
||||||
|
|
||||||
|
self.handlers = [TestHandler() for _ in range(20)]
|
||||||
|
|
||||||
|
routes: Tuple[Tuple[Tuple[str, ...], Optional[HttpMethod], PathHandler], ...] = (
|
||||||
|
(('home', 'something'), HttpMethod.GET, self.handlers[0]),
|
||||||
|
(('home', 'something_else'), HttpMethod.GET, self.handlers[1]),
|
||||||
|
(('home', 'something_else'), HttpMethod.POST, self.handlers[2]),
|
||||||
|
(('home', 'something', 'object'), HttpMethod.GET, self.handlers[3]),
|
||||||
|
(('home', 'something_else', 'foo'), HttpMethod.GET, self.handlers[4]),
|
||||||
|
(('home',), HttpMethod.GET, self.handlers[5]),
|
||||||
|
(('home',), HttpMethod.POST, self.handlers[6]),
|
||||||
|
(('home',), None, self.handlers[7]),
|
||||||
|
(('home', '*.md'), None, self.handlers[8]),
|
||||||
|
(('home', 'something', '*', 'blah', '*.md'), None, self.handlers[9]),
|
||||||
|
(('home', 'bar', '*'), None, self.handlers[10]),
|
||||||
|
|
||||||
|
)
|
||||||
|
|
||||||
|
for path, method, handler in routes:
|
||||||
|
self.tree.add((p for p in path), method, handler)
|
||||||
|
|
||||||
|
def test_tree(self):
|
||||||
|
|
||||||
|
cases: Tuple[Tuple[str, HttpMethod, Optional[int]], ...] = (
|
||||||
|
('http://localhost:127.0.0.1:5432/home/something', HttpMethod.GET, 0),
|
||||||
|
('http://localhost:127.0.0.1:5432/home/something_else', HttpMethod.GET, 1),
|
||||||
|
('http://localhost:127.0.0.1:5432/home/something_else', HttpMethod.POST, 2),
|
||||||
|
('http://localhost:127.0.0.1:5432/home/something/object', HttpMethod.GET, 3),
|
||||||
|
('http://localhost:127.0.0.1:5432/home/something_else/foo', HttpMethod.GET, 4),
|
||||||
|
('http://localhost:127.0.0.1:5432/', HttpMethod.GET, None),
|
||||||
|
('http://localhost:127.0.0.1:5432/home', HttpMethod.GET, 5),
|
||||||
|
('http://localhost:127.0.0.1:5432/home', HttpMethod.POST, 6),
|
||||||
|
('http://localhost:127.0.0.1:5432/home', HttpMethod.PUT, 7),
|
||||||
|
('http://localhost:127.0.0.1:5432/home/README.md', HttpMethod.GET, 8),
|
||||||
|
('http://localhost:127.0.0.1:5432/home/something/ciao/blah/README.md', HttpMethod.GET, 9),
|
||||||
|
('http://localhost:127.0.0.1:5432/home/bar/ciao/blah/README.md', HttpMethod.GET, 10),
|
||||||
|
)
|
||||||
|
for url, method, handler_num in cases:
|
||||||
|
with self.subTest(f"{str(method)} {url}"):
|
||||||
|
res = self.tree.get_handler(url, method)
|
||||||
|
self.assertIs(Maybe.of(handler_num).map(self.handlers.__getitem__).or_none(),
|
||||||
|
Maybe.of_nullable(res).map(lambda it: it[0]).or_none())
|
||||||
|
|
46
docker-compose.yaml
Normal file
46
docker-compose.yaml
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
networks:
|
||||||
|
default:
|
||||||
|
external: false
|
||||||
|
ipam:
|
||||||
|
driver: default
|
||||||
|
config:
|
||||||
|
- subnet: 172.128.0.0/16
|
||||||
|
ip_range: 172.128.0.0/16
|
||||||
|
gateway: 172.128.0.254
|
||||||
|
|
||||||
|
services:
|
||||||
|
granian:
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
user: $UID:$GID
|
||||||
|
restart: unless-stopped
|
||||||
|
# container_name: granian
|
||||||
|
environment:
|
||||||
|
PLANT_UML_SERVER_ADDRESS: http://plant_uml:8080
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
cpus: "0.5"
|
||||||
|
memory: 512M
|
||||||
|
volumes:
|
||||||
|
- ${STATIC_ROOT}:/srv/http
|
||||||
|
plant_uml:
|
||||||
|
image: plantuml/plantuml-server:jetty
|
||||||
|
# container_name: plantUML
|
||||||
|
restart: unless-stopped
|
||||||
|
tmpfs: /tmp/jetty
|
||||||
|
deploy:
|
||||||
|
resources:
|
||||||
|
limits:
|
||||||
|
cpus: "4"
|
||||||
|
memory: 1G
|
||||||
|
nginx:
|
||||||
|
image: gitea.woggioni.net/woggioni/nginx:v1.27.2
|
||||||
|
# container_name: nginx
|
||||||
|
restart: unless-stopped
|
||||||
|
depends_on:
|
||||||
|
- granian
|
||||||
|
volumes:
|
||||||
|
- ./conf/nginx-bugis.conf:/etc/nginx/conf.d/bugis.conf:ro
|
||||||
|
ports:
|
||||||
|
- 127.0.0.1:80:8080
|
@@ -1,20 +0,0 @@
|
|||||||
FROM alpine:latest
|
|
||||||
MAINTAINER Oggioni Walter <oggioni.walter@gmail.com>
|
|
||||||
RUN apk update
|
|
||||||
RUN apk add python3 py3-pip uwsgi uwsgi-python3 graphviz uwsgi-gevent3
|
|
||||||
RUN mkdir /srv/http
|
|
||||||
RUN mkdir /var/md2html
|
|
||||||
WORKDIR /var/md2html
|
|
||||||
RUN python -m venv venv
|
|
||||||
ADD uwsgi.ini /var/md2html
|
|
||||||
ADD md2html-*.whl /
|
|
||||||
RUN venv/bin/pip install /md2html-*.whl && rm /md2html-*.whl
|
|
||||||
VOLUME /srv/http
|
|
||||||
WORKDIR /srv/http
|
|
||||||
ENTRYPOINT ["uwsgi"]
|
|
||||||
EXPOSE 1910/tcp
|
|
||||||
EXPOSE 1910/udp
|
|
||||||
USER nobody
|
|
||||||
CMD [ "--ini", "/var/md2html/uwsgi.ini" ]
|
|
||||||
|
|
||||||
|
|
@@ -1,8 +0,0 @@
|
|||||||
[uwsgi]
|
|
||||||
#logformat = "%(proto) - %(method) %(uri) %(status) %(addr)
|
|
||||||
need-plugin=/usr/lib/uwsgi/python_plugin.so
|
|
||||||
need-plugin=/usr/lib/uwsgi/gevent3_plugin.so
|
|
||||||
socket = :1910
|
|
||||||
module = md2html.uwsgi_handler
|
|
||||||
virtualenv = /var/md2html/venv
|
|
||||||
gevent = 1000
|
|
@@ -1,10 +1,10 @@
|
|||||||
[build-system]
|
[build-system]
|
||||||
requires = ["setuptools>=61.0"]
|
requires = ["setuptools>=61.0", "setuptools-scm>=8"]
|
||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "md2html"
|
name = "bugis"
|
||||||
version = "0.3"
|
dynamic = ["version"]
|
||||||
authors = [
|
authors = [
|
||||||
{ name="Walter Oggioni", email="oggioni.walter@gmail.com" },
|
{ name="Walter Oggioni", email="oggioni.walter@gmail.com" },
|
||||||
]
|
]
|
||||||
@@ -22,28 +22,44 @@ classifiers = [
|
|||||||
'Programming Language :: Python :: 3',
|
'Programming Language :: Python :: 3',
|
||||||
]
|
]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"gevent",
|
|
||||||
"greenlet",
|
|
||||||
"Markdown",
|
"Markdown",
|
||||||
"Pygments",
|
"Pygments",
|
||||||
"watchdog",
|
"watchdog",
|
||||||
"zope.event",
|
"pwo",
|
||||||
"zope.interface"
|
"PyYAML",
|
||||||
|
"pygraphviz",
|
||||||
|
"aiofiles",
|
||||||
|
"httpx[http2]"
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"build", "granian", "mypy", "ipdb", "twine"
|
||||||
|
]
|
||||||
|
|
||||||
|
run = [
|
||||||
|
"granian"
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools.package-data]
|
[tool.setuptools.package-data]
|
||||||
md2html = ['static/*']
|
bugis = ['static/*', 'default-conf/*']
|
||||||
|
|
||||||
[project.urls]
|
[project.urls]
|
||||||
"Homepage" = "https://github.com/woggioni/md2html"
|
"Homepage" = "https://github.com/woggioni/bugis"
|
||||||
"Bug Tracker" = "https://github.com/woggioni/md2html/issues"
|
"Bug Tracker" = "https://github.com/woggioni/bugis/issues"
|
||||||
|
|
||||||
[tool.mypy]
|
[tool.mypy]
|
||||||
python_version = "3.10"
|
python_version = "3.12"
|
||||||
disallow_untyped_defs = true
|
disallow_untyped_defs = true
|
||||||
show_error_codes = true
|
show_error_codes = true
|
||||||
no_implicit_optional = true
|
no_implicit_optional = true
|
||||||
warn_return_any = true
|
warn_return_any = true
|
||||||
warn_unused_ignores = true
|
warn_unused_ignores = true
|
||||||
exclude = ["scripts", "docs", "test"]
|
exclude = ["scripts", "docs", "test"]
|
||||||
strict = true
|
strict = true
|
||||||
|
|
||||||
|
[tool.setuptools_scm]
|
||||||
|
version_file = "src/bugis/_version.py"
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
bugis = "bugis.cli:main"
|
169
requirements-dev.txt
Normal file
169
requirements-dev.txt
Normal file
@@ -0,0 +1,169 @@
|
|||||||
|
#
|
||||||
|
# This file is autogenerated by pip-compile with Python 3.12
|
||||||
|
# by the following command:
|
||||||
|
#
|
||||||
|
# pip-compile --extra=dev --output-file=requirements-dev.txt pyproject.toml
|
||||||
|
#
|
||||||
|
--index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
|
--extra-index-url https://pypi.org/simple
|
||||||
|
|
||||||
|
aiofiles==24.1.0
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
anyio==4.6.2.post1
|
||||||
|
# via httpx
|
||||||
|
asttokens==2.4.1
|
||||||
|
# via stack-data
|
||||||
|
build==1.2.2.post1
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
certifi==2024.8.30
|
||||||
|
# via
|
||||||
|
# httpcore
|
||||||
|
# httpx
|
||||||
|
# requests
|
||||||
|
cffi==1.17.1
|
||||||
|
# via cryptography
|
||||||
|
charset-normalizer==3.4.0
|
||||||
|
# via requests
|
||||||
|
click==8.1.7
|
||||||
|
# via granian
|
||||||
|
cryptography==43.0.3
|
||||||
|
# via secretstorage
|
||||||
|
decorator==5.1.1
|
||||||
|
# via
|
||||||
|
# ipdb
|
||||||
|
# ipython
|
||||||
|
docutils==0.21.2
|
||||||
|
# via readme-renderer
|
||||||
|
executing==2.1.0
|
||||||
|
# via stack-data
|
||||||
|
granian==1.6.1
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
h11==0.14.0
|
||||||
|
# via httpcore
|
||||||
|
h2==4.1.0
|
||||||
|
# via httpx
|
||||||
|
hpack==4.0.0
|
||||||
|
# via h2
|
||||||
|
httpcore==1.0.6
|
||||||
|
# via httpx
|
||||||
|
httpx[http2]==0.27.2
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
hyperframe==6.0.1
|
||||||
|
# via h2
|
||||||
|
idna==3.10
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
# requests
|
||||||
|
importlib-metadata==8.5.0
|
||||||
|
# via twine
|
||||||
|
ipdb==0.13.13
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
ipython==8.28.0
|
||||||
|
# via ipdb
|
||||||
|
jaraco-classes==3.4.0
|
||||||
|
# via keyring
|
||||||
|
jaraco-context==6.0.1
|
||||||
|
# via keyring
|
||||||
|
jaraco-functools==4.1.0
|
||||||
|
# via keyring
|
||||||
|
jedi==0.19.1
|
||||||
|
# via ipython
|
||||||
|
jeepney==0.8.0
|
||||||
|
# via
|
||||||
|
# keyring
|
||||||
|
# secretstorage
|
||||||
|
keyring==25.4.1
|
||||||
|
# via twine
|
||||||
|
markdown==3.7
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
markdown-it-py==3.0.0
|
||||||
|
# via rich
|
||||||
|
matplotlib-inline==0.1.7
|
||||||
|
# via ipython
|
||||||
|
mdurl==0.1.2
|
||||||
|
# via markdown-it-py
|
||||||
|
more-itertools==10.5.0
|
||||||
|
# via
|
||||||
|
# jaraco-classes
|
||||||
|
# jaraco-functools
|
||||||
|
mypy==1.13.0
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
mypy-extensions==1.0.0
|
||||||
|
# via mypy
|
||||||
|
nh3==0.2.18
|
||||||
|
# via readme-renderer
|
||||||
|
packaging==24.1
|
||||||
|
# via build
|
||||||
|
parso==0.8.4
|
||||||
|
# via jedi
|
||||||
|
pexpect==4.9.0
|
||||||
|
# via ipython
|
||||||
|
pkginfo==1.10.0
|
||||||
|
# via twine
|
||||||
|
prompt-toolkit==3.0.48
|
||||||
|
# via ipython
|
||||||
|
ptyprocess==0.7.0
|
||||||
|
# via pexpect
|
||||||
|
pure-eval==0.2.3
|
||||||
|
# via stack-data
|
||||||
|
pwo==0.0.4
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pycparser==2.22
|
||||||
|
# via cffi
|
||||||
|
pygments==2.18.0
|
||||||
|
# via
|
||||||
|
# bugis (pyproject.toml)
|
||||||
|
# ipython
|
||||||
|
# readme-renderer
|
||||||
|
# rich
|
||||||
|
pygraphviz==1.14
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pyproject-hooks==1.2.0
|
||||||
|
# via build
|
||||||
|
pyyaml==6.0.2
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
readme-renderer==44.0
|
||||||
|
# via twine
|
||||||
|
requests==2.32.3
|
||||||
|
# via
|
||||||
|
# requests-toolbelt
|
||||||
|
# twine
|
||||||
|
requests-toolbelt==1.0.0
|
||||||
|
# via twine
|
||||||
|
rfc3986==2.0.0
|
||||||
|
# via twine
|
||||||
|
rich==13.9.3
|
||||||
|
# via twine
|
||||||
|
secretstorage==3.3.3
|
||||||
|
# via keyring
|
||||||
|
six==1.16.0
|
||||||
|
# via asttokens
|
||||||
|
sniffio==1.3.1
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
stack-data==0.6.3
|
||||||
|
# via ipython
|
||||||
|
traitlets==5.14.3
|
||||||
|
# via
|
||||||
|
# ipython
|
||||||
|
# matplotlib-inline
|
||||||
|
twine==5.1.1
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
typing-extensions==4.12.2
|
||||||
|
# via
|
||||||
|
# mypy
|
||||||
|
# pwo
|
||||||
|
urllib3==2.2.3
|
||||||
|
# via
|
||||||
|
# requests
|
||||||
|
# twine
|
||||||
|
uvloop==0.21.0
|
||||||
|
# via granian
|
||||||
|
watchdog==5.0.3
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
wcwidth==0.2.13
|
||||||
|
# via prompt-toolkit
|
||||||
|
zipp==3.20.2
|
||||||
|
# via importlib-metadata
|
57
requirements-run.txt
Normal file
57
requirements-run.txt
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
#
|
||||||
|
# This file is autogenerated by pip-compile with Python 3.12
|
||||||
|
# by the following command:
|
||||||
|
#
|
||||||
|
# pip-compile --extra=run --output-file=requirements-run.txt pyproject.toml
|
||||||
|
#
|
||||||
|
--index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
|
--extra-index-url https://pypi.org/simple
|
||||||
|
|
||||||
|
aiofiles==24.1.0
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
anyio==4.6.2.post1
|
||||||
|
# via httpx
|
||||||
|
certifi==2024.8.30
|
||||||
|
# via
|
||||||
|
# httpcore
|
||||||
|
# httpx
|
||||||
|
click==8.1.7
|
||||||
|
# via granian
|
||||||
|
granian==1.6.1
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
h11==0.14.0
|
||||||
|
# via httpcore
|
||||||
|
h2==4.1.0
|
||||||
|
# via httpx
|
||||||
|
hpack==4.0.0
|
||||||
|
# via h2
|
||||||
|
httpcore==1.0.6
|
||||||
|
# via httpx
|
||||||
|
httpx[http2]==0.27.2
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
hyperframe==6.0.1
|
||||||
|
# via h2
|
||||||
|
idna==3.10
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
markdown==3.7
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pwo==0.0.4
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pygments==2.18.0
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pygraphviz==1.14
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pyyaml==6.0.2
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
sniffio==1.3.1
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
typing-extensions==4.12.2
|
||||||
|
# via pwo
|
||||||
|
uvloop==0.21.0
|
||||||
|
# via granian
|
||||||
|
watchdog==5.0.3
|
||||||
|
# via bugis (pyproject.toml)
|
@@ -1,10 +1,51 @@
|
|||||||
build==1.0.3
|
#
|
||||||
gevent==23.9.1
|
# This file is autogenerated by pip-compile with Python 3.12
|
||||||
greenlet==3.0.0
|
# by the following command:
|
||||||
Markdown==3.5
|
#
|
||||||
packaging==23.2
|
# pip-compile --output-file=requirements.txt pyproject.toml
|
||||||
Pygments==2.16.1
|
#
|
||||||
pyproject_hooks==1.0.0
|
--index-url https://gitea.woggioni.net/api/packages/woggioni/pypi/simple
|
||||||
watchdog==3.0.0
|
--extra-index-url https://pypi.org/simple
|
||||||
zope.event==5.0
|
|
||||||
zope.interface==6.1
|
aiofiles==24.1.0
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
anyio==4.6.2.post1
|
||||||
|
# via httpx
|
||||||
|
certifi==2024.8.30
|
||||||
|
# via
|
||||||
|
# httpcore
|
||||||
|
# httpx
|
||||||
|
h11==0.14.0
|
||||||
|
# via httpcore
|
||||||
|
h2==4.1.0
|
||||||
|
# via httpx
|
||||||
|
hpack==4.0.0
|
||||||
|
# via h2
|
||||||
|
httpcore==1.0.6
|
||||||
|
# via httpx
|
||||||
|
httpx[http2]==0.27.2
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
hyperframe==6.0.1
|
||||||
|
# via h2
|
||||||
|
idna==3.10
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
markdown==3.7
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pwo==0.0.4
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pygments==2.18.0
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pygraphviz==1.14
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
pyyaml==6.0.2
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
sniffio==1.3.1
|
||||||
|
# via
|
||||||
|
# anyio
|
||||||
|
# httpx
|
||||||
|
typing-extensions==4.12.2
|
||||||
|
# via pwo
|
||||||
|
watchdog==5.0.3
|
||||||
|
# via bugis (pyproject.toml)
|
||||||
|
12
server/example/test_server.py
Normal file
12
server/example/test_server.py
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
|
||||||
|
from bugis.core import BugisApp
|
||||||
|
from pathlib import PurePath
|
||||||
|
from bugis.server.server import static_resources
|
||||||
|
import os
|
||||||
|
|
||||||
|
root = os.getenv('STATIC_ROOT') or '.'
|
||||||
|
app = BugisApp()
|
||||||
|
|
||||||
|
static_resources(app, '/view', root)
|
||||||
|
|
||||||
|
|
67
server/pyproject.toml
Normal file
67
server/pyproject.toml
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
[build-system]
|
||||||
|
requires = ["setuptools>=61.0", "setuptools-scm>=8"]
|
||||||
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
|
[project]
|
||||||
|
name = "bugis_server"
|
||||||
|
dynamic = ["version"]
|
||||||
|
authors = [
|
||||||
|
{ name="Walter Oggioni", email="oggioni.walter@gmail.com" },
|
||||||
|
]
|
||||||
|
description = "Static file renderer"
|
||||||
|
readme = "README.md"
|
||||||
|
requires-python = ">=3.10"
|
||||||
|
classifiers = [
|
||||||
|
'Development Status :: 3 - Alpha',
|
||||||
|
'Topic :: Utilities',
|
||||||
|
'License :: OSI Approved :: MIT License',
|
||||||
|
'Intended Audience :: System Administrators',
|
||||||
|
'Intended Audience :: Developers',
|
||||||
|
'Environment :: Console',
|
||||||
|
'License :: OSI Approved :: MIT License',
|
||||||
|
'Programming Language :: Python :: 3',
|
||||||
|
]
|
||||||
|
dependencies = [
|
||||||
|
"bugis_core",
|
||||||
|
"Markdown",
|
||||||
|
"Pygments",
|
||||||
|
"watchdog",
|
||||||
|
"pwo",
|
||||||
|
"PyYAML",
|
||||||
|
"pygraphviz",
|
||||||
|
"aiofiles",
|
||||||
|
"httpx[http2]"
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"build", "granian", "mypy", "ipdb", "twine"
|
||||||
|
]
|
||||||
|
|
||||||
|
run = [
|
||||||
|
"granian"
|
||||||
|
]
|
||||||
|
|
||||||
|
[tool.setuptools.package-data]
|
||||||
|
bugis = ['static/*', 'default-conf/*']
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
"Homepage" = "https://github.com/woggioni/bugis"
|
||||||
|
"Bug Tracker" = "https://github.com/woggioni/bugis/issues"
|
||||||
|
|
||||||
|
[tool.mypy]
|
||||||
|
python_version = "3.12"
|
||||||
|
disallow_untyped_defs = true
|
||||||
|
show_error_codes = true
|
||||||
|
no_implicit_optional = true
|
||||||
|
warn_return_any = true
|
||||||
|
warn_unused_ignores = true
|
||||||
|
exclude = ["scripts", "docs", "test"]
|
||||||
|
strict = true
|
||||||
|
|
||||||
|
[tool.setuptools_scm]
|
||||||
|
root='..'
|
||||||
|
version_file = "src/bugis/server/_version.py"
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
bugis = "bugis.server.cli:main"
|
0
server/src/bugis/server/__init__.py
Normal file
0
server/src/bugis/server/__init__.py
Normal file
44
server/src/bugis/server/cache.py
Normal file
44
server/src/bugis/server/cache.py
Normal file
@@ -0,0 +1,44 @@
|
|||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from typing import Optional, Tuple, Callable
|
||||||
|
from functools import lru_cache
|
||||||
|
from pathlib import PurePath
|
||||||
|
from .renderer import RenderingManager
|
||||||
|
|
||||||
|
|
||||||
|
class Cache(ABC):
|
||||||
|
_rendering_manager: RenderingManager
|
||||||
|
|
||||||
|
def __init__(self, rendering_manager: RenderingManager):
|
||||||
|
self._rendering_manager = rendering_manager
|
||||||
|
|
||||||
|
def get(self, key: bytes, file: PurePath) -> Optional[Tuple[str, bytes]]:
|
||||||
|
if self.filter(file):
|
||||||
|
return self.load(key, file)
|
||||||
|
else:
|
||||||
|
return self._rendering_manager.render(file)
|
||||||
|
|
||||||
|
def filter(self, file: PurePath) -> bool:
|
||||||
|
return file.suffix.lower() in {'md', 'puml', 'dot', 'texi', 'texinfo', 'txi'}
|
||||||
|
|
||||||
|
def load(self, key: bytes, file: PurePath) -> Optional[Tuple[str, bytes]]:
|
||||||
|
return self._rendering_manager.render(file)
|
||||||
|
|
||||||
|
|
||||||
|
class NoCache(Cache):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class InMemoryCache(Cache):
|
||||||
|
_cached_loader: Callable[[bytes, PurePath], Tuple[str, bytes]]
|
||||||
|
|
||||||
|
def __init__(self, rendering_manager: RenderingManager, max_size: int = 1024):
|
||||||
|
super().__init__(rendering_manager)
|
||||||
|
|
||||||
|
@lru_cache(maxsize=max_size)
|
||||||
|
def cached_loader(key: bytes, file: PurePath) -> Tuple[str, bytes]:
|
||||||
|
return super().load(key, file)
|
||||||
|
|
||||||
|
self._cached_loader = cached_loader
|
||||||
|
|
||||||
|
def load(self, key: bytes, file: PurePath) -> Optional[Tuple[str, bytes]]:
|
||||||
|
return self._cached_loader(key, file)
|
3
server/src/bugis/server/cli.py
Normal file
3
server/src/bugis/server/cli.py
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
|
||||||
|
def main():
|
||||||
|
pass
|
16
server/src/bugis/server/renderer.py
Normal file
16
server/src/bugis/server/renderer.py
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
from pathlib import PurePath
|
||||||
|
from typing import Callable, Mapping, Optional, Tuple
|
||||||
|
from pwo import Maybe
|
||||||
|
|
||||||
|
|
||||||
|
class RenderingManager:
|
||||||
|
_renderers: Mapping[str, Callable[[PurePath], Tuple[str, bytes]]]
|
||||||
|
|
||||||
|
def __init__(self, renderers: Mapping[str, Callable[[PurePath], Tuple[str, bytes]]]):
|
||||||
|
self._renderers = renderers
|
||||||
|
|
||||||
|
def render(self, file: PurePath) -> Optional[Tuple[str, bytes]]:
|
||||||
|
return Maybe.of_nullable(self._renderers.get(file.suffix.lower())).map(lambda it: it(file)).or_none()
|
||||||
|
|
||||||
|
# def register(self, suffix: str, renderer: Callable[[PurePath], Tuple[str, bytes]]) -> None:
|
||||||
|
# self._renderers[suffix.lower()] = renderer
|
145
server/src/bugis/server/server.py
Normal file
145
server/src/bugis/server/server.py
Normal file
@@ -0,0 +1,145 @@
|
|||||||
|
from base64 import b64encode, b64decode
|
||||||
|
from hashlib import md5
|
||||||
|
from mimetypes import guess_type
|
||||||
|
from pathlib import Path, PurePath
|
||||||
|
from typing import TYPE_CHECKING, Optional, Callable, Awaitable, AsyncGenerator, Any, Unpack, Mapping, Tuple
|
||||||
|
|
||||||
|
from aiofiles.os import listdir
|
||||||
|
from aiofiles.ospath import isdir, isfile
|
||||||
|
from bugis.core import HttpContext, BugisApp
|
||||||
|
from pwo import Maybe
|
||||||
|
from .cache import Cache, InMemoryCache
|
||||||
|
from .renderer import RenderingManager
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from _typeshed import StrOrBytesPath
|
||||||
|
|
||||||
|
|
||||||
|
def parse_etag(etag: str) -> Optional[str]:
|
||||||
|
def skip_weak_marker(s):
|
||||||
|
if s.startswith('W/'):
|
||||||
|
return s[2:]
|
||||||
|
else:
|
||||||
|
return s
|
||||||
|
|
||||||
|
return (
|
||||||
|
Maybe.of_nullable(etag)
|
||||||
|
.map(skip_weak_marker)
|
||||||
|
.or_else(None)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def static_resources(app: BugisApp,
|
||||||
|
path: str,
|
||||||
|
root: 'StrOrBytesPath',
|
||||||
|
favicon: PurePath = None,
|
||||||
|
file_filter: Callable[[PurePath], Awaitable[bool]] = None,
|
||||||
|
renderers: Mapping[str, Tuple[str, bytes]] = None,
|
||||||
|
cache_ctor: Callable[[RenderingManager], Cache] = lambda rm: InMemoryCache(rm)
|
||||||
|
):
|
||||||
|
renderer = RenderingManager(renderers or {})
|
||||||
|
cache = cache_ctor(renderer)
|
||||||
|
|
||||||
|
async def no_filter(_: PurePath):
|
||||||
|
return True
|
||||||
|
|
||||||
|
if file_filter is None:
|
||||||
|
file_filter = no_filter
|
||||||
|
|
||||||
|
def compute_etag(resource: Path) -> str:
|
||||||
|
md = md5()
|
||||||
|
print(resource)
|
||||||
|
with resource.open('rb') as file:
|
||||||
|
while True:
|
||||||
|
chunk = file.read(0x10000)
|
||||||
|
if len(chunk):
|
||||||
|
md.update(chunk)
|
||||||
|
else:
|
||||||
|
break
|
||||||
|
return b64encode(md.digest()).decode()
|
||||||
|
|
||||||
|
if isinstance(root, str):
|
||||||
|
folder = Path(root)
|
||||||
|
else:
|
||||||
|
folder = root
|
||||||
|
|
||||||
|
prefix = PurePath(path)
|
||||||
|
|
||||||
|
async def handler(context: HttpContext, *_: Unpack[Any]) -> None:
|
||||||
|
requested = (PurePath(context.path)).relative_to(prefix)
|
||||||
|
resource = folder / requested
|
||||||
|
if not resource.is_relative_to(folder) or not resource.exists():
|
||||||
|
return await context.send_empty(404)
|
||||||
|
|
||||||
|
if await isfile(resource):
|
||||||
|
|
||||||
|
proposed_etag = ((Maybe.of_nullable(context.headers.get('if-none-match'))
|
||||||
|
.filter(lambda it: len(it) > 0)
|
||||||
|
.map(lambda it: it[-1])
|
||||||
|
.map(parse_etag))
|
||||||
|
.or_none())
|
||||||
|
current_etag = compute_etag(resource)
|
||||||
|
|
||||||
|
if proposed_etag == current_etag:
|
||||||
|
return await context.send_empty(304)
|
||||||
|
else:
|
||||||
|
cache_result = cache.get(b64decode(current_etag), resource)
|
||||||
|
if cache_result is None:
|
||||||
|
mime_type = (Maybe.of(guess_type(resource.name))
|
||||||
|
.map(lambda it: it[0])
|
||||||
|
.or_else('application/octet-stream'))
|
||||||
|
return await context.send_file(200, resource, {
|
||||||
|
'content-type': mime_type or 'application/octet-stream',
|
||||||
|
'etag': 'W/' + current_etag,
|
||||||
|
'cache-control': 'no-cache',
|
||||||
|
})
|
||||||
|
else:
|
||||||
|
content_type, body = cache_result
|
||||||
|
await context.send_bytes(200, body, {
|
||||||
|
'content-type': content_type,
|
||||||
|
'etag': 'W/' + current_etag,
|
||||||
|
'cache-control': 'no-cache',
|
||||||
|
})
|
||||||
|
elif isdir(resource):
|
||||||
|
headers = {
|
||||||
|
'content-type': 'text/html'
|
||||||
|
}
|
||||||
|
await context.send_str(200, await directory_listing(prefix, requested, resource, favicon, file_filter),
|
||||||
|
headers)
|
||||||
|
|
||||||
|
return app.GET(path, True)(handler)
|
||||||
|
|
||||||
|
|
||||||
|
async def directory_listing(prefix: PurePath,
|
||||||
|
path_info: PurePath,
|
||||||
|
path: PurePath,
|
||||||
|
favicon: PurePath,
|
||||||
|
file_filter: Callable[[PurePath], Awaitable[bool]]) -> str:
|
||||||
|
title = "Directory listing for %s" % path_info
|
||||||
|
result = "<!DOCTYPE html><html><head>"
|
||||||
|
if favicon:
|
||||||
|
result += f'<link rel="icon" type="image/x-icon" href="{favicon}">'
|
||||||
|
result += "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">"
|
||||||
|
result += "<title>" + title + "</title></head>"
|
||||||
|
result += "<body><h1>" + title + "</h1><hr>"
|
||||||
|
result += "<ul>"
|
||||||
|
if path_info != '/':
|
||||||
|
result += "<li><a href=\"../\"/>../</li>"
|
||||||
|
|
||||||
|
async def ls(entry_filter: Callable[[PurePath], Awaitable[bool]]) -> AsyncGenerator[str, Any]:
|
||||||
|
async def result():
|
||||||
|
for entry in sorted(await listdir(path)):
|
||||||
|
if await entry_filter(path / entry):
|
||||||
|
yield entry
|
||||||
|
|
||||||
|
return result()
|
||||||
|
|
||||||
|
async for entry in await ls(isdir):
|
||||||
|
result += '<li><a href="' + entry + '/' + '"/>' + entry + '/' + '</li>'
|
||||||
|
|
||||||
|
async def composite_file_filter(entry: PurePath) -> bool:
|
||||||
|
return await isfile(entry) and await file_filter(entry)
|
||||||
|
|
||||||
|
async for entry in await ls(composite_file_filter):
|
||||||
|
result += '<li><a href="' + entry + '"/>' + entry + '</li>'
|
||||||
|
return result
|
0
src/bugis/__init__.py
Normal file
0
src/bugis/__init__.py
Normal file
4
src/bugis/__main__.py
Normal file
4
src/bugis/__main__.py
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
from .cli import main
|
||||||
|
import sys
|
||||||
|
|
||||||
|
main(sys.argv[1:])
|
42
src/bugis/asgi.py
Normal file
42
src/bugis/asgi.py
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
import logging
|
||||||
|
from asyncio import get_running_loop
|
||||||
|
from typing import Optional, Awaitable, Callable, Any, Mapping
|
||||||
|
|
||||||
|
from pwo import Maybe
|
||||||
|
|
||||||
|
from .server import Server
|
||||||
|
|
||||||
|
|
||||||
|
log = logging.getLogger('access')
|
||||||
|
log.propagate = False
|
||||||
|
|
||||||
|
_server: Optional[Server] = None
|
||||||
|
|
||||||
|
async def application(scope, receive, send : Callable[[Mapping[str, Any]], Awaitable[None]]):
|
||||||
|
global _server
|
||||||
|
if scope['type'] == 'lifespan':
|
||||||
|
while True:
|
||||||
|
message = await receive()
|
||||||
|
if message['type'] == 'lifespan.startup':
|
||||||
|
_server = Server(loop=get_running_loop(), prefix=None)
|
||||||
|
await send({'type': 'lifespan.startup.complete'})
|
||||||
|
elif message['type'] == 'lifespan.shutdown':
|
||||||
|
await _server.stop()
|
||||||
|
await send({'type': 'lifespan.shutdown.complete'})
|
||||||
|
else:
|
||||||
|
pathsend = (Maybe.of_nullable(scope.get('extensions'))
|
||||||
|
.map(lambda it: it.get("http.response.pathsend"))
|
||||||
|
.is_present)
|
||||||
|
await _server.handle_request(
|
||||||
|
scope['method'],
|
||||||
|
scope['path'],
|
||||||
|
Maybe.of([header[1] for header in scope['headers'] if header[0].decode().lower() == 'if-none-match'])
|
||||||
|
.filter(lambda it: len(it) > 0)
|
||||||
|
.map(lambda it: it[0])
|
||||||
|
.map(lambda it: it.decode())
|
||||||
|
.or_else(None),
|
||||||
|
Maybe.of_nullable(scope.get('query_string', None)).map(lambda it: it.decode()).or_else(None),
|
||||||
|
send,
|
||||||
|
pathsend
|
||||||
|
)
|
||||||
|
|
26
src/bugis/asgi_utils.py
Normal file
26
src/bugis/asgi_utils.py
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
from typing import Tuple, Dict, Sequence
|
||||||
|
|
||||||
|
type StrOrStrings = (str, Sequence[str])
|
||||||
|
|
||||||
|
def decode_headers(headers: Sequence[Tuple[bytes, bytes]]) -> Dict[str, Sequence[str]]:
|
||||||
|
result = dict()
|
||||||
|
for key, value in headers:
|
||||||
|
if isinstance(key, bytes):
|
||||||
|
key = key.decode()
|
||||||
|
if isinstance(value, bytes):
|
||||||
|
value = value.decode()
|
||||||
|
l = result.setdefault(key, list())
|
||||||
|
l.append(value)
|
||||||
|
return {
|
||||||
|
k: tuple(v) for k, v in result.items()
|
||||||
|
}
|
||||||
|
|
||||||
|
def encode_headers(headers: Dict[str, StrOrStrings]) -> Tuple[Tuple[bytes, bytes], ...]:
|
||||||
|
result = []
|
||||||
|
for key, value in headers.items():
|
||||||
|
if isinstance(value, str):
|
||||||
|
result.append((key.encode(), value.encode()))
|
||||||
|
elif isinstance(value, Sequence):
|
||||||
|
for single_value in value:
|
||||||
|
result.append((key.encode(), single_value.encode()))
|
||||||
|
return tuple(result)
|
94
src/bugis/async_watchdog.py
Normal file
94
src/bugis/async_watchdog.py
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
import asyncio
|
||||||
|
from asyncio import Queue, AbstractEventLoop, Future, Task, gather
|
||||||
|
from logging import getLogger, Logger
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from pwo import TopicManager, Subscriber
|
||||||
|
from watchdog.events import FileMovedEvent, FileClosedEvent, FileCreatedEvent, FileModifiedEvent
|
||||||
|
from watchdog.events import FileSystemEventHandler, FileSystemEvent, PatternMatchingEventHandler
|
||||||
|
from watchdog.observers import Observer
|
||||||
|
|
||||||
|
log: Logger = getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class _EventHandler(FileSystemEventHandler):
|
||||||
|
_queue: Queue
|
||||||
|
_loop: AbstractEventLoop
|
||||||
|
|
||||||
|
def __init__(self, queue: Queue, loop: AbstractEventLoop,
|
||||||
|
*args, **kwargs):
|
||||||
|
self._loop = loop
|
||||||
|
self._queue = queue
|
||||||
|
super(*args, **kwargs)
|
||||||
|
|
||||||
|
def on_created(self, event: FileSystemEvent) -> None:
|
||||||
|
self._loop.call_soon_threadsafe(self._queue.put_nowait, event)
|
||||||
|
|
||||||
|
def on_modified(self, event: FileSystemEvent) -> None:
|
||||||
|
self._loop.call_soon_threadsafe(self._queue.put_nowait, event)
|
||||||
|
|
||||||
|
|
||||||
|
observer = Observer()
|
||||||
|
|
||||||
|
|
||||||
|
def watch(path: Path, queue: Queue, loop: AbstractEventLoop,
|
||||||
|
recursive: bool = False) -> None:
|
||||||
|
"""Watch a directory for changes."""
|
||||||
|
handler = _EventHandler(queue, loop)
|
||||||
|
|
||||||
|
observer.schedule(handler, str(path), recursive=recursive)
|
||||||
|
observer.start()
|
||||||
|
observer.join()
|
||||||
|
loop.call_soon_threadsafe(queue.put_nowait, None)
|
||||||
|
|
||||||
|
|
||||||
|
class FileWatcher(PatternMatchingEventHandler):
|
||||||
|
_topic_manager: TopicManager
|
||||||
|
_loop: AbstractEventLoop
|
||||||
|
_topic_manager_loop: Task
|
||||||
|
_running_tasks: Future
|
||||||
|
|
||||||
|
def __init__(self, path):
|
||||||
|
super().__init__(patterns=['*.md'],
|
||||||
|
ignore_patterns=None,
|
||||||
|
ignore_directories=False,
|
||||||
|
case_sensitive=True)
|
||||||
|
self._observer: Observer = Observer()
|
||||||
|
self._observer.schedule(self, path=path, recursive=True)
|
||||||
|
self._loop = asyncio.get_running_loop()
|
||||||
|
self._topic_manager = TopicManager(self._loop)
|
||||||
|
self._running_tasks = gather(
|
||||||
|
self._loop.run_in_executor(None, self._observer.start),
|
||||||
|
self._loop.create_task(self._topic_manager.process_events())
|
||||||
|
)
|
||||||
|
|
||||||
|
async def stop(self) -> None:
|
||||||
|
def _observer_stop():
|
||||||
|
self._observer.stop()
|
||||||
|
self._observer.join()
|
||||||
|
self._topic_manager.post_event(None)
|
||||||
|
|
||||||
|
await self._loop.run_in_executor(None, _observer_stop)
|
||||||
|
await self._running_tasks
|
||||||
|
|
||||||
|
def subscribe(self, path: str) -> Subscriber:
|
||||||
|
return self._topic_manager.subscribe(path)
|
||||||
|
|
||||||
|
def on_any_event(self, event: FileSystemEvent) -> None:
|
||||||
|
what = "directory" if event.is_directory else "file"
|
||||||
|
|
||||||
|
def post_event(path):
|
||||||
|
self._topic_manager.post_event(path)
|
||||||
|
|
||||||
|
if isinstance(event, FileClosedEvent):
|
||||||
|
log.debug("Closed %s: %s", what, event.src_path)
|
||||||
|
# update_subscriptions()
|
||||||
|
elif isinstance(event, FileMovedEvent):
|
||||||
|
log.debug("Moved %s: %s to %s", what, event.src_path, event.dest_path)
|
||||||
|
post_event(event.dest_path)
|
||||||
|
elif isinstance(event, FileCreatedEvent):
|
||||||
|
log.debug("Created %s: %s", what, event.src_path)
|
||||||
|
post_event(event.src_path)
|
||||||
|
elif isinstance(event, FileModifiedEvent):
|
||||||
|
log.debug("Modified %s: %s", what, event.src_path)
|
||||||
|
post_event(event.src_path)
|
114
src/bugis/cli.py
Normal file
114
src/bugis/cli.py
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
import argparse
|
||||||
|
from dataclasses import asdict
|
||||||
|
from os import environ
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Optional, Sequence
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
from granian import Granian
|
||||||
|
from pwo import Maybe
|
||||||
|
|
||||||
|
from .configuration import Configuration
|
||||||
|
from granian.constants import HTTPModes, Interfaces, ThreadModes, Loops
|
||||||
|
|
||||||
|
def main(args: Optional[Sequence[str]] = None):
|
||||||
|
parser = argparse.ArgumentParser(description="A simple CLI program to render Markdown files")
|
||||||
|
default_configuration_file = (Maybe.of(environ.get('XDG_CONFIG_HOME'))
|
||||||
|
.map(lambda it: Path(it))
|
||||||
|
.map(lambda it: it / 'bugis' / 'bugis.yaml')
|
||||||
|
.or_else_get(lambda: Path(environ.get('HOME')) / '.config' / 'bugis' / 'bugis.yaml')
|
||||||
|
.filter(Path.exists)
|
||||||
|
.or_else(None)
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-c',
|
||||||
|
'--configuration',
|
||||||
|
help='Path to the configuration file',
|
||||||
|
default=default_configuration_file,
|
||||||
|
type=Path,
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-a',
|
||||||
|
'--address',
|
||||||
|
help='Server bind address',
|
||||||
|
default='127.0.0.1',
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-p',
|
||||||
|
'--port',
|
||||||
|
help='Server port',
|
||||||
|
default='8000',
|
||||||
|
type=int
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--access-log',
|
||||||
|
help='Enable access log',
|
||||||
|
action='store_true',
|
||||||
|
dest='log_access'
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--logging-configuration',
|
||||||
|
help='Logging configuration file',
|
||||||
|
dest='log_config_file'
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-w', '--workers',
|
||||||
|
help='Number of worker processes',
|
||||||
|
default='1',
|
||||||
|
dest='workers',
|
||||||
|
type = int
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'-t', '--threads',
|
||||||
|
help='Number of threads per worker',
|
||||||
|
default='1',
|
||||||
|
dest='threads',
|
||||||
|
type=int
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--http',
|
||||||
|
help='HTTP protocol version',
|
||||||
|
dest='http',
|
||||||
|
type=lambda it: HTTPModes(it),
|
||||||
|
choices=[str(mode) for mode in HTTPModes],
|
||||||
|
default = 'auto',
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--threading-mode',
|
||||||
|
help='Threading mode',
|
||||||
|
dest='threading_mode',
|
||||||
|
type=lambda it: ThreadModes(it),
|
||||||
|
choices=[str(mode) for mode in ThreadModes],
|
||||||
|
default=ThreadModes.workers
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--loop',
|
||||||
|
help='Loop',
|
||||||
|
dest='loop',
|
||||||
|
type=lambda it: Loops(it),
|
||||||
|
choices=[str(mode) for mode in Loops]
|
||||||
|
)
|
||||||
|
args = parser.parse_args(args)
|
||||||
|
def parse(configuration: Path):
|
||||||
|
with open(configuration, 'r') as f:
|
||||||
|
return yaml.safe_load(f)
|
||||||
|
|
||||||
|
def assign(it: Configuration):
|
||||||
|
Configuration.instance = it
|
||||||
|
Maybe.of_nullable(args.configuration).map(parse).if_present(assign)
|
||||||
|
conf = Configuration.instance
|
||||||
|
|
||||||
|
|
||||||
|
granian_conf = asdict(conf).setdefault('granian', dict())
|
||||||
|
for k, v in vars(args).items():
|
||||||
|
if v is not None:
|
||||||
|
granian_conf[k] = v
|
||||||
|
if args.log_config_file:
|
||||||
|
with open(args.log_config_file, 'r') as f:
|
||||||
|
granian_conf['log_dictconfig'] = yaml.safe_load(f)
|
||||||
|
granian_conf = Configuration.GranianConfiguration.from_dict(granian_conf)
|
||||||
|
|
||||||
|
Granian(
|
||||||
|
"bugis.asgi:application",
|
||||||
|
**asdict(granian_conf)
|
||||||
|
).serve()
|
144
src/bugis/configuration.py
Normal file
144
src/bugis/configuration.py
Normal file
@@ -0,0 +1,144 @@
|
|||||||
|
from os import environ
|
||||||
|
from pathlib import Path
|
||||||
|
from dataclasses import dataclass, field, asdict
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
from granian.constants import Loops, Interfaces, ThreadModes, HTTPModes, StrEnum
|
||||||
|
from granian.log import LogLevels
|
||||||
|
from granian.http import HTTP1Settings, HTTP2Settings
|
||||||
|
from typing import Optional, Sequence, Dict, Any
|
||||||
|
from pwo import classproperty, Maybe
|
||||||
|
from yaml import add_representer, SafeDumper, SafeLoader
|
||||||
|
|
||||||
|
def parse_log_config(conf_file=None) -> Dict[str, Any]:
|
||||||
|
if conf_file is None:
|
||||||
|
conf_file = environ.get("LOGGING_CONFIGURATION_FILE",
|
||||||
|
Path(__file__).parent / 'default-conf' / 'logging.yaml')
|
||||||
|
with open(conf_file, 'r') as file:
|
||||||
|
return yaml.safe_load(file)
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class Configuration:
|
||||||
|
plant_uml_server_address: str = environ.get('PLANT_UML_SERVER_ADDRESS', None)
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class GranianConfiguration:
|
||||||
|
address: str = '127.0.0.1'
|
||||||
|
port: int = 8000
|
||||||
|
interface: str = Interfaces.ASGI
|
||||||
|
workers: int = 1
|
||||||
|
threads: int = 1
|
||||||
|
blocking_threads: Optional[int] = None
|
||||||
|
threading_mode: ThreadModes = ThreadModes.workers
|
||||||
|
loop: Loops = Loops.auto
|
||||||
|
loop_opt: bool = False
|
||||||
|
http: HTTPModes = HTTPModes.auto
|
||||||
|
websockets: bool = True
|
||||||
|
backlog: int = 1024
|
||||||
|
backpressure: Optional[int] = None
|
||||||
|
http1_settings: Optional[HTTP1Settings] = None
|
||||||
|
http2_settings: Optional[HTTP2Settings] = None
|
||||||
|
log_enabled: bool = True
|
||||||
|
log_level: LogLevels = LogLevels.info
|
||||||
|
log_dictconfig: Optional[Dict[str, Any]] = None
|
||||||
|
log_access: bool = False
|
||||||
|
log_access_format: Optional[str] = None
|
||||||
|
ssl_cert: Optional[Path] = None
|
||||||
|
ssl_key: Optional[Path] = None
|
||||||
|
ssl_key_password: Optional[str] = None
|
||||||
|
url_path_prefix: Optional[str] = None
|
||||||
|
respawn_failed_workers: bool = False
|
||||||
|
respawn_interval: float = 3.5
|
||||||
|
workers_lifetime: Optional[int] = None
|
||||||
|
factory: bool = False
|
||||||
|
reload: bool = False
|
||||||
|
reload_paths: Optional[Sequence[Path]] = None
|
||||||
|
reload_ignore_dirs: Optional[Sequence[str]] = None
|
||||||
|
reload_ignore_patterns: Optional[Sequence[str]] = None
|
||||||
|
reload_ignore_paths: Optional[Sequence[Path]] = None
|
||||||
|
process_name: Optional[str] = None
|
||||||
|
pid_file: Optional[Path] = None
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def from_dict(d) -> 'Configuration.GranianConfiguration':
|
||||||
|
return Configuration.GranianConfiguration(**{k: v for k, v in dict(
|
||||||
|
address=d.get('address', None),
|
||||||
|
port=d.get('port', None),
|
||||||
|
interface=Maybe.of_nullable(d.get('interface')).map(lambda it: Interfaces(it)).or_else(None),
|
||||||
|
workers=d.get('workers', None),
|
||||||
|
threads=d.get('threads', None),
|
||||||
|
blocking_threads=d.get('blocking_threads', None),
|
||||||
|
threading_mode=Maybe.of_nullable(d.get('threading_modes')).map(lambda it: ThreadModes(it)).or_else(None),
|
||||||
|
loop=Maybe.of_nullable(d.get('loop')).map(lambda it: Loops(it)).or_else(None),
|
||||||
|
loop_opt=d.get('loop_opt', None),
|
||||||
|
http=Maybe.of_nullable(d.get('http')).map(lambda it: HTTPModes(it)).or_else(None),
|
||||||
|
websockets=d.get('websockets', None),
|
||||||
|
backlog=d.get('backlog', None),
|
||||||
|
backpressure=d.get('backpressure', None),
|
||||||
|
http1_settings=Maybe.of_nullable(d.get('http1_settings')).map(lambda it: HTTP1Settings(**it)).or_else(None),
|
||||||
|
http2_settings=Maybe.of_nullable(d.get('http2_settings')).map(lambda it: HTTP2Settings(**it)).or_else(None),
|
||||||
|
log_enabled=d.get('log_enabled', None),
|
||||||
|
log_level=Maybe.of_nullable(d.get('log_level')).map(lambda it: LogLevels(it)).or_else(None),
|
||||||
|
log_dictconfig=parse_log_config(d.get('log_config_file')),
|
||||||
|
log_access=d.get('log_access', None),
|
||||||
|
log_access_format=d.get('log_access_format', None),
|
||||||
|
ssl_cert=d.get('ssl_cert', None),
|
||||||
|
ssl_key=d.get('ssl_key', None),
|
||||||
|
ssl_key_password=d.get('ssl_key_password', None),
|
||||||
|
url_path_prefix=d.get('url_path_prefix', None),
|
||||||
|
respawn_failed_workers=d.get('respawn_failed_workers', None),
|
||||||
|
respawn_interval=d.get('respawn_interval', None),
|
||||||
|
workers_lifetime=d.get('workers_lifetime', None),
|
||||||
|
factory=d.get('factory', None),
|
||||||
|
reload=d.get('reload', None),
|
||||||
|
reload_paths=d.get('reload_paths', None),
|
||||||
|
reload_ignore_dirs=d.get('reload_ignore_dirs', None),
|
||||||
|
reload_ignore_patterns=d.get('reload_ignore_patterns', None),
|
||||||
|
reload_ignore_paths=d.get('reload_ignore_paths', None),
|
||||||
|
process_name=d.get('process_name', None),
|
||||||
|
pid_file=d.get('pid_file', None),
|
||||||
|
).items() if v is not None})
|
||||||
|
|
||||||
|
granian: GranianConfiguration = GranianConfiguration()
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def from_dict(d) -> 'Configuration':
|
||||||
|
return Configuration(
|
||||||
|
**{k: v for k, v in dict(
|
||||||
|
logging_configuration_file=d.get('logging_configuration_file', None),
|
||||||
|
plant_uml_server_address=d.get('plant_uml_server_address', None),
|
||||||
|
granian=Maybe.of_nullable(d.get('granian'))
|
||||||
|
.map(Configuration.GranianConfiguration.from_dict)
|
||||||
|
.or_else(None)
|
||||||
|
).items() if v is not None
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
def to_yaml(self, stream):
|
||||||
|
dumper = SafeDumper(stream)
|
||||||
|
dumper.add_representer(Configuration, lambda dumper, conf: dumper.represent_dict(asdict(conf)))
|
||||||
|
dumper.add_representer(Configuration.GranianConfiguration,
|
||||||
|
lambda dumper, conf: dumper.represent_dict(asdict(conf)))
|
||||||
|
dumper.add_representer(LogLevels, lambda dumper, level: dumper.represent_str(level.lower()))
|
||||||
|
dumper.add_multi_representer(Path, lambda dumper, path: dumper.represent_str(str(path)))
|
||||||
|
dumper.add_multi_representer(StrEnum, lambda dumper, str_enum: dumper.represent_str(str(str_enum)))
|
||||||
|
dumper.add_representer(HTTP1Settings, lambda dumper, settings: dumper.represent_dict(vars(settings)))
|
||||||
|
dumper.add_representer(HTTP2Settings, lambda dumper, settings: dumper.represent_dict(vars(settings)))
|
||||||
|
|
||||||
|
try:
|
||||||
|
dumper.open()
|
||||||
|
dumper.represent(Configuration.instance)
|
||||||
|
dumper.close()
|
||||||
|
finally:
|
||||||
|
dumper.dispose()
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def from_yaml(stream) -> 'Configuration':
|
||||||
|
loader = SafeLoader(stream)
|
||||||
|
try:
|
||||||
|
conf = loader.get_single_data()
|
||||||
|
return Configuration.from_dict(conf)
|
||||||
|
finally:
|
||||||
|
loader.dispose()
|
||||||
|
|
||||||
|
instance = Configuration()
|
30
src/bugis/default-conf/logging.yaml
Normal file
30
src/bugis/default-conf/logging.yaml
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
version: 1
|
||||||
|
disable_existing_loggers: False
|
||||||
|
handlers:
|
||||||
|
console:
|
||||||
|
class : logging.StreamHandler
|
||||||
|
formatter: default
|
||||||
|
level : INFO
|
||||||
|
stream : ext://sys.stderr
|
||||||
|
access:
|
||||||
|
class : logging.StreamHandler
|
||||||
|
formatter: access
|
||||||
|
level : INFO
|
||||||
|
stream : ext://sys.stdout
|
||||||
|
formatters:
|
||||||
|
default:
|
||||||
|
format: '{asctime}.{msecs:0<3.0f} [{levelname}] ({processName:s}/{threadName:s}) - {name} - {message}'
|
||||||
|
style: '{'
|
||||||
|
datefmt: '%Y-%m-%d %H:%M:%S'
|
||||||
|
access:
|
||||||
|
format: '%(message)s'
|
||||||
|
loggers:
|
||||||
|
root:
|
||||||
|
handlers: [console]
|
||||||
|
_granian:
|
||||||
|
level: INFO
|
||||||
|
propagate: False
|
||||||
|
granian.access:
|
||||||
|
handlers: [ access ]
|
||||||
|
level: INFO
|
||||||
|
propagate: False
|
61
src/bugis/md2html.py
Normal file
61
src/bugis/md2html.py
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
import sys
|
||||||
|
from os.path import dirname, join, relpath
|
||||||
|
from time import time
|
||||||
|
from typing import Optional, TYPE_CHECKING
|
||||||
|
from aiofiles import open as async_open
|
||||||
|
from asyncio import AbstractEventLoop
|
||||||
|
import markdown
|
||||||
|
import logging
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from _typeshed import StrOrBytesPath
|
||||||
|
|
||||||
|
STATIC_RESOURCES: set[str] = {
|
||||||
|
'/github-markdown.css',
|
||||||
|
'/custom.css',
|
||||||
|
'/hot-reload.js',
|
||||||
|
'/pygment.css',
|
||||||
|
'/markdown.svg'
|
||||||
|
}
|
||||||
|
STATIC_CACHE: dict[str, tuple[str, float]] = {}
|
||||||
|
|
||||||
|
MARDOWN_EXTENSIONS = ['extra', 'smarty', 'tables', 'codehilite']
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
async def load_from_cache(path) -> tuple[str, float]:
|
||||||
|
global STATIC_CACHE
|
||||||
|
if path not in STATIC_CACHE:
|
||||||
|
async with async_open(join(dirname(__file__), 'static') + path, 'r') as static_file:
|
||||||
|
STATIC_CACHE[path] = (await static_file.read(), time())
|
||||||
|
return STATIC_CACHE[path]
|
||||||
|
|
||||||
|
|
||||||
|
async def compile_html(url_path,
|
||||||
|
mdfile: 'StrOrBytesPath',
|
||||||
|
loop: AbstractEventLoop,
|
||||||
|
prefix: Optional['StrOrBytesPath'] = None,
|
||||||
|
extensions: Optional[list[str]] = None,
|
||||||
|
raw: bool = False) -> str:
|
||||||
|
async with mdfile and async_open(mdfile, 'r') or sys.stdin as instream:
|
||||||
|
src = await instream.read()
|
||||||
|
|
||||||
|
def render(source) -> str:
|
||||||
|
logger.debug("Starting markdown rendering for file '%s'", mdfile)
|
||||||
|
result = markdown.markdown(source, extensions=extensions, output_format='html')
|
||||||
|
logger.debug("Markdown rendering for file '%s' completed", mdfile)
|
||||||
|
return result
|
||||||
|
|
||||||
|
html = await loop.run_in_executor(None, render, src)
|
||||||
|
if raw:
|
||||||
|
doc = html
|
||||||
|
else:
|
||||||
|
parent = dirname(url_path)
|
||||||
|
prefix = prefix or relpath('/', start=parent)
|
||||||
|
script = f'<script src="{prefix}/hot-reload.js", type="text/javascript" defer="true"></script>'
|
||||||
|
css = f'<link rel="icon" type="image/x-icon" href="{prefix}/markdown.svg">'
|
||||||
|
for css_file in ('github-markdown.css', 'pygment.css', 'custom.css'):
|
||||||
|
css += f' <link rel="stylesheet" href="{prefix}/{css_file}">'
|
||||||
|
doc = (await load_from_cache('/template.html'))[0].format(content=html, script=script, css=css)
|
||||||
|
return doc
|
19
src/bugis/plantuml.py
Normal file
19
src/bugis/plantuml.py
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from aiofiles import open as async_open
|
||||||
|
from .configuration import Configuration
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from _typeshed import StrOrBytesPath
|
||||||
|
from httpx import AsyncClient, URL
|
||||||
|
from typing import Callable, Awaitable
|
||||||
|
from urllib.parse import urljoin
|
||||||
|
|
||||||
|
chunk_size = 0x10000
|
||||||
|
async def render_plant_uml(client: AsyncClient, path: 'StrOrBytesPath', send : Callable[[bytes], Awaitable[None]]):
|
||||||
|
url = URL(urljoin(Configuration.instance.plant_uml_server_address, 'svg'))
|
||||||
|
async with async_open(path, 'rb') as file:
|
||||||
|
source = await file.read()
|
||||||
|
response = await client.post(url, content=source)
|
||||||
|
response.raise_for_status()
|
||||||
|
async for chunk in response.aiter_bytes(chunk_size=chunk_size):
|
||||||
|
await send(chunk)
|
0
src/bugis/py.typed
Normal file
0
src/bugis/py.typed
Normal file
408
src/bugis/server.py
Normal file
408
src/bugis/server.py
Normal file
@@ -0,0 +1,408 @@
|
|||||||
|
import hashlib
|
||||||
|
import logging
|
||||||
|
from asyncio import AbstractEventLoop
|
||||||
|
from asyncio import Future
|
||||||
|
from io import BytesIO
|
||||||
|
from mimetypes import init as mimeinit, guess_type
|
||||||
|
from os import getcwd
|
||||||
|
from os.path import join, normpath, splitext, relpath, basename
|
||||||
|
from typing import Callable, TYPE_CHECKING, Optional, Awaitable, AsyncGenerator, Any, Mapping
|
||||||
|
|
||||||
|
import pygraphviz as pgv
|
||||||
|
from aiofiles import open as async_open
|
||||||
|
from aiofiles.base import AiofilesContextManager
|
||||||
|
from aiofiles.os import listdir
|
||||||
|
from aiofiles.ospath import exists, isdir, isfile, getmtime
|
||||||
|
from aiofiles.threadpool.binary import AsyncBufferedReader
|
||||||
|
from httpx import AsyncClient
|
||||||
|
from pwo import Maybe
|
||||||
|
|
||||||
|
from .asgi_utils import encode_headers
|
||||||
|
from .async_watchdog import FileWatcher
|
||||||
|
from .configuration import Configuration
|
||||||
|
from .md2html import compile_html, load_from_cache, STATIC_RESOURCES, MARDOWN_EXTENSIONS
|
||||||
|
from .plantuml import render_plant_uml
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from _typeshed import StrOrBytesPath
|
||||||
|
|
||||||
|
mimeinit()
|
||||||
|
|
||||||
|
cwd: 'StrOrBytesPath' = getcwd()
|
||||||
|
|
||||||
|
|
||||||
|
def completed_future[T](result: T) -> Future[T]:
|
||||||
|
future = Future()
|
||||||
|
future.set_result(result)
|
||||||
|
return future
|
||||||
|
|
||||||
|
|
||||||
|
def has_extension(filepath, extension):
|
||||||
|
_, ext = splitext(filepath)
|
||||||
|
return ext == extension
|
||||||
|
|
||||||
|
|
||||||
|
def is_markdown(filepath):
|
||||||
|
return has_extension(filepath, ".md")
|
||||||
|
|
||||||
|
|
||||||
|
def is_dotfile(filepath):
|
||||||
|
return has_extension(filepath, ".dot")
|
||||||
|
|
||||||
|
|
||||||
|
def is_plant_uml(filepath):
|
||||||
|
return has_extension(filepath, ".puml")
|
||||||
|
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class Server:
|
||||||
|
root_dir: 'StrOrBytesPath'
|
||||||
|
prefix: Optional['StrOrBytesPath']
|
||||||
|
_loop: AbstractEventLoop
|
||||||
|
_client: AsyncClient
|
||||||
|
|
||||||
|
def __init__(self,
|
||||||
|
root_dir: 'StrOrBytesPath' = getcwd(),
|
||||||
|
prefix: Optional['StrOrBytesPath'] = None,
|
||||||
|
loop: AbstractEventLoop = None):
|
||||||
|
self.root_dir = root_dir
|
||||||
|
self.cache = dict['StrOrBytesPath', tuple[str, float]]()
|
||||||
|
self.file_watcher = FileWatcher(cwd)
|
||||||
|
self.prefix = prefix and normpath(f'{prefix.decode()}')
|
||||||
|
self._loop = loop
|
||||||
|
self._client = AsyncClient()
|
||||||
|
|
||||||
|
async def handle_request(self,
|
||||||
|
method: str,
|
||||||
|
url_path: str,
|
||||||
|
etag: Optional[str],
|
||||||
|
query_string: Optional[str],
|
||||||
|
send: Callable[[Mapping[str, Any]], Awaitable[None]],
|
||||||
|
pathsend: bool = False
|
||||||
|
):
|
||||||
|
if method != 'GET':
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 405
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': b'',
|
||||||
|
})
|
||||||
|
return
|
||||||
|
relative_path = relpath(url_path, start=self.prefix or '/')
|
||||||
|
url_path: 'StrOrBytesPath' = normpath(join('/', relative_path))
|
||||||
|
path: 'StrOrBytesPath' = join(self.root_dir, relative_path)
|
||||||
|
if url_path in STATIC_RESOURCES:
|
||||||
|
content, mtime = await load_from_cache(url_path)
|
||||||
|
content = content.encode()
|
||||||
|
etag, digest = await self.compute_etag_and_digest(
|
||||||
|
etag,
|
||||||
|
url_path,
|
||||||
|
lambda: AiofilesContextManager(
|
||||||
|
completed_future(AsyncBufferedReader(BytesIO(content), loop=self._loop, executor=None))),
|
||||||
|
lambda: completed_future(mtime)
|
||||||
|
)
|
||||||
|
if etag and etag == digest:
|
||||||
|
await self.not_modified(send, digest, 'must-revalidate, max-age=86400')
|
||||||
|
return
|
||||||
|
elif content:
|
||||||
|
mime_type = guess_type(basename(url_path))[0] or 'application/octet-stream'
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 200,
|
||||||
|
'headers': encode_headers({
|
||||||
|
'content-type': f'{mime_type}; charset=UTF-8',
|
||||||
|
'etag': f'W/{digest}',
|
||||||
|
'Cache-Control': 'must-revalidate, max-age=86400',
|
||||||
|
})
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': content
|
||||||
|
})
|
||||||
|
return
|
||||||
|
elif await exists(path):
|
||||||
|
if await isfile(path):
|
||||||
|
etag, digest = await self.compute_etag_and_digest(
|
||||||
|
etag,
|
||||||
|
path,
|
||||||
|
lambda: async_open(path, 'rb'),
|
||||||
|
lambda: getmtime(path)
|
||||||
|
)
|
||||||
|
logger.debug('Etag: %s, digest: %s', etag, digest)
|
||||||
|
if etag and etag == digest:
|
||||||
|
if is_markdown(path) and query_string == 'reload':
|
||||||
|
subscription = self.file_watcher.subscribe(path)
|
||||||
|
try:
|
||||||
|
has_changed = await subscription.wait(30)
|
||||||
|
if has_changed:
|
||||||
|
_, digest = await self.compute_etag_and_digest(
|
||||||
|
etag,
|
||||||
|
path,
|
||||||
|
lambda: async_open(path, 'rb'),
|
||||||
|
lambda: getmtime(path)
|
||||||
|
)
|
||||||
|
if etag != digest:
|
||||||
|
if await exists(path) and await isfile(path):
|
||||||
|
await self.render_markdown(url_path, path, True, digest, send)
|
||||||
|
return
|
||||||
|
else:
|
||||||
|
await self.not_found(send)
|
||||||
|
return
|
||||||
|
finally:
|
||||||
|
subscription.unsubscribe()
|
||||||
|
await self.not_modified(send, digest)
|
||||||
|
elif is_markdown(path):
|
||||||
|
raw = query_string == 'reload'
|
||||||
|
await self.render_markdown(url_path, path, raw, digest, send)
|
||||||
|
elif is_dotfile(path):
|
||||||
|
def render_graphviz(filepath: StrOrBytesPath) -> bytes:
|
||||||
|
logger.debug("Starting Graphviz rendering for file '%s'", filepath)
|
||||||
|
graph = pgv.AGraph(filepath)
|
||||||
|
result = graph.draw(None, format="svg", prog="dot")
|
||||||
|
logger.debug("Completed Graphviz rendering for file '%s'", filepath)
|
||||||
|
return result
|
||||||
|
|
||||||
|
body = await self._loop.run_in_executor(None, render_graphviz, path)
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 200,
|
||||||
|
'headers': encode_headers({
|
||||||
|
'Content-Type': 'image/svg+xml; charset=UTF-8',
|
||||||
|
'Etag': f'W/{digest}',
|
||||||
|
'Cache-Control': 'no-cache',
|
||||||
|
})
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': body
|
||||||
|
})
|
||||||
|
elif Configuration.instance.plant_uml_server_address and is_plant_uml(path):
|
||||||
|
logger.debug("Starting PlantUML rendering for file '%s'", path)
|
||||||
|
logger.debug("Completed PlantUML rendering for file '%s'", path)
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 200,
|
||||||
|
'headers': encode_headers({
|
||||||
|
'Content-Type': 'image/svg+xml; charset=UTF-8',
|
||||||
|
'Etag': f'W/{digest}',
|
||||||
|
'Cache-Control': 'no-cache'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
await render_plant_uml(self._client, path, lambda chunk: send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': chunk,
|
||||||
|
'more_body': True
|
||||||
|
}))
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': '',
|
||||||
|
'more_body': False
|
||||||
|
})
|
||||||
|
else:
|
||||||
|
async def read_file(file_path, buffer_size=0x10000):
|
||||||
|
async with async_open(file_path, 'rb') as f:
|
||||||
|
while True:
|
||||||
|
result = await f.read(buffer_size)
|
||||||
|
if len(result) == 0:
|
||||||
|
break
|
||||||
|
yield result
|
||||||
|
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 200,
|
||||||
|
'headers': encode_headers({
|
||||||
|
'Content-Type': guess_type(basename(path))[0] or 'application/octet-stream',
|
||||||
|
'Etag': f'W/{digest}',
|
||||||
|
'Cache-Control': 'no-cache'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
if pathsend:
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.pathsend',
|
||||||
|
'path': path
|
||||||
|
})
|
||||||
|
else:
|
||||||
|
async for chunk in read_file(path):
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': chunk,
|
||||||
|
'more_body': True
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': b'',
|
||||||
|
'more_body': False
|
||||||
|
})
|
||||||
|
|
||||||
|
elif await isdir(path):
|
||||||
|
body = (await self.directory_listing(url_path, path)).encode()
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 200,
|
||||||
|
'headers': encode_headers({
|
||||||
|
'Content-Type': 'text/html; charset=UTF-8',
|
||||||
|
})
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': body
|
||||||
|
})
|
||||||
|
else:
|
||||||
|
await self.not_found(send)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
async def stream_hash(source: AsyncBufferedReader, bufsize=0x10000) -> bytes:
|
||||||
|
if bufsize <= 0:
|
||||||
|
raise ValueError("Buffer size must be greater than 0")
|
||||||
|
md5 = hashlib.md5()
|
||||||
|
while True:
|
||||||
|
buf = await source.read(bufsize)
|
||||||
|
if len(buf) == 0:
|
||||||
|
break
|
||||||
|
md5.update(buf)
|
||||||
|
return md5.digest()
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
async def file_hash(filepath, bufsize=0x10000) -> bytes:
|
||||||
|
if bufsize <= 0:
|
||||||
|
raise ValueError("Buffer size must be greater than 0")
|
||||||
|
md5 = hashlib.md5()
|
||||||
|
async with async_open(filepath, 'rb') as f:
|
||||||
|
while True:
|
||||||
|
buf = await f.read(bufsize)
|
||||||
|
if len(buf) == 0:
|
||||||
|
break
|
||||||
|
md5.update(buf)
|
||||||
|
return md5.digest()
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def parse_etag(etag: str) -> Optional[str]:
|
||||||
|
def skip_weak_marker(s):
|
||||||
|
if s.startswith('W/'):
|
||||||
|
return s[2:]
|
||||||
|
else:
|
||||||
|
return s
|
||||||
|
|
||||||
|
return (
|
||||||
|
Maybe.of_nullable(etag)
|
||||||
|
.map(skip_weak_marker)
|
||||||
|
.or_else(None)
|
||||||
|
)
|
||||||
|
|
||||||
|
async def compute_etag_and_digest(
|
||||||
|
self,
|
||||||
|
etag_header: str,
|
||||||
|
path: str,
|
||||||
|
stream_source: Callable[[], AiofilesContextManager[AsyncBufferedReader]],
|
||||||
|
mtime_supplier: Callable[[], Awaitable[float]]
|
||||||
|
) -> tuple[str, str]:
|
||||||
|
cache_result = self.cache.get(path)
|
||||||
|
_mtime: Optional[float] = None
|
||||||
|
|
||||||
|
async def mtime() -> float:
|
||||||
|
nonlocal _mtime
|
||||||
|
if not _mtime:
|
||||||
|
_mtime = await mtime_supplier()
|
||||||
|
return _mtime
|
||||||
|
|
||||||
|
if not cache_result or cache_result[1] < await mtime():
|
||||||
|
async with stream_source() as stream:
|
||||||
|
digest = (await Server.stream_hash(stream)).hex()
|
||||||
|
self.cache[path] = digest, await mtime()
|
||||||
|
else:
|
||||||
|
digest = cache_result[0]
|
||||||
|
|
||||||
|
etag = Server.parse_etag(etag_header)
|
||||||
|
return etag, digest
|
||||||
|
|
||||||
|
async def render_markdown(self,
|
||||||
|
url_path: 'StrOrBytesPath',
|
||||||
|
path: str,
|
||||||
|
raw: bool,
|
||||||
|
digest: str,
|
||||||
|
send) -> None:
|
||||||
|
|
||||||
|
body = await compile_html(
|
||||||
|
url_path,
|
||||||
|
path,
|
||||||
|
self._loop,
|
||||||
|
self.prefix,
|
||||||
|
MARDOWN_EXTENSIONS,
|
||||||
|
raw=raw
|
||||||
|
)
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 200,
|
||||||
|
'headers': encode_headers({
|
||||||
|
'Content-Type': 'text/html; charset=UTF-8',
|
||||||
|
'Etag': f'W/{digest}',
|
||||||
|
'Cache-Control': 'no-cache',
|
||||||
|
})
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
'body': body.encode()
|
||||||
|
})
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
async def not_modified(send, digest: str, cache_control: str = 'no-cache') -> []:
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 304,
|
||||||
|
'headers': encode_headers({
|
||||||
|
'Etag': f'W/{digest}',
|
||||||
|
'Cache-Control': cache_control
|
||||||
|
})
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
})
|
||||||
|
return
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
async def not_found(send) -> None:
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.start',
|
||||||
|
'status': 404
|
||||||
|
})
|
||||||
|
await send({
|
||||||
|
'type': 'http.response.body',
|
||||||
|
})
|
||||||
|
|
||||||
|
async def directory_listing(self, path_info, path) -> str:
|
||||||
|
icon_path = join(self.prefix or '', 'markdown.svg')
|
||||||
|
title = "Directory listing for %s" % path_info
|
||||||
|
result = "<!DOCTYPE html><html><head>"
|
||||||
|
result += f'<link rel="icon" type="image/x-icon" href="{icon_path}">'
|
||||||
|
result += "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">"
|
||||||
|
result += "<title>" + title + "</title></head>"
|
||||||
|
result += "<body><h1>" + title + "</h1><hr>"
|
||||||
|
result += "<ul>"
|
||||||
|
if path_info != '/':
|
||||||
|
result += "<li><a href=\"../\"/>../</li>"
|
||||||
|
|
||||||
|
async def ls(filter: Callable[[str], Awaitable[bool]]) -> AsyncGenerator[str, Any]:
|
||||||
|
async def result():
|
||||||
|
for entry in sorted(await listdir(path)):
|
||||||
|
if await filter(join(path, entry)):
|
||||||
|
yield entry
|
||||||
|
|
||||||
|
return result()
|
||||||
|
|
||||||
|
async for entry in await ls(isdir):
|
||||||
|
result += '<li><a href="' + entry + '/' + '"/>' + entry + '/' + '</li>'
|
||||||
|
|
||||||
|
async def file_filter(entry: str) -> bool:
|
||||||
|
return await isfile(entry) and is_markdown(entry)
|
||||||
|
|
||||||
|
async for entry in await ls(file_filter):
|
||||||
|
result += '<li><a href="' + entry + '"/>' + entry + '</li>'
|
||||||
|
return result
|
||||||
|
|
||||||
|
async def stop(self):
|
||||||
|
await self.file_watcher.stop()
|
||||||
|
await self._client.aclose()
|
21
src/bugis/static/hot-reload.js
Normal file
21
src/bugis/static/hot-reload.js
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
|
||||||
|
function req(first, previousETag) {
|
||||||
|
const minInterval = 2000;
|
||||||
|
const start = new Date().getTime();
|
||||||
|
const xmlhttp = new XMLHttpRequest();
|
||||||
|
xmlhttp.onload = function() {
|
||||||
|
const eTag = xmlhttp.getResponseHeader("Etag")
|
||||||
|
if (xmlhttp.status == 200 && eTag !== previousETag) {
|
||||||
|
document.querySelector("article.markdown-body").innerHTML = xmlhttp.responseText;
|
||||||
|
}
|
||||||
|
const nextCall = Math.min(minInterval, Math.max(0, minInterval - (new Date().getTime() - start)));
|
||||||
|
setTimeout(req, nextCall, false, eTag);
|
||||||
|
};
|
||||||
|
xmlhttp.onerror = function() {
|
||||||
|
console.log(xmlhttp.status, xmlhttp.statusText);
|
||||||
|
setTimeout(req, minInterval, false, previousETag);
|
||||||
|
};
|
||||||
|
xmlhttp.open("GET", location.pathname + "?reload", true);
|
||||||
|
xmlhttp.send();
|
||||||
|
}
|
||||||
|
req(true, null);
|
Before Width: | Height: | Size: 394 B After Width: | Height: | Size: 394 B |
@@ -1,92 +0,0 @@
|
|||||||
from threading import Lock
|
|
||||||
from typing import Optional, Callable
|
|
||||||
from os import getcwd
|
|
||||||
from watchdog.events import PatternMatchingEventHandler, FileSystemEvent, \
|
|
||||||
FileCreatedEvent, FileModifiedEvent, FileClosedEvent, FileMovedEvent
|
|
||||||
from watchdog.observers import Observer
|
|
||||||
import logging
|
|
||||||
from gevent.event import Event
|
|
||||||
|
|
||||||
|
|
||||||
class Subscription:
|
|
||||||
|
|
||||||
def __init__(self, unsubscribe: Callable[['Subscription'], None]):
|
|
||||||
self._unsubscribe_callback = unsubscribe
|
|
||||||
self._event: Event = Event()
|
|
||||||
|
|
||||||
def unsubscribe(self) -> None:
|
|
||||||
self._unsubscribe_callback(self)
|
|
||||||
|
|
||||||
def wait(self, tout: float) -> bool:
|
|
||||||
return self._event.wait(tout)
|
|
||||||
|
|
||||||
def notify(self) -> None:
|
|
||||||
self._event.set()
|
|
||||||
|
|
||||||
def reset(self) -> None:
|
|
||||||
self._event.clear()
|
|
||||||
|
|
||||||
|
|
||||||
class FileWatcher(PatternMatchingEventHandler):
|
|
||||||
def __init__(self, path):
|
|
||||||
super().__init__(patterns=['*.md'],
|
|
||||||
ignore_patterns=None,
|
|
||||||
ignore_directories=False,
|
|
||||||
case_sensitive=True)
|
|
||||||
self.subscriptions: dict[str, set[Subscription]] = dict()
|
|
||||||
self.observer: Observer = Observer()
|
|
||||||
self.observer.schedule(self, path=path, recursive=True)
|
|
||||||
self.observer.start()
|
|
||||||
self.logger = logging.getLogger(FileWatcher.__name__)
|
|
||||||
self._lock = Lock()
|
|
||||||
|
|
||||||
def subscribe(self, path: str) -> Subscription:
|
|
||||||
subscriptions = self.subscriptions
|
|
||||||
subscriptions_per_path = subscriptions.setdefault(path, set())
|
|
||||||
|
|
||||||
def unsubscribe_callback(subscription):
|
|
||||||
with self._lock:
|
|
||||||
subscriptions_per_path.remove(subscription)
|
|
||||||
|
|
||||||
result = Subscription(unsubscribe_callback)
|
|
||||||
subscriptions_per_path.add(result)
|
|
||||||
return result
|
|
||||||
|
|
||||||
def stop(self) -> None:
|
|
||||||
self.observer.stop()
|
|
||||||
self.observer.join()
|
|
||||||
|
|
||||||
def on_any_event(self, event: FileSystemEvent) -> None:
|
|
||||||
what = "directory" if event.is_directory else "file"
|
|
||||||
|
|
||||||
def notify_subscriptions(path):
|
|
||||||
with self._lock:
|
|
||||||
subscriptions = self.subscriptions
|
|
||||||
subscriptions_per_path = subscriptions.get(path, None)
|
|
||||||
if subscriptions_per_path:
|
|
||||||
for s in subscriptions_per_path:
|
|
||||||
s.notify()
|
|
||||||
|
|
||||||
if isinstance(event, FileClosedEvent):
|
|
||||||
self.logger.debug("Closed %s: %s", what, event.src_path)
|
|
||||||
# update_subscriptions()
|
|
||||||
elif isinstance(event, FileMovedEvent):
|
|
||||||
self.logger.debug("Moved %s: %s to %s", what, event.src_path, event.dest_path)
|
|
||||||
notify_subscriptions(event.dest_path)
|
|
||||||
elif isinstance(event, FileCreatedEvent):
|
|
||||||
self.logger.debug("Created %s: %s", what, event.src_path)
|
|
||||||
notify_subscriptions(event.src_path)
|
|
||||||
elif isinstance(event, FileModifiedEvent):
|
|
||||||
self.logger.debug("Modified %s: %s", what, event.src_path)
|
|
||||||
notify_subscriptions(event.src_path)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
|
|
||||||
logging.basicConfig(
|
|
||||||
level=logging.DEBUG,
|
|
||||||
format='%(asctime)s [%(threadName)s] (%(name)s) %(levelname)s %(message)s'
|
|
||||||
)
|
|
||||||
watcher = FileWatcher(getcwd())
|
|
||||||
watcher.observer.join()
|
|
||||||
|
|
@@ -1,48 +0,0 @@
|
|||||||
import sys
|
|
||||||
from os.path import dirname, join, relpath
|
|
||||||
from time import time
|
|
||||||
from typing import Optional, TYPE_CHECKING
|
|
||||||
|
|
||||||
import markdown
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
from _typeshed import StrOrBytesPath
|
|
||||||
|
|
||||||
STATIC_RESOURCES: set[str] = {
|
|
||||||
'/github-markdown.css',
|
|
||||||
'/custom.css',
|
|
||||||
'/hot-reload.js',
|
|
||||||
'/pygment.css',
|
|
||||||
'/markdown.svg'
|
|
||||||
}
|
|
||||||
STATIC_CACHE: dict[str, tuple[str, float]] = {}
|
|
||||||
|
|
||||||
MARDOWN_EXTENSIONS = ['extra', 'smarty', 'tables', 'codehilite']
|
|
||||||
|
|
||||||
|
|
||||||
def load_from_cache(path) -> tuple[str, float]:
|
|
||||||
global STATIC_CACHE
|
|
||||||
if path not in STATIC_CACHE:
|
|
||||||
with open(join(dirname(__file__), 'static') + path, 'r') as static_file:
|
|
||||||
STATIC_CACHE[path] = (static_file.read(), time())
|
|
||||||
return STATIC_CACHE[path]
|
|
||||||
|
|
||||||
|
|
||||||
def compile_html(url_path,
|
|
||||||
mdfile: 'StrOrBytesPath',
|
|
||||||
prefix: Optional['StrOrBytesPath'] = None,
|
|
||||||
extensions: Optional[list[str]] = None,
|
|
||||||
raw: bool = False) -> str:
|
|
||||||
with mdfile and open(mdfile, 'r') or sys.stdin as instream:
|
|
||||||
html = markdown.markdown(instream.read(), extensions=extensions, output_format='html')
|
|
||||||
if raw:
|
|
||||||
doc = html
|
|
||||||
else:
|
|
||||||
parent = dirname(url_path)
|
|
||||||
prefix = prefix or relpath('/', start=parent)
|
|
||||||
script = f'<script src="{prefix}/hot-reload.js", type="text/javascript" defer="true"></script>'
|
|
||||||
css = f'<link rel="icon" type="image/x-icon" href="{prefix}/markdown.svg">'
|
|
||||||
for css_file in ('github-markdown.css', 'pygment.css', 'custom.css'):
|
|
||||||
css += f' <link rel="stylesheet" href="{prefix}/{css_file}">'
|
|
||||||
doc = load_from_cache('/template.html')[0].format(content=html, script=script, css=css)
|
|
||||||
return doc
|
|
@@ -1,240 +0,0 @@
|
|||||||
import logging
|
|
||||||
from os import getcwd, listdir
|
|
||||||
from os.path import exists, splitext, isfile, join, relpath, isdir, basename, getmtime, dirname, normpath
|
|
||||||
from mimetypes import init as mimeinit, guess_type
|
|
||||||
import hashlib
|
|
||||||
from .md2html import compile_html, load_from_cache, STATIC_RESOURCES, MARDOWN_EXTENSIONS
|
|
||||||
from shutil import which
|
|
||||||
from subprocess import check_output
|
|
||||||
from io import BytesIO
|
|
||||||
from typing import Callable, TYPE_CHECKING, BinaryIO, Optional
|
|
||||||
from .file_watch import FileWatcher
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
from _typeshed import StrOrBytesPath
|
|
||||||
|
|
||||||
mimeinit()
|
|
||||||
|
|
||||||
cwd: 'StrOrBytesPath' = getcwd()
|
|
||||||
|
|
||||||
|
|
||||||
def has_extension(filepath, extension):
|
|
||||||
_, ext = splitext(filepath)
|
|
||||||
return ext == extension
|
|
||||||
|
|
||||||
|
|
||||||
def is_markdown(filepath):
|
|
||||||
return has_extension(filepath, ".md")
|
|
||||||
|
|
||||||
|
|
||||||
def is_dotfile(filepath):
|
|
||||||
return has_extension(filepath, ".dot")
|
|
||||||
|
|
||||||
|
|
||||||
class Server:
|
|
||||||
|
|
||||||
def __init__(self, root_dir: 'StrOrBytesPath' = getcwd(), prefix: Optional['StrOrBytesPath'] = None):
|
|
||||||
self.root_dir = root_dir
|
|
||||||
self.cache = dict['StrOrBytesPath', tuple[str, float]]()
|
|
||||||
self.file_watcher = FileWatcher(cwd)
|
|
||||||
self.logger = logging.getLogger(Server.__name__)
|
|
||||||
self.prefix = prefix and normpath(f'{prefix.decode()}')
|
|
||||||
|
|
||||||
def handle_request(self, method: str, url_path: str, etag: Optional[str], query_string: Optional[str], start_response):
|
|
||||||
if method != 'GET':
|
|
||||||
start_response('405', [])
|
|
||||||
return []
|
|
||||||
relative_path = relpath(url_path, start=self.prefix or '/')
|
|
||||||
url_path: 'StrOrBytesPath' = normpath(join('/', relative_path))
|
|
||||||
path: 'StrOrBytesPath' = join(self.root_dir, relative_path)
|
|
||||||
if url_path in STATIC_RESOURCES:
|
|
||||||
content, mtime = load_from_cache(url_path)
|
|
||||||
content = content.encode()
|
|
||||||
etag, digest = self.compute_etag_and_digest(
|
|
||||||
etag,
|
|
||||||
url_path,
|
|
||||||
lambda: BytesIO(content),
|
|
||||||
lambda: mtime
|
|
||||||
)
|
|
||||||
if etag and etag == digest:
|
|
||||||
return self.not_modified(start_response, digest, ('Cache-Control', 'must-revalidate, max-age=86400'))
|
|
||||||
elif content:
|
|
||||||
mime_type = guess_type(basename(url_path))[0] or 'application/octet-stream'
|
|
||||||
start_response('200 OK', [
|
|
||||||
('Content-Type', f'{mime_type}; charset=UTF-8'),
|
|
||||||
('Etag', 'W/"%s"' % digest),
|
|
||||||
('Cache-Control', 'must-revalidate, max-age=86400'),
|
|
||||||
])
|
|
||||||
return content
|
|
||||||
elif exists(path):
|
|
||||||
if isfile(path):
|
|
||||||
etag, digest = self.compute_etag_and_digest(
|
|
||||||
etag,
|
|
||||||
path,
|
|
||||||
lambda: open(path, 'rb'),
|
|
||||||
lambda: getmtime(path)
|
|
||||||
)
|
|
||||||
if etag and etag == digest:
|
|
||||||
if is_markdown(path) and query_string == 'reload':
|
|
||||||
subscription = self.file_watcher.subscribe(path)
|
|
||||||
try:
|
|
||||||
has_changed = subscription.wait(30)
|
|
||||||
if has_changed:
|
|
||||||
_, digest = self.compute_etag_and_digest(
|
|
||||||
etag,
|
|
||||||
path,
|
|
||||||
lambda: open(path, 'rb'),
|
|
||||||
lambda: getmtime(path)
|
|
||||||
)
|
|
||||||
if etag != digest:
|
|
||||||
if exists(path) and isfile(path):
|
|
||||||
return self.render_markdown(url_path, path, True, digest, start_response)
|
|
||||||
else:
|
|
||||||
return self.not_found(start_response)
|
|
||||||
finally:
|
|
||||||
subscription.unsubscribe()
|
|
||||||
return self.not_modified(start_response, digest)
|
|
||||||
elif is_markdown(path):
|
|
||||||
raw = query_string == 'reload'
|
|
||||||
return self.render_markdown(url_path, path, raw, digest, start_response)
|
|
||||||
elif is_dotfile(path) and which("dot"):
|
|
||||||
body = check_output(['dot', '-Tsvg', basename(path)], cwd=dirname(path))
|
|
||||||
start_response('200 OK', [('Content-Type', 'image/svg+xml; charset=UTF-8'),
|
|
||||||
('Etag', 'W/"%s"' % digest),
|
|
||||||
('Cache-Control', 'no-cache'),
|
|
||||||
])
|
|
||||||
return [body]
|
|
||||||
else:
|
|
||||||
def read_file(file_path):
|
|
||||||
buffer_size = 1024
|
|
||||||
with open(file_path, 'rb') as f:
|
|
||||||
while True:
|
|
||||||
result = f.read(buffer_size)
|
|
||||||
if len(result) == 0:
|
|
||||||
break
|
|
||||||
yield result
|
|
||||||
|
|
||||||
start_response('200 OK',
|
|
||||||
[('Content-Type', guess_type(basename(path))[0] or 'application/octet-stream'),
|
|
||||||
('Etag', 'W/"%s"' % digest),
|
|
||||||
('Cache-Control', 'no-cache'),
|
|
||||||
])
|
|
||||||
return read_file(path)
|
|
||||||
elif isdir(path):
|
|
||||||
body = self.directory_listing(url_path, path).encode()
|
|
||||||
start_response('200 OK', [
|
|
||||||
('Content-Type', 'text/html; charset=UTF-8'),
|
|
||||||
])
|
|
||||||
return [body]
|
|
||||||
return self.not_found(start_response)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def stream_hash(source: BinaryIO, bufsize=0x1000) -> bytes:
|
|
||||||
if bufsize <= 0:
|
|
||||||
raise ValueError("Buffer size must be greater than 0")
|
|
||||||
md5 = hashlib.md5()
|
|
||||||
while True:
|
|
||||||
buf = source.read(bufsize)
|
|
||||||
if len(buf) == 0:
|
|
||||||
break
|
|
||||||
md5.update(buf)
|
|
||||||
return md5.digest()
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def file_hash(filepath, bufsize=0x1000) -> bytes:
|
|
||||||
if bufsize <= 0:
|
|
||||||
raise ValueError("Buffer size must be greater than 0")
|
|
||||||
md5 = hashlib.md5()
|
|
||||||
with open(filepath, 'rb') as f:
|
|
||||||
while True:
|
|
||||||
buf = f.read(bufsize)
|
|
||||||
if len(buf) == 0:
|
|
||||||
break
|
|
||||||
md5.update(buf)
|
|
||||||
return md5.digest()
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def parse_etag(etag: str) -> Optional[str]:
|
|
||||||
if etag is None:
|
|
||||||
return
|
|
||||||
start = etag.find('"')
|
|
||||||
if start < 0:
|
|
||||||
return
|
|
||||||
end = etag.find('"', start + 1)
|
|
||||||
return etag[start + 1: end]
|
|
||||||
|
|
||||||
def compute_etag_and_digest(
|
|
||||||
self,
|
|
||||||
etag_header: str,
|
|
||||||
path: str,
|
|
||||||
stream_source: Callable[[], BinaryIO],
|
|
||||||
mtime_supplier: Callable[[], float]
|
|
||||||
) -> tuple[str, str]:
|
|
||||||
cache_result = self.cache.get(path)
|
|
||||||
_mtime: Optional[float] = None
|
|
||||||
|
|
||||||
def mtime() -> float:
|
|
||||||
nonlocal _mtime
|
|
||||||
if not _mtime:
|
|
||||||
_mtime = mtime_supplier()
|
|
||||||
return _mtime
|
|
||||||
|
|
||||||
if not cache_result or cache_result[1] < mtime():
|
|
||||||
with stream_source() as stream:
|
|
||||||
digest = Server.stream_hash(stream).hex()
|
|
||||||
self.cache[path] = digest, mtime()
|
|
||||||
else:
|
|
||||||
digest = cache_result[0]
|
|
||||||
|
|
||||||
etag = Server.parse_etag(etag_header)
|
|
||||||
return etag, digest
|
|
||||||
|
|
||||||
def render_markdown(self,
|
|
||||||
url_path: 'StrOrBytesPath',
|
|
||||||
path: str,
|
|
||||||
raw: bool,
|
|
||||||
digest: str,
|
|
||||||
start_response) -> list[bytes]:
|
|
||||||
body = compile_html(url_path,
|
|
||||||
path,
|
|
||||||
self.prefix,
|
|
||||||
MARDOWN_EXTENSIONS,
|
|
||||||
raw=raw).encode()
|
|
||||||
start_response('200 OK', [('Content-Type', 'text/html; charset=UTF-8'),
|
|
||||||
('Etag', 'W/"%s"' % digest),
|
|
||||||
('Cache-Control', 'no-cache'),
|
|
||||||
])
|
|
||||||
return [body]
|
|
||||||
@staticmethod
|
|
||||||
def not_modified(start_response, digest: str, cache_control=('Cache-Control', 'no-cache')) -> []:
|
|
||||||
start_response('304 Not Modified', [
|
|
||||||
('Etag', f'W/"{digest}"'),
|
|
||||||
cache_control,
|
|
||||||
])
|
|
||||||
return []
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def not_found(start_response) -> list[bytes]:
|
|
||||||
start_response('404 NOT_FOUND', [])
|
|
||||||
return []
|
|
||||||
|
|
||||||
def directory_listing(self, path_info, path) -> str:
|
|
||||||
icon_path = join(self.prefix or '', 'markdown.svg')
|
|
||||||
title = "Directory listing for %s" % path_info
|
|
||||||
result = "<!DOCTYPE html><html><head>"
|
|
||||||
result += f'<link rel="icon" type="image/x-icon" href="{icon_path}">'
|
|
||||||
result += "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">"
|
|
||||||
result += "<title>" + title + "</title></head>"
|
|
||||||
result += "<body><h1>" + title + "</h1><hr>"
|
|
||||||
result += "<ul>"
|
|
||||||
if path_info != '/':
|
|
||||||
result += "<li><a href=\"../\"/>../</li>"
|
|
||||||
|
|
||||||
def ls(filter):
|
|
||||||
return (entry for entry in sorted(listdir(path)) if filter(join(path, entry)))
|
|
||||||
|
|
||||||
for entry in ls(isdir):
|
|
||||||
result += '<li><a href="' + entry + '/' + '"/>' + entry + '/' + '</li>'
|
|
||||||
for entry in ls(lambda entry: isfile(entry) and is_markdown(entry)):
|
|
||||||
result += '<li><a href="' + entry + '"/>' + entry + '</li>'
|
|
||||||
return result
|
|
@@ -1,19 +0,0 @@
|
|||||||
function req(first) {
|
|
||||||
var xmlhttp = new XMLHttpRequest();
|
|
||||||
xmlhttp.onload = function() {
|
|
||||||
if (xmlhttp.status == 200) {
|
|
||||||
document.querySelector("article.markdown-body").innerHTML = xmlhttp.responseText;
|
|
||||||
} else if(xmlhttp.status == 304) {
|
|
||||||
} else {
|
|
||||||
console.log(xmlhttp.status, xmlhttp.statusText);
|
|
||||||
}
|
|
||||||
req(false);
|
|
||||||
};
|
|
||||||
xmlhttp.onerror = function() {
|
|
||||||
console.log(xmlhttp.status, xmlhttp.statusText);
|
|
||||||
setTimeout(req, 1000, false);
|
|
||||||
};
|
|
||||||
xmlhttp.open("GET", location.pathname + "?reload", true);
|
|
||||||
xmlhttp.send();
|
|
||||||
}
|
|
||||||
req(true);
|
|
@@ -1,25 +0,0 @@
|
|||||||
import logging
|
|
||||||
from .server import Server
|
|
||||||
from uwsgi import log, opt
|
|
||||||
class UwsgiHandler(logging.Handler):
|
|
||||||
|
|
||||||
def emit(self, record: logging.LogRecord) -> None:
|
|
||||||
log(self.formatter.format(record))
|
|
||||||
|
|
||||||
|
|
||||||
logging.basicConfig(
|
|
||||||
level=logging.INFO,
|
|
||||||
format='%(asctime)s [%(threadName)s] (%(name)s) %(levelname)s %(message)s',
|
|
||||||
handlers=[UwsgiHandler()]
|
|
||||||
)
|
|
||||||
|
|
||||||
server = Server(prefix=opt.get('prefix', None))
|
|
||||||
|
|
||||||
def application(env, start_response):
|
|
||||||
return server.handle_request(
|
|
||||||
env['REQUEST_METHOD'],
|
|
||||||
env['PATH_INFO'],
|
|
||||||
env.get('HTTP_IF_NONE_MATCH', None),
|
|
||||||
env.get('QUERY_STRING', None),
|
|
||||||
start_response
|
|
||||||
)
|
|
115
test/README.md
Normal file
115
test/README.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
## Overview
|
||||||
|
Envelope is a simple Gradle plugin that allows you to create an executable jar file
|
||||||
|
that includes all runtime dependencies and can be executed with a simple
|
||||||
|
|
||||||
|
```bash
|
||||||
|
java -jar my-app.jar
|
||||||
|
```
|
||||||
|
It supports JPMS, embedded system properties, Java agents, extra folders to be added to classpath.
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
|
||||||
|
Declare the plugin in your build's `settings.gradle` like this
|
||||||
|
```groovy
|
||||||
|
|
||||||
|
pluginManagement {
|
||||||
|
repositories {
|
||||||
|
maven {
|
||||||
|
url = 'https://woggioni.net/mvn/'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
id "net.woggioni.gradle.envelope" version "2023.09.25"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then add it to a project's `build.gradle`
|
||||||
|
|
||||||
|
```groovy
|
||||||
|
plugins {
|
||||||
|
id 'net.woggioni.gradle.envelope'
|
||||||
|
}
|
||||||
|
|
||||||
|
envelopeJar {
|
||||||
|
mainClass = 'your.main.Class'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The plugin adds 2 tasks to your project:
|
||||||
|
|
||||||
|
- `envelopeJar` of type `net.woggioni.gradle.envelope.EnvelopeJarTask` that creates the executable jar in the project's libraries folder
|
||||||
|
- `envelopeRun` of type `org.gradle.api.tasks.JavaExec` which launches the jar created by the `envelopeJar` task
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
`EnvelopeJarTask` has several properties useful for configuration purposes:
|
||||||
|
|
||||||
|
###### mainClass
|
||||||
|
|
||||||
|
This string property sets the class that will be searched for the `main` method to start the application
|
||||||
|
|
||||||
|
###### mainModule
|
||||||
|
|
||||||
|
When this string property is set, the jar file will be started in JPMS mode (if running on Java 9+) and
|
||||||
|
this module will be searched for the main class, if the `mainClass` is not set the main class specified
|
||||||
|
in the module descriptor will be loaded instead
|
||||||
|
|
||||||
|
###### systemProperties
|
||||||
|
|
||||||
|
This is a map that contains Java system properties that will be set before your application starts
|
||||||
|
|
||||||
|
###### extraClasspath
|
||||||
|
|
||||||
|
This is a list of strings representing filesystem paths that will be added to the classpath (if running in classpath mode)
|
||||||
|
or to the module path (if running in JPMS mode) when the application starts.
|
||||||
|
|
||||||
|
Relative paths and interpolation with Java System properties and environmental variables are supported:
|
||||||
|
|
||||||
|
e.g.
|
||||||
|
|
||||||
|
This looks for a `plugin` folder in the user's home directory
|
||||||
|
```
|
||||||
|
${env:HOME}/plugins
|
||||||
|
```
|
||||||
|
|
||||||
|
Same using Java system properties instead
|
||||||
|
```
|
||||||
|
${sys:user.home}/plugins
|
||||||
|
```
|
||||||
|
|
||||||
|
###### javaAgent
|
||||||
|
This is a method accepting 2 strings, the first is the Java agent classname and the second one is the java agent arguments.
|
||||||
|
It can be invoked multiple times to setup multiple java agents for the same JAR file.
|
||||||
|
All the java agents will be invoked before the application startup.
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```groovy
|
||||||
|
plugins {
|
||||||
|
id 'net.woggioni.gradle.envelope'
|
||||||
|
}
|
||||||
|
|
||||||
|
envelopeJar {
|
||||||
|
mainClass = 'your.main.Class'
|
||||||
|
mainModule = 'your.main.module'
|
||||||
|
|
||||||
|
systemProperties = [
|
||||||
|
'some.property' : 'Some value'
|
||||||
|
]
|
||||||
|
|
||||||
|
extraClasspath = ["plugins"]
|
||||||
|
|
||||||
|
javaAgent('your.java.agent.Class', 'optional agent arguments')
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
This plugin requires Gradle >= 6.0 and Java >=0 8 to build the executable jar file.
|
||||||
|
The assembled envelope jar requires and Java >= 8 to run, if only `mainClass` is specified,
|
||||||
|
if both `mainModule` and `mainClass` are specified the generated jar file will (try to) run in classpath mode on Java 8
|
||||||
|
and in JPMS mode on Java > 8.
|
||||||
|
|
||||||
|
<object data="example.dot"/>
|
27
test/example.dot
Normal file
27
test/example.dot
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
digraph D {
|
||||||
|
|
||||||
|
subgraph cluster_p {
|
||||||
|
label = "Parent";
|
||||||
|
|
||||||
|
subgraph cluster_c1 {
|
||||||
|
label = "Child one";
|
||||||
|
a;
|
||||||
|
|
||||||
|
subgraph cluster_gc_1 {
|
||||||
|
label = "Grand-Child one";
|
||||||
|
b;
|
||||||
|
}
|
||||||
|
subgraph cluster_gc_2 {
|
||||||
|
label = "Grand-Child two";
|
||||||
|
c;
|
||||||
|
d;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
subgraph cluster_c2 {
|
||||||
|
label = "Child two";
|
||||||
|
e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Reference in New Issue
Block a user