Option’s Reference

This class represents the Options for both Guilds and the AntiSpamHandler itself. It is important to become familiar with this dataclass.

Options can be set in two ways:

• Set when creating a new object Options(no_punish=True)
• Set using an existing object Options.no_punish = True

For more in depth meanings and explanations, please see the primary docstring of antispam.AntiSpamHandler

class antispam.dataclasses.options.Options(*, warn_threshold: int = 3, kick_threshold: int = 2, ban_threshold: int = 2, message_interval: int = 30000, message_duplicate_count: int = 5, message_duplicate_accuracy: int = 90, guild_ban_message_delete_after: int = None, guild_kick_message_delete_after: int = None, member_ban_message_delete_after: int = None, guild_warn_message_delete_after: int = None, member_kick_message_delete_after: int = None, guild_warn_message: Union[str, dict] = '$MEMBERNAME was warned for spamming/sending duplicate messages.', guild_kick_message: Union[str, dict] = '$MEMBERNAME was kicked for spamming/sending duplicate messages.', guild_ban_message: Union[str, dict] = '$MEMBERNAME was banned for spamming/sending duplicate messages.', member_warn_message: Union[str, dict] = 'Hey $MENTIONMEMBER, please stop spamming/sending duplicate messages.', member_kick_message: Union[str, dict] = 'Hey $MENTIONMEMBER, you are being kicked from $GUILDNAME for spamming/sending duplicate messages.', member_ban_message: Union[str, dict] = 'Hey $MENTIONMEMBER, you are being banned from $GUILDNAME for spamming/sending duplicate messages.', member_failed_kick_message: Union[str, dict] = "I failed to punish you because I lack permissions, but still you shouldn't spam.", member_failed_ban_message: Union[str, dict] = "I failed to punish you because I lack permissions, but still you shouldn't spam.", ignored_members: Set[int] = NOTHING, ignored_channels: Set[int] = NOTHING, ignored_roles: Set[int] = NOTHING, ignored_guilds: Set[int] = NOTHING, delete_spam: bool = False, ignore_bots: bool = True, warn_only: bool = False, no_punish: bool = False, mention_on_embed: bool = True, delete_zero_width_chars: bool = True, per_channel_spam: bool = False, is_per_channel_per_guild: bool = True, addons: Dict[str, Any] = NOTHING)

Options for the AntiSpamHandler, see AntiSpamHandler for explanations

__init__(*, warn_threshold: int = 3, kick_threshold: int = 2, ban_threshold: int = 2, message_interval: int = 30000, message_duplicate_count: int = 5, message_duplicate_accuracy: int = 90, guild_ban_message_delete_after: int = None, guild_kick_message_delete_after: int = None, member_ban_message_delete_after: int = None, guild_warn_message_delete_after: int = None, member_kick_message_delete_after: int = None, guild_warn_message: Union[str, dict] = '$MEMBERNAME was warned for spamming/sending duplicate messages.', guild_kick_message: Union[str, dict] = '$MEMBERNAME was kicked for spamming/sending duplicate messages.', guild_ban_message: Union[str, dict] = '$MEMBERNAME was banned for spamming/sending duplicate messages.', member_warn_message: Union[str, dict] = 'Hey $MENTIONMEMBER, please stop spamming/sending duplicate messages.', member_kick_message: Union[str, dict] = 'Hey $MENTIONMEMBER, you are being kicked from $GUILDNAME for spamming/sending duplicate messages.', member_ban_message: Union[str, dict] = 'Hey $MENTIONMEMBER, you are being banned from $GUILDNAME for spamming/sending duplicate messages.', member_failed_kick_message: Union[str, dict] = "I failed to punish you because I lack permissions, but still you shouldn't spam.", member_failed_ban_message: Union[str, dict] = "I failed to punish you because I lack permissions, but still you shouldn't spam.", ignored_members: Set[int] = NOTHING, ignored_channels: Set[int] = NOTHING, ignored_roles: Set[int] = NOTHING, ignored_guilds: Set[int] = NOTHING, delete_spam: bool = False, ignore_bots: bool = True, warn_only: bool = False, no_punish: bool = False, mention_on_embed: bool = True, delete_zero_width_chars: bool = True, per_channel_spam: bool = False, is_per_channel_per_guild: bool = True, addons: Dict[str, Any] = NOTHING) → None

Method generated by attrs for class Options.

addons

ban_threshold

delete_spam

delete_zero_width_chars

guild_ban_message

guild_ban_message_delete_after

guild_kick_message

guild_kick_message_delete_after

guild_warn_message

guild_warn_message_delete_after

ignore_bots

ignored_channels

ignored_guilds

ignored_members

ignored_roles

is_per_channel_per_guild

kick_threshold

member_ban_message

member_ban_message_delete_after

member_failed_ban_message

member_failed_kick_message

member_kick_message

member_kick_message_delete_after

member_warn_message

mention_on_embed

message_duplicate_accuracy

message_duplicate_count

message_interval

no_punish

per_channel_spam

warn_only

warn_threshold