utils
index
/home/gl/pylink/utils.py

utils.py - PyLink utilities module.
 
This module contains various utility functions related to IRC and/or the PyLink
framework.

 
Modules
       
collections
conf
importlib
os
re
string
world

 
Classes
       
builtins.Exception(builtins.BaseException)
NotAuthenticatedError
builtins.object
IncrementalUIDGenerator
ServiceBot

 
class IncrementalUIDGenerator(builtins.object)
    Incremental UID Generator module, adapted from InspIRCd source:
https://github.com/inspircd/inspircd/blob/f449c6b296ab/src/server.cpp#L85-L156
 
  Methods defined here:
__init__(self, sid)
Initialize self.  See help(type(self)) for accurate signature.
increment(self, pos=None)
Increments the UID generator to the next available UID.
next_uid(self)
Returns the next unused UID for the server.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class NotAuthenticatedError(builtins.Exception)
    Exception raised by checkAuthenticated() when a user fails authentication
requirements.
 
 
Method resolution order:
NotAuthenticatedError
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class ServiceBot(builtins.object)
     Methods defined here:
__init__(self, name, default_help=True, default_request=False, default_list=True, nick=None, ident=None, manipulatable=False)
Initialize self.  See help(type(self)) for accurate signature.
add_cmd(self, func, name=None)
Binds an IRC command function to the given command name.
call_cmd(self, irc, source, text, called_by=None, notice=True)
Calls a PyLink bot command. source is the caller's UID, and text is the
full, unparsed text of the message.
help(self, irc, source, args)
<command>
 
Gives help for <command>, if it is available.
listcommands(self, irc, source, args)
takes no arguments.
 
Returns a list of available commands this service has to offer.
remove(self, irc, source, args)
reply(self, irc, text)
Replies to a message using the right service UID.
request(self, irc, source, args)
spawn(self, irc=None)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
add_cmd(func, name=None)
Binds an IRC command function to the given command name.
add_hook(func, command)
Binds a hook function to the given command name.
applyModes(irc, target, changedmodes)
Takes a list of parsed IRC modes, and applies them on the given target.
 
The target can be either a channel or a user; this is handled automatically.
 
This method is deprecated. Use irc.applyModes() instead.
getDatabaseName(dbname)
Returns a database filename with the given base DB name appropriate for the
current PyLink instance.
 
This returns '<dbname>.db' if the running config name is PyLink's default
(config.yml), and '<dbname>-<config name>.db' for anything else. For example,
if this is called from an instance running as './pylink testing.yml', it
would return '<dbname>-testing.db'.
getProtocolModule(protoname)
Imports and returns the protocol module requested.
isChannel(s)
Returns whether the string given is a valid channel name.
isHostmask(text)
Returns whether the given text is a valid hostmask.
isNick(s, nicklen=None)
Returns whether the string given is a valid nick.
isServerName(s)
Returns whether the string given is a valid IRC server name.
loadModuleFromFolder(name, folder)
Imports and returns a module, if existing, from a specific folder.
parseModes(irc, target, args)
Parses a modestring list into a list of (mode, argument) tuples.
['+mitl-o', '3', 'person'] => [('+m', None), ('+i', None), ('+t', None), ('+l', '3'), ('-o', 'person')]
 
This method is deprecated. Use irc.parseModes() instead.
registerService(name, *args, **kwargs)
Registers a service bot.
unregisterService(name)
Unregisters an existing service bot.

 
Data
        hostmaskRe = re.compile('^\\S+!\\S+@\\S+$')
log = <logging.RootLogger object>