Skip to main content

WIP extensions for miniirc.

Project description

miniirc_extras

An extension of miniirc (GitHub, GitLab) that adds more features.

Note that miniirc_extras is pre-alpha software and should not be used in production.

Some features here may be merged into miniirc eventually.

Loading features

After importing miniirc_extras, features can be loaded with irc.require('feature_name'), and once loaded can be accessed with irc.feature_name.

Features

  • chans: Channel mode tracking, must be loaded while miniirc is disconnected.
  • ensure_connection: https://github.com/luk3yx/miniirc/issues/15
  • testfeature: Debugging
  • users: User tracking, must be loaded while miniirc is disconnected.
  • _json (WIP): Parse JSON messages.

irc.users

irc.users adds rudimentary user tracking to miniirc.

User objects

User objects store the current user's information and user-defined data, and can be accessed with irc.users[Hostmask] or irc.users['nick'].

The following items are available in User objects:

Variable Description
nick The user's current nickname.
ident The user's current ident.
host The user's current hostname.
realname The user's realname.
hostmask A Hostmask object containing the user's hostmask.
raw_hostmask A string containing nick!user@host.
channels A set containing Channel objects for channels the user is currently in.
account A string containing the user's current NickServ account, or None if the user isn't logged in.

You can also set and get items with strings as keys and JSON-compatible objects as values.

User objects have the following helper functions:

Function Description
msg(*text) Send a PRIVMSG to the user.
me(*text) Send a CTCP ACTION (/me) to the user.
notice(*text) Send a NOTICE to the user.
kick(channel, reason = '') Kicks the user from channel (a string or Channel object).

irc.chans

irc.chans adds channel mode tracking on top of irc.users. You can get channels with irc.chans['#channel-name']

Channel objects

Channel objects have the following attributes:

Variable Description
name The name of the channel.
modes A ModeList object containing a list of modes.
topic The channel topic.
users A set containing User objects for members of this channel.

ModeList objects

ModeList objects store a list of modes, and have the following functions:

Function Description
getbool(mode) Returns True if mode (a single-character string) is set on the corresponding channel. Use this for +i, +t, etc
getstr(mode, default = None) Return the parameter mode was set with, otherwise default. Use this for +k, +l, etc
getset(mode) Return a frozenset containing all the entries stored in mode. If you plan to use this for modes such as +b, you may want to run MODE #channel +b when the bot/client joins the channel to populate the list. Use this for +b, +e, +o, +v, etc
hasstr(mode) Returns True if mode is set with a single parameter, otherwise False.
hasset(mode) Equivalent to len(getset(mode)) == 0.

You can access ModeList objects like dicts, however this will require extra type checking code if you plan to use mypy or another type checker.

Hostmask objects

miniirc_extras adds the abstract base class miniirc_extras.Hostmask:

from miniirc_extras import Hostmask

isinstance('test', Hostmask)                    # False
isinstance(('nick', 123, 'host'), Hostmask)     # False
isinstance(('nick', 'user', 'host'), Hostmask)  # True

Hostmask('nick', 'user', 'host') # ('nick', 'user', 'host')
Hostmask(123456, 'user', 'host') # TypeError

Creating new features

This API will probably change in the future.

You can create your own features with miniirc_extras.Feature:

@miniirc_extras.Feature('feature_name')
class MyFeature:
    def test_func(self, irc):
        print('test_func called with', irc)

    def __call__(self, irc):
        print('MyFeature called with', irc)

    def __init__(self, irc):
        self._irc = irc

Once registered, you can require and use it:

irc.require('feature_name')

irc.feature_name()           # MyFeature called with <miniirc.IRC object>
irc.feature_name.test_func() # test_func called with <miniirc.IRC object>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for miniirc-extras, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size miniirc_extras-0.1.2-py3-none-any.whl (6.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size miniirc_extras-0.1.2.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page