Adapter Module

class TagScriptEngine.adapter.SafeObjectAdapter(base)[source]

Bases: Adapter

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

class TagScriptEngine.adapter.StringAdapter(string: str, *, escape: bool = False)[source]

Bases: Adapter

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

class TagScriptEngine.adapter.IntAdapter(integer: int)[source]

Bases: Adapter

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

class TagScriptEngine.adapter.FunctionAdapter(function_pointer: Callable[[], str])[source]

Bases: Adapter

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

class TagScriptEngine.adapter.AttributeAdapter(**kwargs: ~typing.~_P)[source]

Bases: Adapter

Deprecated since version 3.2.0: AttributeAdapter has been deprecated and will be removed in favor of TagScriptEngine.adapter.discordadpaters.DiscordAttributeAdapter or consider using TagScriptEngine.interface.adapter.SimpleAdapter instead.

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

Bases: DiscordAttributeAdapter

The {user} block with no parameters returns the user’s full username, but passing the attributes listed below to the block payload will return that attribute instead.

Usage: {user([attribute])}

Payload: None

Parameter: attribute, None

id: The user’s Discord ID.

name: The user’s username.

nick: The user’s nickname, if they have one, else their username.

avatar: A link to the user’s avatar, which can be used in embeds.

created_at: The user’s account creation date.

timestamp: The user’s account creation date as UTC timestamp.

mention: A formatted text that ping’s the user.

bot: Wheather or not the user is a bot.

accent_color: The user’s accent color if banner is not present.

avatar_decoration: A link to the user’s avatar decoration.

Bases: DiscordAttributeAdapter

The {author} block with no parameters returns the tag invoker’s full username and discriminator, but passing the attributes listed below to the block payload will return that attribute instead.

Aliases: user

