enrobie.robie.addons package#

Subpackages#

Submodules#

enrobie.robie.addons.jinja2 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.addons.jinja2.RobieJinja2(robie: Robie)[source]#

Bases: Jinja2

Parse the provided input and intelligently return value.

Parameters:

robie – Primary class instance for Chatting Robie.

enrobie.robie.addons.logger 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.addons.logger.RobieLogger(robie: Robie)[source]#

Bases: object

Methods for extending use of underlying logging library.

log(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log().

Parameters:

kwargs – Keyword arguments for populating message.

log_c(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_c().

Parameters:

kwargs – Keyword arguments for populating message.

log_d(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_d().

Parameters:

kwargs – Keyword arguments for populating message.

log_e(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_e().

Parameters:

kwargs – Keyword arguments for populating message.

log_i(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_i().

Parameters:

kwargs – Keyword arguments for populating message.

log_w(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_w().

Parameters:

kwargs – Keyword arguments for populating message.

start() → None[source]#

Initialize the Python logging library using parameters.

stop() → None[source]#

Deinitialize the Python logging library using parameters.

enrobie.robie.addons.queue 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.addons.queue.RobieQueue(robie: Robie, size: int = 10000)[source]#

Bases: Generic[RobieQueueItemType]

Queue object that will allow to handle full conditions.

Parameters:

  • robie – Primary class instance for Chatting Robie.

  • size – Maximum size for the created queue object.

property empty: bool#

Return the boolean indicating whether the queue is full.

Returns:

Boolean indicating whether the queue is full.

get() → RobieQueueItemType[source]#

Return the next item within the queue in blocking mode.

Returns:

Next item within the queue in blocking mode.

put(item: RobieQueueItemType) → None[source]#

Store the provided item within the queue class instance.

Parameters:

item – Item containing information for operation.

property qsize: int#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

class enrobie.robie.addons.queue.RobieQueueItem[source]#

Bases: object

Contain information for sharing using the Python queue.

time: Time#

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.addons.RobieJinja2(robie: Robie)[source]#

Bases: Jinja2

Parse the provided input and intelligently return value.

Parameters:

robie – Primary class instance for Chatting Robie.

class enrobie.robie.addons.RobieLogger(robie: Robie)[source]#

Bases: object

Methods for extending use of underlying logging library.

log(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log().

Parameters:

kwargs – Keyword arguments for populating message.

log_c(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_c().

Parameters:

kwargs – Keyword arguments for populating message.

log_d(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_d().

Parameters:

kwargs – Keyword arguments for populating message.

log_e(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_e().

Parameters:

kwargs – Keyword arguments for populating message.

log_i(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_i().

Parameters:

kwargs – Keyword arguments for populating message.

log_w(**kwargs: Any) → None[source]#

Pass the provided keyword arguments into logger object.

Note

Uses method encommon.config.Logger.log_w().

Parameters:

kwargs – Keyword arguments for populating message.

start() → None[source]#

Initialize the Python logging library using parameters.

stop() → None[source]#

Deinitialize the Python logging library using parameters.

class enrobie.robie.addons.RobieQueue(robie: Robie, size: int = 10000)[source]#

Bases: Generic[RobieQueueItemType]

Queue object that will allow to handle full conditions.

Parameters:

  • robie – Primary class instance for Chatting Robie.

  • size – Maximum size for the created queue object.

property empty: bool#

Return the boolean indicating whether the queue is full.

Returns:

Boolean indicating whether the queue is full.

get() → RobieQueueItemType[source]#

Return the next item within the queue in blocking mode.

Returns:

Next item within the queue in blocking mode.

put(item: RobieQueueItemType) → None[source]#

Store the provided item within the queue class instance.

Parameters:

item – Item containing information for operation.

property qsize: int#

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

class enrobie.robie.addons.RobieQueueItem[source]#

Bases: object

Contain information for sharing using the Python queue.

time: Time#