enrobie.robie.models package

Subpackages

• enrobie.robie.models.test package
  • Submodules
  • enrobie.robie.models.test.test_command module
    • test_RobieCommand()
  • enrobie.robie.models.test.test_message module
    • test_RobieMessage()
  • enrobie.robie.models.test.test_models module
    • test_RobieModels_cover()
  • Module contents

Submodules

enrobie.robie.models.command module

Functions and routines associated with Enasis Network Chatting Robie.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class enrobie.robie.models.command.RobieCommand(client: RobieClient)

Bases: RobieQueueItem

Contain information for sharing using the Python queue.

client: str

property family: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

enrobie.robie.models.message module

Functions and routines associated with Enasis Network Chatting Robie.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class enrobie.robie.models.message.RobieMessage(client: RobieClient, person: RobiePerson | None = None)

Bases: RobieQueueItem

Contain information for sharing using the Python queue.

property anchor: str | None

Return the unique value for the context with the client.

Returns:

Unique value for the context with the client.

property author: tuple[str, str] | None

Return the current nickname of the client on the server.

Returns:

Current nickname of the client on the server.

client: str

property family: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property hasme: bool

Return the boolean indicating message mention the client.

Returns:

Boolean indicating message mention the client.

property isme: bool

Return the boolean indicating message origin from client.

Returns:

Boolean indicating message origin from client.

property kind: Literal['event', 'chanmsg', 'privmsg']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property message: str | None

Return the string containing the content of the message.

Returns:

String containing the content of the message.

person: str | None

reply(robie: Robie, content: str) → RobieCommand

Compose the message and transmit using the chat client.

Parameters:

• robie – Primary class instance for Chatting Robie.

• content – Content that will be source of message.

property whome: tuple[str, str] | None

Return the current nickname of the client on the server.

Returns:

Current nickname of the client on the server.

enrobie.robie.models.robie module

Functions and routines associated with Enasis Network Chatting Robie.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class enrobie.robie.models.robie.RobieModels

Bases: object

Return the class object that was imported within method.

classmethod child() → Type[RobieChildParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod client() → Type[RobieClientParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod command() → Type[RobieCommand]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod message() → Type[RobieMessage]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod person() → Type[RobiePersonParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod plugin() → Type[RobiePluginParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod printer() → Type[RobiePrinterParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod queue() → Type[RobieQueueItem]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod robie() → Type[RobieParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod service() → Type[RobieServiceParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

Module contents

Functions and routines associated with Enasis Network Chatting Robie.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class enrobie.robie.models.RobieCommand(client: RobieClient)

Bases: RobieQueueItem

Contain information for sharing using the Python queue.

client: str

property family: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

time: Time

class enrobie.robie.models.RobieMessage(client: RobieClient, person: RobiePerson | None = None)

Bases: RobieQueueItem

Contain information for sharing using the Python queue.

property anchor: str | None

Return the unique value for the context with the client.

Returns:

Unique value for the context with the client.

property author: tuple[str, str] | None

Return the current nickname of the client on the server.

Returns:

Current nickname of the client on the server.

client: str

property family: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property hasme: bool

Return the boolean indicating message mention the client.

Returns:

Boolean indicating message mention the client.

property isme: bool

Return the boolean indicating message origin from client.

Returns:

Boolean indicating message origin from client.

property kind: Literal['event', 'chanmsg', 'privmsg']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property message: str | None

Return the string containing the content of the message.

Returns:

String containing the content of the message.

person: str | None

reply(robie: Robie, content: str) → RobieCommand

Compose the message and transmit using the chat client.

Parameters:

• robie – Primary class instance for Chatting Robie.

• content – Content that will be source of message.

time: Time

property whome: tuple[str, str] | None

Return the current nickname of the client on the server.

Returns:

Current nickname of the client on the server.

class enrobie.robie.models.RobieModels

Bases: object

Return the class object that was imported within method.

classmethod child() → Type[RobieChildParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod client() → Type[RobieClientParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod command() → Type[RobieCommand]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod message() → Type[RobieMessage]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod person() → Type[RobiePersonParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod plugin() → Type[RobiePluginParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod printer() → Type[RobiePrinterParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod queue() → Type[RobieQueueItem]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod robie() → Type[RobieParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod service() → Type[RobieServiceParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.