Features API¶
RFC1459¶
-
class
pydle.features.
RFC1459Support
(nickname, fallback_nicknames=[], username=None, realname=None, eventloop=None, **kwargs)[source]¶ Basic RFC1459 client.
-
ban
(channel, target, range=0)[source]¶ Ban user from channel. Target can be either a user or a host. This command will not kick: use kickban() for that. range indicates the IP/host range to ban: 0 means ban only the IP/host, 1+ means ban that many ‘degrees’ (up to 3 for IP addresses) of the host for range bans.
-
is_same_channel
(left, right)[source]¶ Check if given nicknames are equal in the server’s case mapping.
-
on_channel_message
(target, by, message)[source]¶ Callback received when the client received a message in a channel.
-
on_channel_notice
(target, by, message)[source]¶ Callback called when the client received a notice in a channel.
-
on_invite
(channel, by)[source]¶ Callback called when the client was invited into a channel by someone.
-
on_join
(channel, user)[source]¶ Callback called when a user, possibly the client, has joined the channel.
-
on_kick
(channel, target, by, reason=None)[source]¶ Callback called when a user, possibly the client, was kicked from a channel.
-
on_kill
(target, by, reason)[source]¶ Callback called when a user, possibly the client, was killed from the server.
-
on_nick_change
(old, new)[source]¶ Callback called when a user, possibly the client, changed their nickname.
-
on_part
(channel, user, message=None)[source]¶ Callback called when a user, possibly the client, left a channel.
-
on_private_message
(target, by, message)[source]¶ Callback called when the client received a message in private.
-
on_private_notice
(target, by, message)[source]¶ Callback called when the client received a notice in private.
-
on_quit
(user, message=None)[source]¶ Callback called when a user, possibly the client, left the network.
-
on_topic_change
(channel, message, by)[source]¶ Callback called when the topic for a channel was changed.
-
on_user_invite
(target, channel, by)[source]¶ Callback called when another user was invited into a channel by someone.
-
on_user_mode_change
(modes)[source]¶ Callback called when a user mode change occurred for the client.
-
set_mode
(target, *modes)[source]¶ Set mode on target. Users should only rely on the mode actually being changed when receiving an on_{channel,user}_mode_change callback.
-
set_nickname
(nickname)[source]¶ Set nickname to given nickname. Users should only rely on the nickname actually being changed when receiving an on_nick_change callback.
-
set_topic
(channel, topic)[source]¶ Set topic on channel. Users should only rely on the topic actually being changed when receiving an on_topic_change callback.
-
unban
(channel, target, range=0)[source]¶ Unban user from channel. Target can be either a user or a host. See ban documentation for the range parameter.
-
Transport Layer Security¶
-
class
pydle.features.
TLSSupport
(*args, tls_client_cert=None, tls_client_cert_key=None, tls_client_cert_password=None, **kwargs)[source]¶ TLS support.
Pass tls_client_cert, tls_client_cert_key and optionally tls_client_cert_password to have pydle send a client certificate upon TLS connections.
Client-to-Client Protocol¶
-
class
pydle.features.
CTCPSupport
(nickname, fallback_nicknames=[], username=None, realname=None, eventloop=None, **kwargs)[source]¶ Support for CTCP messages.