Skip to content

tux.cogs.fun.xkcd

Classes:

Name Description
Xkcd

Classes

Xkcd(bot: Tux)

Bases: Cog

Methods:

Name Description
xkcd

xkcd related commands.
latest

Get the latest xkcd comic.
random

Get a random xkcd comic.
specific

Get a specific xkcd comic.
get_comic_and_embed

Get the xkcd comic and create an embed.
Source code in tux/cogs/fun/xkcd.py
Python
def __init__(self, bot: Tux) -> None:
    self.bot = bot
    self.client = xkcd.Client()
    self.xkcd.usage = generate_usage(self.xkcd)
    self.latest.usage = generate_usage(self.latest)
    self.random.usage = generate_usage(self.random)
    self.specific.usage = generate_usage(self.specific)

Functions

xkcd(ctx: commands.Context[Tux], comic_id: int | None = None) -> None async

xkcd related commands.

Parameters:

Name Type Description Default
ctx Context[Tux]

The context object for the command.

 required
comic_id int | None

The ID of the xkcd comic to search for.

 None
Source code in tux/cogs/fun/xkcd.py
Python
@commands.hybrid_group(
    name="xkcd",
    aliases=["xk"],
)
@commands.guild_only()
async def xkcd(self, ctx: commands.Context[Tux], comic_id: int | None = None) -> None:
    """
    xkcd related commands.

    Parameters
    ----------
    ctx : commands.Context[Tux]
        The context object for the command.
    comic_id : int | None
        The ID of the xkcd comic to search for.
    """

    if comic_id:
        await self.specific(ctx, comic_id)
    else:
        await ctx.send_help("xkcd")
latest(ctx: commands.Context[Tux]) -> None async

Get the latest xkcd comic.

Parameters:

Name Type Description Default
ctx Context[Tux]

The context object for the command.

 required
Source code in tux/cogs/fun/xkcd.py
Python
@xkcd.command(
    name="latest",
    aliases=["l", "new", "n"],
)
@commands.guild_only()
async def latest(self, ctx: commands.Context[Tux]) -> None:
    """
    Get the latest xkcd comic.

    Parameters
    ----------
    ctx : commands.Context[Tux]
        The context object for the command.
    """

    embed, view, ephemeral = await self.get_comic_and_embed(latest=True)

    if view:
        await ctx.send(embed=embed, view=view, ephemeral=ephemeral)
    else:
        await ctx.send(embed=embed, ephemeral=ephemeral)
random(ctx: commands.Context[Tux]) -> None async

Get a random xkcd comic.

Parameters:

Name Type Description Default
ctx Context[Tux]

The context object for the

 required
Source code in tux/cogs/fun/xkcd.py
Python
@xkcd.command(
    name="random",
    aliases=["rand", "r"],
)
@commands.guild_only()
async def random(self, ctx: commands.Context[Tux]) -> None:
    """
    Get a random xkcd comic.

    Parameters
    ----------
    ctx : commands.Context[Tux]
        The context object for the
    """

    embed, view, ephemeral = await self.get_comic_and_embed()

    if view:
        await ctx.send(embed=embed, view=view, ephemeral=ephemeral)
    else:
        await ctx.send(embed=embed, ephemeral=ephemeral)
specific(ctx: commands.Context[Tux], comic_id: int) -> None async

Get a specific xkcd comic.

Parameters:

Name Type Description Default
ctx Context[Tux]

The context object for the command.

 required
comic_id int

The ID of the comic to search for.

 required
Source code in tux/cogs/fun/xkcd.py
Python
@xkcd.command(
    name="specific",
    aliases=["s", "id", "num"],
)
@commands.guild_only()
async def specific(self, ctx: commands.Context[Tux], comic_id: int) -> None:
    """
    Get a specific xkcd comic.

    Parameters
    ----------
    ctx : commands.Context[Tux]
        The context object for the command.
    comic_id : int
        The ID of the comic to search for.
    """

    embed, view, ephemeral = await self.get_comic_and_embed(number=comic_id)

    if view:
        await ctx.send(embed=embed, view=view, ephemeral=ephemeral)
    else:
        await ctx.send(embed=embed, ephemeral=ephemeral)
get_comic_and_embed(latest: bool = False, number: int | None = None) -> tuple[discord.Embed, discord.ui.View | None, bool] async

Get the xkcd comic and create an embed.

Source code in tux/cogs/fun/xkcd.py
Python
async def get_comic_and_embed(
    self,
    latest: bool = False,
    number: int | None = None,
) -> tuple[discord.Embed, discord.ui.View | None, bool]:
    """
    Get the xkcd comic and create an embed.
    """
    try:
        if latest:
            comic = self.client.get_latest_comic(raw_comic_image=True)
        elif number:
            comic = self.client.get_comic(number, raw_comic_image=True)
        else:
            comic = self.client.get_random_comic(raw_comic_image=True)

        embed = EmbedCreator.create_embed(
            bot=self.bot,
            embed_type=EmbedCreator.INFO,
            title="",
            description=f"\n\n> {comic.description.strip()}" if comic.description else "",
            custom_author_text=f"xkcd {comic.id} - {comic.title}",
            image_url=comic.image_url,
        )

        ephemeral = False

    except xkcd.HttpError:
        logger.error("HTTP error occurred while fetching xkcd comic")
        embed = EmbedCreator.create_embed(
            bot=self.bot,
            embed_type=EmbedCreator.ERROR,
            description="I couldn't find the xkcd comic. Please try again later.",
        )
        ephemeral = True
        return embed, None, ephemeral

    except Exception as e:
        logger.error(f"Error getting xkcd comic: {e}")
        embed = EmbedCreator.create_embed(
            bot=self.bot,
            embed_type=EmbedCreator.ERROR,
            description="An error occurred while fetching the xkcd comic",
        )
        ephemeral = True
        return embed, None, ephemeral

    else:
        return (
            embed,
            XkcdButtons(str(comic.explanation_url), str(comic.comic_url)),
            ephemeral,
        )

Functions