hikari-risa 1.0.0__tar.gz

hikari_risa-1.0.0/.gitignore

@@ -0,0 +1,27 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Tool caches
+.nox/
+.ruff_cache/
+.pytest_cache/
+
+# IDEs
+.idea/
+.vscode/
+
+# Secrets
+.env
+
+# Documentation site
+site/
+docs/assets/images/
+docs/generated/

hikari_risa-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hikari_risa-1.0.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.5
+Name: hikari-risa
+Version: 1.0.0
+Summary: A component handler for hikari with first-class Components V2 support.
+Project-URL: Documentation, https://rayakame.github.io/hikari-risa/
+Project-URL: Repository, https://github.com/rayakame/hikari-risa
+Project-URL: Issues, https://github.com/rayakame/hikari-risa/issues
+Project-URL: Changelog, https://rayakame.github.io/hikari-risa/stable/changelog/
+Author-email: Rayakame <github.android206@passmail.net>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: components,discord,hikari,ui
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Communications :: Chat
+Classifier: Typing :: Typed
+Requires-Python: <3.16,>=3.12
+Requires-Dist: hikari~=2.5
+Requires-Dist: linkd~=0.6
+Requires-Dist: msgspec~=0.22
+Provides-Extra: postgres
+Requires-Dist: asyncpg~=0.32; extra == 'postgres'
+Provides-Extra: radixly
+Requires-Dist: radixly~=1.0; extra == 'radixly'
+Provides-Extra: redis
+Requires-Dist: redis~=8.0; extra == 'redis'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/rayakame/hikari-risa/a14722c65c6df514d463402cde7f7f48d133bd66/assets/web/banner.webp" alt="hikari-risa" width="100%">
+</p>
+
+# Components V2 views for hikari, with state that survives restarts.
+
+risa is a component handler for [hikari](https://github.com/hikari-py/hikari), built for Components V2 first.
+A view keeps its state in the message it renders, or in a store you choose, so a click still lands where it should
+after a restart.
+
+```python
+import risa
+from risa import ui
+
+
+@risa.register(name="counter")
+class Counter(risa.View):
+    count: int = 0
+
+    def render(self) -> ui.Layout:
+        return ui.Container(
+            ui.TextDisplay(f"Clicks: **{self.count}**"),
+            ui.Row(ui.Button(self.click, label="+1")),
+        )
+
+    @risa.handler
+    async def click(self, ctx: risa.ComponentContext) -> None:
+        self.count += 1
+        await ctx.rerender()
+```
+
+## Install
+
+risa runs on Python 3.12 to 3.15.
+
+```sh
+uv add hikari-risa
+pip install hikari-risa
+```
+
+Extras: `hikari-risa[redis]`, `hikari-risa[postgres]` and `hikari-risa[radixly]`.
+
+## Documentation
+
+<https://rayakame.github.io/hikari-risa/>
+
+## License
+
+MIT, see [LICENSE](https://github.com/rayakame/hikari-risa/blob/main/LICENSE).

hikari_risa-1.0.0/README.md

@@ -0,0 +1,49 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/rayakame/hikari-risa/a14722c65c6df514d463402cde7f7f48d133bd66/assets/web/banner.webp" alt="hikari-risa" width="100%">
+</p>
+
+# Components V2 views for hikari, with state that survives restarts.
+
+risa is a component handler for [hikari](https://github.com/hikari-py/hikari), built for Components V2 first.
+A view keeps its state in the message it renders, or in a store you choose, so a click still lands where it should
+after a restart.
+
+```python
+import risa
+from risa import ui
+
+
+@risa.register(name="counter")
+class Counter(risa.View):
+    count: int = 0
+
+    def render(self) -> ui.Layout:
+        return ui.Container(
+            ui.TextDisplay(f"Clicks: **{self.count}**"),
+            ui.Row(ui.Button(self.click, label="+1")),
+        )
+
+    @risa.handler
+    async def click(self, ctx: risa.ComponentContext) -> None:
+        self.count += 1
+        await ctx.rerender()
+```
+
+## Install
+
+risa runs on Python 3.12 to 3.15.
+
+```sh
+uv add hikari-risa
+pip install hikari-risa
+```
+
+Extras: `hikari-risa[redis]`, `hikari-risa[postgres]` and `hikari-risa[radixly]`.
+
+## Documentation
+
+<https://rayakame.github.io/hikari-risa/>
+
+## License
+
+MIT, see [LICENSE](https://github.com/rayakame/hikari-risa/blob/main/LICENSE).

hikari_risa-1.0.0/pyproject.toml

@@ -0,0 +1,161 @@
+[project]
+name = "hikari-risa"
+version = "1.0.0"
+description = "A component handler for hikari with first-class Components V2 support."
+readme = "README.md"
+authors = [
+    { name = "Rayakame", email = "github.android206@passmail.net" }
+]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12,<3.16"
+keywords = ["hikari", "discord", "components", "ui"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Topic :: Communications :: Chat",
+    "Typing :: Typed",
+]
+dependencies = [
+    "hikari~=2.5",
+    "linkd~=0.6",
+    "msgspec~=0.22",
+]
+
+[project.optional-dependencies]
+postgres = [
+    "asyncpg~=0.32",
+]
+radixly = [
+    "radixly~=1.0",
+]
+redis = [
+    "redis~=8.0",
+]
+
+[project.scripts]
+hikari-risa = "risa.__main__:main"
+
+[project.urls]
+Documentation = "https://rayakame.github.io/hikari-risa/"
+Repository = "https://github.com/rayakame/hikari-risa"
+Issues = "https://github.com/rayakame/hikari-risa/issues"
+Changelog = "https://rayakame.github.io/hikari-risa/stable/changelog/"
+
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["risa"]
+
+[tool.hatch.build.targets.sdist]
+only-include = ["risa"]
+
+[dependency-groups]
+changelog = [
+    "towncrier==26.9.0",
+]
+docs = [
+    {include-group = "ruff"},
+    "griffe-inherited-docstrings==1.1.4",
+    "griffelib==2.4.1",
+    "mkdocstrings-python==2.0.10",
+    "pygments==2.21.0",
+    "radixly~=1.0",
+    "redis~=8.0",
+    "zensical==0.1.0",
+]
+nox = [
+    "nox[uv]==2026.10.20",
+]
+images = [
+    "pillow==13.0.0",
+]
+lightbulb = [
+    "hikari-lightbulb==3.2.6",
+]
+pyright = [
+    "asyncpg-stubs==0.32.0",
+    "pyright==1.1.414",
+    {include-group = "lightbulb"},
+]
+ruff = [
+    "ruff==0.17.4",
+]
+slotscheck = [
+    "asyncpg~=0.32",
+    "redis~=8.0",
+    "slotscheck==0.21.0",
+]
+pytest = [
+    {include-group = "images"},
+    "asyncpg~=0.32",
+    "fakeredis[lua]==2.40.0",
+    "griffe-inherited-docstrings==1.1.4",
+    "griffelib==2.4.1",
+    "pygments==2.21.0",
+    "pytest==9.2.0",
+    "pytest-asyncio==1.4.1.post1",
+    "radixly~=1.0",
+    "redis~=8.0",
+]
+
+[tool.towncrier]
+directory = "changes"
+filename = "CHANGELOG.md"
+start_string = "<!-- towncrier release notes start -->\n"
+title_format = "## {version} ({project_date})"
+issue_format = "[#{issue}](https://github.com/rayakame/hikari-risa/pull/{issue})"
+
+[[tool.towncrier.type]]
+directory = "breaking"
+name = "Breaking changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "deprecation"
+name = "Deprecations"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bug fixes"
+showcontent = true
+
+[tool.slotscheck]
+require-subclass = true
+strict-imports = true
+# detect-unused-slots stays off: it cannot see msgspec Structs use the slots it
+# generates for them, so every Struct in the package reports a false positive.
+
+[tool.pyright]
+include = ["risa", "tests", "tools", "docs/examples"]
+exclude = [
+    "**/__init__.py"
+]
+pythonVersion = "3.12"
+typeCheckingMode = "strict"
+
+reportUnnecessaryTypeIgnoreComment = "error"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+xfail_strict = true
+filterwarnings = [
+    "error",
+]

hikari_risa-1.0.0/risa/__init__.py

@@ -0,0 +1,49 @@
+# Copyright (c) 2025 Rayakame
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""A component handler for hikari, built on Discord's Components V2.
+
+A view is a class whose fields are its state, whose `render` returns its layout, and
+whose handlers answer the clicks on it. The state travels inside the message by
+default, so views survive restarts with no infrastructure. A view that outgrows the
+message can keep its state in a store.
+"""
+
+from __future__ import annotations
+
+from risa import codecs as codecs
+from risa import di as di
+from risa import errors as errors
+from risa import state as state
+from risa import store as store
+from risa import ui as ui
+from risa._about import __author__ as __author__
+from risa._about import __copyright__ as __copyright__
+from risa._about import __discord_invite__ as __discord_invite__
+from risa._about import __license__ as __license__
+from risa._about import __url__ as __url__
+from risa._about import __version__ as __version__
+from risa.binding import *
+from risa.client import *
+from risa.context import *
+from risa.di import *
+from risa.errors import *
+from risa.state import *
+from risa.store import *
+from risa.view import *

hikari_risa-1.0.0/risa/__main__.py

@@ -0,0 +1,145 @@
+# Copyright (c) 2025 Rayakame
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""The ``hikari-risa`` command, also ``python -m risa``: the versions a bug report needs."""
+
+from __future__ import annotations
+
+import argparse
+import ctypes
+import importlib.metadata
+import os
+import pathlib
+import platform
+import re
+import sys
+import typing
+
+import risa
+
+if typing.TYPE_CHECKING:
+    import collections.abc
+
+__all__ = ("main",)
+
+_ART: typing.Final[collections.abc.Sequence[str]] = (
+    r"         _           ",
+    r"   _____(_)________ _",
+    r"  / ___/ / ___/ __ `/",
+    r" / /  / (__  ) /_/ / ",
+    r"/_/  /_/____/\__,_/  ",
+)
+# 256-colour codes that read on dark and light terminals.
+_ART_COLOURS: typing.Final[collections.abc.Sequence[str]] = ("38;5;205", "38;5;206", "38;5;170", "38;5;134", "38;5;98")
+_PINK: typing.Final[str] = "38;5;205"
+_BOLD: typing.Final[str] = "1"
+_DIM: typing.Final[str] = "2"
+_LABEL_WIDTH: typing.Final[int] = 10
+_EXTRA: typing.Final[re.Pattern[str]] = re.compile(r"""extra\s*==\s*["']([^"']+)["']""")
+_STD_OUTPUT_HANDLE: typing.Final[int] = -11
+_ENABLE_VIRTUAL_TERMINAL_PROCESSING: typing.Final[int] = 0x0004
+
+type _Paint = collections.abc.Callable[[str, str], str]
+
+
+def _escape_codes_work() -> bool:
+    # A Windows console reads escape codes only once the program turns on virtual terminal processing.
+    if sys.platform != "win32":
+        return True
+    kernel32 = ctypes.WinDLL("kernel32")
+    kernel32.GetStdHandle.restype = ctypes.c_void_p
+    kernel32.GetConsoleMode.argtypes = (ctypes.c_void_p, ctypes.POINTER(ctypes.c_uint32))
+    kernel32.SetConsoleMode.argtypes = (ctypes.c_void_p, ctypes.c_uint32)
+    handle = kernel32.GetStdHandle(_STD_OUTPUT_HANDLE)
+    mode = ctypes.c_uint32()
+    if not kernel32.GetConsoleMode(handle, ctypes.byref(mode)):
+        return False
+    return bool(kernel32.SetConsoleMode(handle, mode.value | _ENABLE_VIRTUAL_TERMINAL_PROCESSING))
+
+
+def _section(
+    paint: _Paint, label: str, rows: collections.abc.Sequence[collections.abc.Sequence[str]]
+) -> collections.abc.Iterator[str]:
+    # The last column goes unpadded, so it may carry colour codes without breaking the alignment.
+    widths = [max(len(row[column]) for row in rows) for column in range(len(rows[0]) - 1)] if rows else []
+    for index, row in enumerate(rows):
+        cells = [cell.ljust(width) for cell, width in zip(row, widths, strict=False)]
+        heading = paint((label if index == 0 else "").ljust(_LABEL_WIDTH), _PINK)
+        yield f"  {heading}{'  '.join([*cells, row[-1]])}"
+
+
+def _report(*, colour: bool) -> collections.abc.Iterator[str]:
+    def paint(text: str, style: str) -> str:
+        return f"\x1b[{style}m{text}\x1b[0m" if colour else text
+
+    for line, style in zip(_ART[:-1], _ART_COLOURS, strict=False):
+        yield paint(line.rstrip(), style)
+    yield paint(_ART[-1], _ART_COLOURS[-1]) + paint(f"hikari-risa {risa.__version__}", _BOLD)
+
+    metadata = importlib.metadata.metadata("hikari-risa")
+    urls = dict(url.split(", ", 1) for url in metadata.get_all("Project-URL") or ())
+    required: list[collections.abc.Sequence[str]] = []
+    extras: list[collections.abc.Sequence[str]] = []
+    for requirement in importlib.metadata.requires("hikari-risa") or ():
+        name = re.split(r"[^\w.-]", requirement, maxsplit=1)[0]
+        try:
+            version = importlib.metadata.version(name)
+        except importlib.metadata.PackageNotFoundError:
+            version = paint("not installed", _DIM)
+        if extra := _EXTRA.search(requirement):
+            extras.append((extra[1], name, version))
+        else:
+            required.append((name, version))
+
+    yield ""
+    yield paint(metadata["Summary"], _DIM)
+    yield ""
+    yield from _section(paint, "python", [(f"{platform.python_implementation()} {platform.python_version()}",)])
+    yield from _section(paint, "platform", [(platform.platform(),)])
+    yield from _section(paint, "location", [(str(pathlib.Path(risa.__file__).parent),)])
+    yield ""
+    yield from _section(paint, "requires", required)
+    yield ""
+    yield from _section(paint, "extras", extras)
+    yield ""
+    yield from _section(paint, "docs", [(urls["Documentation"],)])
+    yield from _section(paint, "issues", [(urls["Issues"],)])
+
+
+def main() -> None:
+    """Print the versions of risa, of Python and of the packages risa installs."""
+    parser = argparse.ArgumentParser(
+        prog="hikari-risa", description="Print the versions of risa, Python and what risa installs, for a bug report."
+    )
+    parser.add_argument("--version", action="version", version=f"hikari-risa {risa.__version__}")
+    parser.parse_args()
+    colour = (
+        sys.stdout.isatty()
+        and not os.environ.get("NO_COLOR")
+        and os.environ.get("TERM") != "dumb"
+        and _escape_codes_work()
+    )
+    report = "\n".join(_report(colour=colour)) + "\n"
+    # Before 3.15 a Windows pipe writes in the ANSI code page, which may lack a character of the path.
+    encoding = sys.stdout.encoding or "utf-8"
+    sys.stdout.write(report.encode(encoding, "backslashreplace").decode(encoding))
+
+
+if __name__ == "__main__":
+    main()

hikari_risa-1.0.0/risa/_about.py

@@ -0,0 +1,31 @@
+# Copyright (c) 2025 Rayakame
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Package metadata, re-exported by `risa`."""
+
+from __future__ import annotations
+
+import typing
+
+__author__: typing.Final[str] = "Rayakame"
+__copyright__: typing.Final[str] = "2025, Rayakame"
+__discord_invite__: typing.Final[str] = "https://discord.gg/Jx4cNGG"
+__url__: typing.Final[str] = "https://github.com/rayakame/hikari-risa"
+__version__: typing.Final[str] = "1.0.0"
+__license__: typing.Final[str] = "MIT"