errbot.backends.text module

class errbot.backends.text.TextBackend(config)

Bases: errbot.core.ErrBot

__init__(config)

Those arguments will be directly those put in BOT_IDENTITY

add_reaction(msg: errbot.backends.base.Message, reaction: str) → None

build_identifier(text_representation: str) → Union[errbot.backends.text.TextOccupant, errbot.backends.text.TextRoom, errbot.backends.text.TextPerson]

build_reply(msg: errbot.backends.base.Message, text: str = None, private: bool = False, threaded: bool = False) → errbot.backends.base.Message

Should be implemented by the backend

change_presence(status: str = 'online', message: str = '') → None

Signal a presence change for the bot. Should be overridden by backends with a super().send_message() call.

mode

prefix_groupchat_reply(message: errbot.backends.base.Message, identifier: errbot.backends.base.Identifier)

Patches message with the conventional prefix to ping the specific contact For example: @gbin, you forgot the milk !

query_room(room: str) → errbot.backends.text.TextRoom

Query a room for information.

Return type:TextRoom Parameters:room (str) – The room to query for. Returns:An instance of Room.

readline_support() → None

remove_reaction(msg: errbot.backends.base.Message, reaction: str) → None

rooms() → List[errbot.backends.text.TextRoom]

Return a list of rooms the bot is currently in.

Returns:A list of Room instances.

send_message(msg: errbot.backends.base.Message) → None

This needs to be overridden by the backends with a super() call.

Parameters:msg (Message) – the message to send. Returns:None

send_stream_request(user: errbot.backends.base.Identifier, fsource: BinaryIO, name: str = None, size: int = None, stream_type: str = None) → errbot.backends.base.Stream

Starts a file transfer. For Slack, the size and stream_type are unsupported

Return type:

Stream

Parameters:

• user (Identifier) – is the identifier of the person you want to send it to.
• fsource (BinaryIO) – is a file object you want to send.
• name (str) – is an optional filename for it.
• size (int) – not supported in Slack backend
• stream_type (str) – not supported in Slack backend

Return Stream:

object on which you can monitor the progress of it.

serve_forever() → None

Connect the back-end to the server and serve forever.

Back-ends MAY choose to re-implement this method, in which case they are responsible for implementing reconnection logic themselves.

Back-ends SHOULD trigger connect_callback() and disconnect_callback() themselves after connection/disconnection.

class errbot.backends.text.TextOccupant(person, room)

Bases: errbot.backends.text.TextPerson, errbot.backends.base.RoomOccupant

__init__(person, room)

Initialize self. See help(type(self)) for accurate signature.

room

Some backends have the full name of a user.

Returns:the fullname of this user if available.

class errbot.backends.text.TextPerson(person, client=None, nick=None, fullname=None)

Bases: errbot.backends.base.Person

Simple Person implementation which represents users as simple text strings.

__init__(person, client=None, nick=None, fullname=None)

Initialize self. See help(type(self)) for accurate signature.

aclattr

Returns:returns the unique identifier that will be used for ACL matches.

client

Returns:a backend specific unique identifier representing the device or client the person is using to talk.

email

Some backends have the email of a user.

Returns:the email of this user if available.

fullname

Some backends have the full name of a user.

Returns:the fullname of this user if available.

nick

Returns:a backend specific nick returning the nickname of this person if available.

person

Returns:a backend specific unique identifier representing the person you are talking to.

class errbot.backends.text.TextRoom(name: str, bot: errbot.core.ErrBot)

Bases: errbot.backends.base.Room

__init__(name: str, bot: errbot.core.ErrBot)

Initialize self. See help(type(self)) for accurate signature.

create() → None

Create the room.

Calling this on an already existing room is a no-op.

destroy() → None

Destroy the room.

Calling this on a non-existing room is a no-op.

exists

Boolean indicating whether this room already exists or not.

Getter:Returns True if the room exists, False otherwise.

invite(*args)

Invite one or more people into the room.

*argsargs:One or more identifiers to invite into the room.

join(username: Optional[str] = None, password: Optional[str] = None) → None

Join the room.

If the room does not exist yet, this will automatically call create() on it first.

joined

Boolean indicating whether this room has already been joined.

Getter:Returns True if the room has been joined, False otherwise.

leave(reason: Optional[str] = None) → None

Leave the room.

Parameters:reason – An optional string explaining the reason for leaving the room.

occupants

The room’s occupants.

Getter:Returns a list of occupant identities. Raises:MUCNotJoinedError if the room has not yet been joined.

topic

The room topic.

Getter:

Returns the topic (a string) if one is set, None if no topic has been set at all.

Note

Back-ends may return an empty string rather than None when no topic has been set as a network may not differentiate between no topic and an empty topic.

Raises:

MUCNotJoinedError if the room has not yet been joined.

errbot.backends.text.borderless_ansi() → markdown.core.Markdown

This makes a converter from markdown to ansi (console) format. It can be called like this: from errbot.rendering import ansi md_converter = ansi() # you need to cache the converter

ansi_txt = md_converter.convert(md_txt)

Previous: errbot.backends.test module | Next: errbot.backends.xmpp module