user package

Submodules

user.user_def module

User module (also referable to as ‘Client’ module)

This module contains the class and module definitions for the User (Client) entity.

Classes:

User

class user.user_def.User(name: str = '', display_picture_url: str = '')

Bases: object

Class definition for the User entity

classmethod from_role_options(roles: List[Roles]) → User | NoReturn

Constructor to create new Role selected from random selection of supplied Role objects in ‘roles’ :param roles: List of roles to make a random selection from. :return: User or NoReturn (NoReturn because the function may never return as it can raise an exception.)

async classmethod generate_message(message_context: str) → str | NoReturn

Generate message from LLM given message_context. Message context stands for the context in which a user object generates messages / responses / reactions to.

Parameters:

message_context – String message context.

Returns:

String message generated by LLM

property role: Roles

Getter for User role :return: None

set_random_role() → None

Set random role on instance :return: None

classmethod with_role(role: Roles) → User | NoReturn

Constructor to create new User with supplied Role :param role: The role to set user to. :return: User or NoReturn (NoReturn because the function may never return as it can raise an exception.)

Module contents