irc

Platypush documentation

`irc`#

class platypush.message.event.irc.IRCCTCPMessageEvent(*args, address: str, message: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a CTCP message is received.

__init__(*args, address: str, message: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCChannelJoinEvent(*args, nick: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered upon account channel join.

__init__(*args, nick: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCChannelKickEvent(*args, target_nick: str, source_nick: str | None = None, **kwargs)[source]#

Bases: IRCEvent

Event triggered upon account channel kick.

__init__(*args, target_nick: str, source_nick: str | None = None, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCConnectEvent(*args, server: str | None = None, port: int | None = None, alias: str | None = None, channel: str | None = None, **kwargs)[source]#

Bases: IRCEvent

Event triggered upon server connection.

__init__(*args, server: str | None = None, port: int | None = None, alias: str | None = None, channel: str | None = None, **kwargs)#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDCCFileRecvCancelledEvent(*args, address: str, port: int, file: str, error: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a DCC file transfer RECV is cancelled.

__init__(*args, address: str, port: int, file: str, error: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDCCFileRecvCompletedEvent(*args, address: str, port: int, file: str, size: int | None = None, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a DCC file transfer RECV is completed.

__init__(*args, address: str, port: int, file: str, size: int | None = None, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDCCFileRequestEvent(*args, nick: str, address: str, file: str, port: int, size: int | None = None, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a DCC file send request is received.

__init__(*args, nick: str, address: str, file: str, port: int, size: int | None = None, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDCCFileSendCancelledEvent(*args, address: str, port: int, file: str, error: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a DCC file transfer SEND is cancelled.

__init__(*args, address: str, port: int, file: str, error: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDCCFileSendCompletedEvent(*args, address: str, port: int, file: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a DCC file transfer SEND is completed.

__init__(*args, address: str, port: int, file: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDCCMessageEvent(*args, address: str, body: bytes, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a DCC message is received.

__init__(*args, address: str, body: bytes, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDCCRequestEvent(*args, address: str, port: int, nick: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a DCC connection request is received.

__init__(*args, address: str, port: int, nick: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCDisconnectEvent(*args, server: str | None = None, port: int | None = None, alias: str | None = None, channel: str | None = None, **kwargs)[source]#

Bases: IRCEvent

Event triggered upon server disconnection.

__init__(*args, server: str | None = None, port: int | None = None, alias: str | None = None, channel: str | None = None, **kwargs)#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCEvent(*args, server: str | None = None, port: int | None = None, alias: str | None = None, channel: str | None = None, **kwargs)[source]#

Bases: Event, ABC

IRC base event.

__init__(*args, server: str | None = None, port: int | None = None, alias: str | None = None, channel: str | None = None, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCModeEvent(*args, mode: str, channel: str | None = None, source: str | None = None, target_: str | None = None, **kwargs)[source]#

Bases: IRCEvent

Event triggered when the IRC mode of a channel user changes.

__init__(*args, mode: str, channel: str | None = None, source: str | None = None, target_: str | None = None, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCNickChangeEvent(*args, before: str, after: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a IRC nick changes.

__init__(*args, before: str, after: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCPartEvent(*args, nick: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when an IRC nick parts.

__init__(*args, nick: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCPrivateMessageEvent(*args, text: str, nick: str, mentions_me: bool = False, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a private message is received.

__init__(*args, text: str, nick: str, mentions_me: bool = False, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCPublicMessageEvent(*args, text: str, nick: str, mentions_me: bool = False, **kwargs)[source]#

Bases: IRCEvent

Event triggered when a public message is received.

__init__(*args, text: str, nick: str, mentions_me: bool = False, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

class platypush.message.event.irc.IRCQuitEvent(*args, nick: str, **kwargs)[source]#

Bases: IRCEvent

Event triggered when an IRC nick quits.

__init__(*args, nick: str, **kwargs)[source]#

Parameters:

target (str) – Target node
origin (str) – Origin node (default: current node)
id (str) – Event ID (default: auto-generated)
timestamp (float) – Event timestamp (default: current time)
logging_level – Logging level for this event (default: logging.INFO)
disable_web_clients_notification – Don’t send a notification of this event to the websocket clients
kwargs – Additional arguments for the event

as_dict()#: Converts the event into a dictionary

classmethod build(msg)#: Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#: If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:: msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:: msg – Message object

irc

Platypush documentation

irc#

`irc`#