Stateless component manager for hikari with type-safe API.
Project description
Flare
A stateless component manager for hikari with a type-safe API.
Features:
- buttons, select menus, and modals
- easy and powerful API for simple interactions
- saves data between bot restarts by utilizing the component's custom id
If you want to create complex component interactions hikari-miru may be a better choice.
Installation
pip install hikari-flare
Links
Example
import flare
import hikari
@flare.button(label="Test Button", style=hikari.ButtonStyle.PRIMARY)
async def test_button(
ctx: flare.MessageContext,
) -> None:
await ctx.respond(content="Hello World!")
@flare.button(label="State Button", style=hikari.ButtonStyle.PRIMARY)
async def state_button(
ctx: flare.MessageContext,
# Args and kwargs are used for state.
number: int,
) -> None:
await ctx.respond(content=f"The number is: {number}")
bot = hikari.GatewayBot("...")
flare.install(bot)
@bot.listen()
async def buttons(event: hikari.GuildMessageCreateEvent) -> None:
# Ignore other bots or webhooks pinging us
if not event.is_human:
return
me = bot.get_me()
# If the bot is mentioned
if me.id in event.message.user_mentions_ids:
# Set custom state for components that need it
row = await flare.Row(test_button(), state_button(5))
message = await event.message.respond("Hello Flare!", component=row)
bot.run()
The API can also be accessed at a lower level if components need typed attributes.
class Button(flare.Button):
a: int
b: str
async def callback(self, ctx: flare.Context) -> None:
typing_extensions.reveal_type(self.a) # int
typing_extensions.reveal_type(self.b) # str
await ctx.respond("Hello flare!")
Converters
Converters allow you to serialize and deserialize types. Here in an example of an int converter.
Converters for int
, str
, typing.Literal
, and enum.Enum
are built in.
class IntConverter(Converter[int]):
async def to_str(self, obj: int) -> str:
return str(obj)
async def from_str(self, obj: str) -> int:
return int(obj)
flare.add_converter(
int, # The typehint this converter is used for.
IntConverter # The converter class.
)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
hikari-flare-0.1.0.tar.gz
(33.5 kB
view hashes)
Built Distribution
Close
Hashes for hikari_flare-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4ac16aeccc2db05431e5ca871e681d50016eb559a6b4743527f1b9cf971e483 |
|
MD5 | 31510775b21e8f7f19d7f2e5bd0fe547 |
|
BLAKE2b-256 | 06058f9055b159a512d25bf1c1bd5fa33750b303ec766137c8fc04b1ad0bd774 |