Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Add Bottle adapter, example, and tests#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahmedlemine wants to merge 1 commit into
base:develop
Choose a base branch
from
Open

Add Bottle adapter, example, and tests #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions examples/bottle/app.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
import time
from datetime import datetime
from bottle import route, run, template
from datastar_py.bottle import ServerSentEventGenerator, datastar_response


html = """\
<!DOCTYPE html>
<html lang="en">
<head>
<title>DATASTAR on Bottle (WSGI)</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<script type="module" src="https://cdn.jsdelivr.net/gh/starfederation/datastar@v1.0.2/bundles/datastar.js"></script>
<style>
html, body { height: 100%; width: 100%; }
body { background-image: linear-gradient(to right bottom, oklch(0.424958 0.052808 253.972015), oklch(0.189627 0.038744 264.832977)); }
.container { display: grid; place-content: center; }
.time { padding: 2rem; border-radius: 8px; margin-top: 3rem; font-family: monospace, sans-serif; background-color: oklch(0.916374 0.034554 90.5157); color: oklch(0.265104 0.006243 0.522862 / 0.6); font-weight: 600; }
</style>
</head>
<body
data-signals="{currentTime: 'CURRENT_TIME'}"
>
<div class="container">
<div
class="time"
data-init="@get('/updates/')"
>
Current time from element: <span id="currentTime">CURRENT_TIME</span>
</div>
<div
class="time"
>
Current time from signal: <span data-text="$currentTime">CURRENT_TIME</span>
</div>
</div>
</body>
</html>
"""


@route("/")
def home():
return template(html.replace("CURRENT_TIME", f"{datetime.isoformat(datetime.now())}"))


@route("/updates/")
@datastar_response
def updates():
while True:
yield ServerSentEventGenerator.patch_elements(
f"""<span id="currentTime">{datetime.now().isoformat()}"""
)

time.sleep(0.5)

yield ServerSentEventGenerator.patch_signals({"currentTime": datetime.now().isoformat()})

time.sleep(0.5)


if __name__ == "__main__":
run(host="localhost", port=8080)
91 changes: 91 additions & 0 deletions src/datastar_py/bottle.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
from __future__ import annotations

from collections.abc import Callable, Mapping
from functools import wraps
from typing import Any, ParamSpec

from bottle import HTTPResponse
from bottle import request as _request

from . import _read_signals
from .sse import (
SSE_HEADERS,
DatastarEvent,
DatastarEvents,
ServerSentEventGenerator,
)

__all__ = [
"SSE_HEADERS",
"DatastarResponse",
"ServerSentEventGenerator",
"datastar_response",
"read_signals",
]


class DatastarResponse(HTTPResponse):
"""Respond with 0..N `DatastarEvent`s.

Bottle natively streams iterable response bodies, so generators are
passed through unchanged and consumed as they produce events.
"""

default_headers: dict[str, str] = SSE_HEADERS.copy()

def __init__(
self,
content: DatastarEvents = None,
*,
status: int | None = None,
headers: Mapping[str, str] | None = None,
) -> None:
if content is None:
status = status or 204
content = ""
headers = headers or {}
else:
status = status or 200
headers = {**self.default_headers, **(headers or {})}

if isinstance(content, DatastarEvent):
content = (content,)

super().__init__(
body=content,
status=status,
headers=headers,
)


P = ParamSpec("P")


def datastar_response(
func: Callable[P, DatastarEvents],
) -> Callable[P, DatastarResponse]:
"""Wrap a route callback's result in a `DatastarResponse`.

The wrapped function may return a single event, an iterable of events,
or a generator yielding events.
"""

@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> DatastarResponse:
return DatastarResponse(func(*args, **kwargs))

wrapper.__annotations__["return"] = DatastarResponse
return wrapper


def read_signals() -> dict[str, Any] | None:
body = _request.body
if hasattr(body, "read"):
body = body.read()

return _read_signals(
_request.method,
_request.headers,
_request.query,
body,
)
5 changes: 5 additions & 0 deletions tests/test_decorator_matrix.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
("fastapi", "datastar_py.fastapi", "body_iterator"),
("litestar", "datastar_py.litestar", "iterator"),
("django", "datastar_py.django", None),
("bottle", "datastar_py.bottle", None),
# Quart and Sanic need full request contexts; covered elsewhere
("quart", "datastar_py.quart", None),
("sanic", "datastar_py.sanic", None),
Expand DownExpand Up@@ -65,6 +66,10 @@ async def test_datastar_response_matrix(
"""Ensure decorator works for sync/async and generator/non-generator functions."""
if framework_name in {"quart", "sanic"}:
pytest.skip(f"{framework_name} decorator requires full request context to exercise")

if framework_name == "bottle" and variant in {"async_value", "async_generator"}:
pytest.skip("Bottle is synchronous and does not support async route callbacks")

if framework_name == "django":
from django.conf import settings

Expand Down