Skip to content

Injection#

Below is an explanation of how ongaku supports injection.

support

Please note, that only the command handlers tanjun and arc are currently supported with ongaku's dependency injection.

Ongaku relies on the framework alluka for its dependency injection support.

First of all, for the injection to work, you need to use .from_arc() client creation

1
2
3
bot = hikari.GatewayBot(...)
client = arc.GatewayClient(bot)
ongaku_client = ongaku.Client.from_arc(client)

lets explain what each line does.

1
bot = hikari.GatewayBot(...)

This line simply sets up your GatewayBot.

2
client = arc.GatewayClient(bot)

This sets up the arc client (your command handler.)

3
ongaku_client = ongaku.Client.from_arc(client)

Finally, this sets up ongaku's client.

Now, there is a few ways to use ongaku's client.

The first method is good for creating players, and fetching new songs.

1
2
3
4
5
6
@arc.slash_command("example", "This is an example command")
async def example_command(
    ctx: arc.GatewayContext,
    ongaku_client: ongaku.Client = arc.Inject()
) -> None:
    ...

Now, if you just wish to get a player directly without having to fetch it you need to do a couple things.

Firstly, you need to import the arc version of ongaku:

pip install ongaku[arc]

Then, you can do the following:

This method requires a player.

1
2
3
4
5
6
7
8
9
from ongaku.ext import injection

@arc.with_hook(injection.arc_ensure_player)
@arc.slash_command("example", "This is an example command")
async def example_command(
    ctx: arc.GatewayContext,
    player: ongaku.Player = arc.Inject()
) -> None:
    ...

This method allows for an optional player.

1
2
3
4
5
6
@arc.slash_command("example", "This is an example command")
async def example_command(
    ctx: arc.GatewayContext,
    player: ongaku.Player | None = arc.Inject()
) -> None:
    ...

You can still get the client from a player, simply by using player.client

First of all, for the injection to work, you need to use .from_tanjun() client creation

1
2
3
bot = hikari.GatewayBot(...)
client = tanjun.Client.from_gateway_bot(bot)
ongaku_client = ongaku.Client.from_tanjun(client)

lets explain what each line does.

1
bot = hikari.GatewayBot(...)

This line simply sets up your GatewayBot.

2
client = tanjun.Client.from_gateway_bot(bot)

This sets up the tanjun client (your command handler.)

3
ongaku_client = ongaku.Client.from_tanjun(client)

Finally, this sets up ongaku's client.

1
2
3
4
5
6
@tanjun.as_slash_command("name", "description")
async def some_command(
    ctx: tanjun.abc.SlashContext,
    ongaku_client: ongaku.Client = alluka.inject()
) -> None:
    ...

Warning

Tanjun does not currently support player injection.