Usage: {author([attribute])

Payload: None

Parameter: attribute, None

id: The author’s Discord ID.

name: The author’s username.

nick: The author’s nickname, if they have one, else their username.

avatar: A link to the author’s avatar, which can be used in embeds.

discriminator: The author’s discriminator.

created_at: The author’s account creation date.

timestamp: The author’s account creation date as a UTC timestamp.

joined_at: The date the author joined the server.

joinstamp: The author’s join date as a UTC timestamp.

mention: A formatted text that pings the author.

bot: Whether or not the author is a bot.

color: The author’s top role’s color as a hex code.

top_role: The author’s top role.

roleids: A list of the author’s role IDs, split by spaces.

boost: If the user has boosted, this will be the UTC timestamp of when they did, if not this will be empty.

timed_out: If the user is currently timed out, the datetime of when the timeout ends; otherwise False.

banner: The user’s banner url, if available. A banner is not delivered over the gateway, so the bare engine only sees it when the member was retrieved via an explicit REST fetch - otherwise this is empty for cached members. The Tags cog resolves it lazily (fetching only when a tag uses banner, with caching and a per-user cooldown), so there it is populated on demand.

Bases: DiscordAttributeAdapter

The {channel} block with no parameters returns the channel’s full name but passing the attributes listed below to the block payload will return the attribute instead.

Usage: {channel([attribute])

Payload: None

Parameter: attribute, None

id: The channel’s ID.

name: The channel’s name.

created_at: The channel’s creation date.

timestamp: The channel’s creation date as a UTC timestamp.

jump_url: A link to the channel.

Bases: DiscordAttributeAdapter

The {channel} block with no parameters returns the channel’s full name but passing the attributes listed below to the block payload will return that attribute instead.

Usage: {channel([attribute])

Payload: None

Parameter: attribute, None

id: The channel’s ID.

name: The channel’s name.

created_at: The channel’s creation date.

timestamp: The channel’s creation date as a UTC timestamp.

nsfw: Whether the channel is nsfw.

mention: A formatted text that pings the channel.

topic: The channel’s topic.

category_id: The category the channel is associated with. If no category channel, this will return empty.

jump_url: A link to the channel.

Bases: DiscordAttributeAdapter

The {server} block with no parameters returns the server’s name but passing the attributes listed below to the block payload will return that attribute instead.

Aliases: guild

Usage: {server([attribute])

Payload: None

Parameter: attribute, None

id: The server’s ID.

name: The server’s name.

icon: A link to the server’s icon, which can be used in embeds.

created_at: The server’s creation date.

timestamp: The server’s creation date as a UTC timestamp.

member_count: The server’s member count.

bots: The number of bots in the server.

humans: The number of humans in the server.

description: The server’s description if one is set, or “No description”.

random: A random member from the server.

vanity: If guild has a vanity, this returns the vanity else empty.

owner_id: The server owner’s id.

mfa: The server’s mfa level.

boosters: The server’s active booster count.

boost_level: The server’s current boost level/tier.

discovery_splash: A link to the server’s discovery splash.

invite_splash: A link to the server’s invite splash.

banner: A link to the server’s banner.

Bases: DiscordAttributeAdapter

The {role} block with no parameters returns the role’s full name but passing the attributes listed below to the block payload will return that attribute instead.

Usage: {role([attribute])}

Payload: None

Parameter: attribute, None

id: The role’s ID.

name: The role’s name.

created_at: The role’s creation date.

timestamp: The role’s creation date as a UTC timestamp.

color: The role’s color.

display_icon: The role’s icon.

hoist: Wheather the role is hoisted or not.

managed: Wheather the role is managed or not.

mention: A formatted text that pings the role.

position: The role’s position.

class TagScriptEngine.adapter.DiscordObjectAdapter(base: Object)[source]

Bases: Adapter

The {object} block with no parameters returs the discord object’s ID, but passing the attributes listed below to the block payload will return that attribute instead.

Usage: {object([attribute])}

Payload: None

Parameter: attribute, None

id: The object’s Discord ID.

created_at: The object’s creation date.

timestamp: The object’s creation date as a UTC timestamp.

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

class TagScriptEngine.adapter.RedCommandAdapter(base: redbot.core.commands.Command, *, signature: str | None = None)[source]

Bases: SimpleAdapter[Command]

The {commandinfo} block reads a command’s metadata and returns it as text. Unlike the Command Block, it does not run the command. See the attribute list below.

Usage: {commandinfo([attribute]):<command>}

Payload: command (supplied by the block)

Parameter: attribute, None

name: The command’s name.

qualified_name: The command’s full name, including any parent groups.

cog_name: The name of the cog the command belongs to.

description: The command’s description. Most commands leave this unset, so it falls back to the help text’s first line (short_doc) when empty.

short_doc: The first line of the command’s help text.

help: The command’s full help text (its docstring).

aliases: The command’s aliases, or None if it has none.

signature: The command’s argument signature. Empty for commands that take no arguments.

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.

class TagScriptEngine.adapter.RedBotAdapter(base: redbot.core.bot.Red, *, owner: bool = True)[source]

Bases: SimpleAdapter[Red]

The {bot} block with no parameters returns the bot’s name & discriminator, but passing the attributes listed below to the block payload will return that attribute instead.

Usage: {bot([attribute])}

Payload: None

Parameter: attribute, None

id: The bot’s Discord ID.

name: The bot’s username.

discriminator: The bot’s discriminator.

nick: The bot’s global display name. This is not a per-server nickname: the bot user has no guild context here, so a server-specific nick is not available through this block.

created_at: The bot’s creation date.

timestamp: The bot’s creation date as a UTC timestamp.

mention: A formatted text that pings the bot.

avatar: A link to the bot’s avatar, which can be used in embeds.

verified: If the bot is verified or not.

shard_count(*): The bot’s total shard count.

servers(*): Total server/guild count of the bot.

channels(*): Total number of channels visible to the bot.

visible_users(*): Total number of users visible to the bot.

total_users(*): The bot’s total user count.

unique_users(*): The bot’s unique user count.

percentage_chunked(*): Percentage of the bot’s members that are cached/chunked (rounded to two decimals); 0 when no member counts are available.

Attributes marked ``(*)`` are owner-only and return nothing for other users.

get_value(ctx: Verb) → str[source]

Processes the adapter’s actions for a given Context.

Subclasses must implement this.

Parameters:: ctx (Verb) – The context object containing the TagScript Verb.
Returns:: The adapters’s processed value.
Return type:: Optional[str]
Raises:: NotImplementedError – The subclass did not implement this required method.