Client as State

The miru Client is the centerpiece of the library, it starts & manages all views and modals, routes interactions to them, etc... However, when working with a larger codebase, it can get quite complicated to pass the client around to all the places that need it.

This guide tries to cover some ways you can manage your miru client as state using popular command handlers, so it is always available when you need it.

arccrescentlightbulbtanjun

GatewayREST

The miru client is automatically set as a type dependency when creating your client using Client.from_arc().

bot = hikari.GatewayBot(...)
arc_client = arc.GatewayClient(bot)
# The miru client is automatically set as a type dependency
client = miru.Client.from_arc(arc_client)

Somewhere else in your code:

@arc.slash_command("name", "description")
# Inject the miru client as normal
async def some_command(ctx: arc.GatewayContext, client: miru.Client = arc.inject()) -> None:
    view = miru.View(...)
    await ctx.respond(..., components=view)
    client.start_view(view)

The miru client is automatically set as a type dependency when creating your client using Client.from_arc().

bot = hikari.RESTBot(...)
arc_client = arc.RESTClient(bot)
# The miru client is automatically set as a type dependency
client = miru.Client.from_arc(arc_client)

Somewhere else in your code:

@arc.slash_command("name", "description")
# Inject the miru client as normal
async def some_command(ctx: arc.RESTContext, client: miru.Client = arc.inject()) -> None:
    view = miru.View(...)
    await ctx.respond(..., components=view)
    client.start_view(view)

To learn more about dependency injection in arc, see here.

GatewayREST

The recommended way to manage state in crescent is using a model:

@dataclasses.dataclass
class MyModel:
    miru: miru.Client

bot = hikari.GatewayBot(...)
client = miru.Client(bot)
crescent_client = crescent.Client(bot, MyModel(client))

Somewhere else in your code:

@crescent.command("name", "description")
class SomeCommand:
    async def callback(self, ctx: crescent.Context) -> None:
        view = miru.View(...)
        await ctx.respond(..., components=view)
        # Access the miru client from the model
        ctx.client.model.miru.start_view(view)

The recommended way to manage state in crescent is using a model:

@dataclasses.dataclass
class MyModel:
    miru: miru.Client

bot = hikari.RESTBot(...)
client = miru.Client(bot)
crescent_client = crescent.Client(bot, MyModel(client))

Somewhere else in your code:

@crescent.command("name", "description")
class SomeCommand:
    async def callback(self, ctx: crescent.Context) -> None:
        view = miru.View(...)
        await ctx.respond(..., components=view)
        # Access the miru client from the model
        ctx.client.model.miru.start_view(view)

To learn more about models in crescent, see here.

The recommended way to manage state in lightbulb is via a DataStore object.

bot = lightbulb.BotApp(...)
# Save the client to the bot's DataStore
bot.d.miru = miru.Client(bot)

Somewhere else in your code:

@lightbulb.command("name", "description", auto_defer=False)
@lightbulb.implements(lightbulb.SlashCommand)
async def some_command(ctx: lightbulb.SlashContext) -> None:
    view = miru.View(...)
    await ctx.respond(..., components=view)

    # Access the miru client from the DataStore
    ctx.app.d.miru.start_view(view)

To learn more about DataStore, see here.

GatewayREST

The miru client is automatically set as a type dependency when creating your client using Client.from_tanjun().

bot = hikari.GatewayBot(...)
tanjun_client = tanjun.Client.from_gateway_bot(bot)
# The miru client is automatically set as a type dependency
client = miru.Client.from_tanjun(tanjun_client)

Somewhere else in your code:

@tanjun.as_slash_command("name", "description")
# Inject the miru client as normal
async def some_command(ctx: tanjun.abc.SlashContext, client: miru.Client = alluka.inject()) -> None:
    view = miru.View(...)
    await ctx.respond(..., components=view)
    client.start_view(view)

The miru client is automatically set as a type dependency when creating your client using Client.from_tanjun().

bot = hikari.RESTBot(...)
tanjun_client = tanjun.Client.from_rest_bot(bot)
# The miru client is automatically set as a type dependency
client = miru.Client.from_tanjun(tanjun_client)

Somewhere else in your code:

@tanjun.as_slash_command("name", "description")
# Inject the miru client as normal
async def some_command(ctx: tanjun.abc.SlashContext, client: miru.Client = alluka.inject()) -> None:
    view = miru.View(...)
    await ctx.respond(..., components=view)
    client.start_view(view)

To learn more about dependency injection in Tanjun, see here.

Tip

If you're not using a command handler, a good way to manage state (such as the miru client) can be through dependency injection. You can use a library like alluka for this.