tldr.mood

module documentation

Undocumented

Class	`Mood`	No summary
Function	`addCSV`	Adds the message and its emotion to the csv file of the emotions dataset :param messageContent: the message :param emotion: the emotion
Async Function	`createRoles`	Creates all the mood roles on the guild :param bot: the bot :param guild: the guild to put the roles in
Function	`getEmotions`	Gets the emotions associated to a list of messages via a transformer :param messages: the list of messages to extract the emotions from :return: a list of dictionaries, each containing a "label" (emotion name) and "score" (probability of the emotion)...
Function	`getMood`	Gets the mood associated to a list of messages :param messages: the list of messages :return: the mood associated to the list of messages
Function	`messageProcessing`	Processes a message when guild mood refreshes based on messages :param bot: the bot :param message: the message to process
Async Function	`processMessage`	Processes a message for mood computation and sets up the message collection system for the dataset if needed :param bot: the bot :param message: the message to be processed
Function	`refreshMood`	Refreshes the mood of a specific member of a specific guild :param bot: the bot :param userID: the id of the guild member :param guildID: the id of the guild
Function	`refreshMoods`	Refreshes the mood of every active user from the specified guild :param bot: the bot :param guildID: the id of the guild to refresh the users' moods of
Async Function	`removeRoles`	Removes all the mood roles from the guild :param bot: the bot :param guild: the guild
Function	`resetMood`	Resets the mood of a specific member of a specific guild :param bot: the bot :param userID: the id of the member :param guildID: the id of the guild
Function	`resetMoods`	Resets the moods of the inactive users from the specified guild :param bot: the bot :param guildID: the id of the guild
Async Function	`resetRoles`	Removes mood roles from all users on the guild :param bot: the bot :param guild: the guild
Function	`rolesPresent`	Checks if the mood roles are already on the guild :param guild: the guild to check :return: True if the roles are present, False if not
Function	`setDatasetCollectionMessage`	Sends the message to collect the user's message and emotion for the dataset :param bot: the bot :param message: the message
Function	`timeProcessing`	Processes a message when guild mood refreshes are based on time :param bot: the bot :param message: the message to process
Async Function	`updateMoods`	Processes all the required mood updates from the specific minute (see bot.moodUpdates) Called every minute by bot.timeLoop() :param bot: the bot
Variable	`classifier`	Undocumented

@printExceptions
def addCSV(messageContent, emotion): ¶

Adds the message and its emotion to the csv file of the emotions dataset :param messageContent: the message :param emotion: the emotion

Parameters
messageContent:`str`	Undocumented
emotion:`str`	Undocumented

@printExceptions
async def createRoles(bot, guild): ¶

Creates all the mood roles on the guild :param bot: the bot :param guild: the guild to put the roles in

Parameters
bot	Undocumented
guild:`discord.Guild`	Undocumented

def getEmotions(messages): ¶

Gets the emotions associated to a list of messages via a transformer :param messages: the list of messages to extract the emotions from :return: a list of dictionaries, each containing a "label" (emotion name) and "score" (probability of the emotion)

Parameters
messages:`list[str]`	Undocumented
Returns
`list[dict[str:float]]`	Undocumented

@printExceptions
def getMood(messages): ¶

Gets the mood associated to a list of messages :param messages: the list of messages :return: the mood associated to the list of messages

Parameters
messages:`list[str]`	Undocumented
Returns
`Mood`	Undocumented

@printExceptions
def messageProcessing(bot, message): ¶

Processes a message when guild mood refreshes based on messages :param bot: the bot :param message: the message to process

Parameters
bot	Undocumented
message:`discord.Message`	Undocumented

@printExceptions
async def processMessage(bot, message): ¶

Processes a message for mood computation and sets up the message collection system for the dataset if needed :param bot: the bot :param message: the message to be processed

Parameters
bot	Undocumented
message:`discord.Message`	Undocumented

@printExceptions
def refreshMood(bot, userID, guildID): ¶

Refreshes the mood of a specific member of a specific guild :param bot: the bot :param userID: the id of the guild member :param guildID: the id of the guild

Parameters
bot	Undocumented
userID:`int`	Undocumented
guildID:`int`	Undocumented

@printExceptions
def refreshMoods(bot, guildID): ¶

Refreshes the mood of every active user from the specified guild :param bot: the bot :param guildID: the id of the guild to refresh the users' moods of

Parameters
bot	Undocumented
guildID:`int`	Undocumented

@printExceptions
async def removeRoles(bot, guild): ¶

Removes all the mood roles from the guild :param bot: the bot :param guild: the guild

Parameters
bot	Undocumented
guild:`discord.Guild`	Undocumented

@printExceptions
def resetMood(bot, userID, guildID): ¶

Resets the mood of a specific member of a specific guild :param bot: the bot :param userID: the id of the member :param guildID: the id of the guild

Parameters
bot	Undocumented
userID:`int`	Undocumented
guildID:`int`	Undocumented

@printExceptions
def resetMoods(bot, guildID): ¶

Resets the moods of the inactive users from the specified guild :param bot: the bot :param guildID: the id of the guild

Parameters
bot	Undocumented
guildID:`int`	Undocumented

@printExceptions
async def resetRoles(bot, guild): ¶

Removes mood roles from all users on the guild :param bot: the bot :param guild: the guild

Parameters
bot	Undocumented
guild:`discord.Guild`	Undocumented

@printExceptions
def rolesPresent(guild): ¶

Checks if the mood roles are already on the guild :param guild: the guild to check :return: True if the roles are present, False if not

Parameters
guild:`discord.Guild`	Undocumented
Returns
`bool`	Undocumented

@printExceptions
def setDatasetCollectionMessage(bot, message): ¶

Sends the message to collect the user's message and emotion for the dataset :param bot: the bot :param message: the message

Parameters
bot	Undocumented
message:`discord.Message`	Undocumented

@printExceptions
def timeProcessing(bot, message): ¶

Processes a message when guild mood refreshes are based on time :param bot: the bot :param message: the message to process

Parameters
bot	Undocumented
message:`discord.Message`	Undocumented

@printExceptions
async def updateMoods(bot): ¶

Processes all the required mood updates from the specific minute (see bot.moodUpdates) Called every minute by bot.timeLoop() :param bot: the bot

classifier = ¶

Undocumented