Lib Base Object

The generic feature class which all Lib’s should subclass

class antispam.libs.shared.base.Base(handler: AntiSpamHandler)

A base Library feature class which implements shared functionality.

__init__(handler: AntiSpamHandler)

check_if_message_is_from_a_bot(message) → bool

Given a message object, return if it was sent by a bot

Parameters

message – Your libraries message object

Returns

True if the message is from a bot else false

Return type

bool

Warning

Lib classes must implement this.

async check_message_can_be_propagated(message) → antispam.dataclasses.propagate_data.PropagateData

async dict_to_embed(data: dict, message, warn_count: int, kick_count: int)

async dict_to_lib_embed(data: Dict)

Parameters

data (dict) – The embed as a dictionary, used to build a an embed object for your library.

Returns

Your libraries embed object.

Return type

Any

Warning

Lib classes must implement this.

async does_author_have_kick_and_ban_perms(message) → bool

Given a message object, return if the author has both kick and ban perms

Parameters

message – Your libraries message object

Returns

True if the author has them else False

Return type

bool

Warning

Lib classes must implement this.

async embed_to_string(embed) → str

get_author_id_from_message(message) → int

Given a message object, return the authors id.

Parameters

message – Your libraries message object

Returns

The author’s id

Return type

int

Warning

Lib classes must implement this.

get_author_name_from_message(message) → str

Given a message object, return the authors name.

Parameters

message – Your libraries message object

Returns

The author’s name

Return type

str

Warning

Lib classes must implement this.

get_bot_id_from_message(message) → int

Given a message object, return this bots id.

Parameters

message – Your libraries message object

Returns

The bot’s id

Return type

int

Warning

Lib classes must implement this.

get_channel_id_from_message(message) → int

Given a message object, return the channel id.

Parameters

message – Your libraries message object

Returns

The channel id

Return type

int

Warning

Lib classes must implement this.

get_expected_message_type()

Return the expected type of your libraries message.

I.e. discord.Message

Warning

Lib classes must implement this.

get_guild_id_from_message(message) → Optional[int]

Given a message object, return the guilds id.

Parameters

message – Your libraries message object

Returns

• int – The guild’s id

• None – This message is not in a guild

Warning

Lib classes must implement this.

get_message_id_from_message(message) → int

Given a message object, return the message id.

Parameters

message – Your libraries message object

Returns

The message id

Return type

int

Warning

Lib classes must implement this.

get_role_ids_for_message_author(message) → List[int]

Given a message object, return the role ids for the author

Parameters

message – Your libraries message object

Returns

A list of role ids, empty list if you can’t get any

Return type

List[int]

Warning

Lib classes must implement this.

async get_substitute_args(message) → antispam.libs.shared.substitute_args.SubstituteArgs

Parameters

message – Message used to create SubstituteArgs

Returns

Return type

SubstituteArgs

Warning

Lib classes must implement this.

async lib_embed_as_dict(embed) → Dict

Parameters

embed – Your libraries embed object.

Returns

The embed in dict form

Return type

dict

Warning

Lib classes must implement this.

async substitute_args(content, message, warn_count: int, kick_count: int) → str

async transform_message(content: Union[str, dict], message, warn_count: int, kick_count: int)

async visualizer(content: str, message, warn_count: int = 1, kick_count: int = 2)