2015-10-04 01:39:52 +02:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
|
<html><head><title>Python: module utils</title>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
|
|
</head><body bgcolor="#f0f0f8">
|
|
|
|
|
|
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
|
|
|
<tr bgcolor="#7799ee">
|
|
|
|
|
<td valign=bottom> <br>
|
|
|
|
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong>utils</strong></big></big></font></td
|
|
|
|
|
><td align=right valign=bottom
|
|
|
|
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/gl/pylink/utils.py">/home/gl/pylink/utils.py</a></font></td></tr></table>
|
2015-12-26 23:45:28 +01:00
|
|
|
<p><tt>utils.py - PyLink utilities module.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This module contains various utility functions related to IRC and/or the PyLink<br>
|
|
|
|
|
framework.</tt></p>
|
2015-10-04 01:39:52 +02:00
|
|
|
<p>
|
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
|
|
|
<tr bgcolor="#aa55cc">
|
|
|
|
|
<td colspan=3 valign=bottom> <br>
|
|
|
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
2016-05-12 06:56:02 +02:00
|
|
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="conf.html">conf</a><br>
|
|
|
|
|
<a href="importlib.html">importlib</a><br>
|
2016-03-26 19:42:12 +01:00
|
|
|
</td><td width="25%" valign=top><a href="os.html">os</a><br>
|
|
|
|
|
<a href="re.html">re</a><br>
|
|
|
|
|
</td><td width="25%" valign=top><a href="string.html">string</a><br>
|
|
|
|
|
<a href="world.html">world</a><br>
|
2016-05-12 06:56:02 +02:00
|
|
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
2015-10-04 01:39:52 +02:00
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
|
|
|
<tr bgcolor="#ee77aa">
|
|
|
|
|
<td colspan=3 valign=bottom> <br>
|
|
|
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
|
|
|
<td width="100%"><dl>
|
|
|
|
|
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
|
|
|
|
|
</font></dt><dd>
|
|
|
|
|
<dl>
|
2016-05-12 06:56:02 +02:00
|
|
|
<dt><font face="helvetica, arial"><a href="utils.html#IncrementalUIDGenerator">IncrementalUIDGenerator</a>
|
2016-03-26 19:42:12 +01:00
|
|
|
</font></dt></dl>
|
|
|
|
|
</dd>
|
2015-10-04 01:39:52 +02:00
|
|
|
</dl>
|
|
|
|
|
<p>
|
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
|
|
|
<tr bgcolor="#ffc8d8">
|
|
|
|
|
<td colspan=3 valign=bottom> <br>
|
2016-05-12 06:56:02 +02:00
|
|
|
<font color="#000000" face="helvetica, arial"><a name="IncrementalUIDGenerator">class <strong>IncrementalUIDGenerator</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
|
2016-03-26 19:42:12 +01:00
|
|
|
|
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
2016-05-12 06:56:02 +02:00
|
|
|
<td colspan=2><tt>Incremental UID Generator module, adapted from InspIRCd source:<br>
|
2015-10-04 01:39:52 +02:00
|
|
|
https://github.com/inspircd/inspircd/blob/f449c6b296ab/src/server.cpp#L85-L156<br> </tt></td></tr>
|
|
|
|
|
<tr><td> </td>
|
|
|
|
|
<td width="100%">Methods defined here:<br>
|
2016-05-12 06:56:02 +02:00
|
|
|
<dl><dt><a name="IncrementalUIDGenerator-__init__"><strong>__init__</strong></a>(self, sid)</dt></dl>
|
2015-10-04 01:39:52 +02:00
|
|
|
|
2016-05-12 06:56:02 +02:00
|
|
|
<dl><dt><a name="IncrementalUIDGenerator-increment"><strong>increment</strong></a>(self, pos=None)</dt><dd><tt>Increments the UID generator to the next available UID.</tt></dd></dl>
|
2015-10-04 01:39:52 +02:00
|
|
|
|
2016-05-12 06:56:02 +02:00
|
|
|
<dl><dt><a name="IncrementalUIDGenerator-next_uid"><strong>next_uid</strong></a>(self)</dt><dd><tt>Returns the next unused UID for the server.</tt></dd></dl>
|
2015-10-04 01:39:52 +02:00
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
Data descriptors defined here:<br>
|
|
|
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
|
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
|
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</td></tr></table></td></tr></table><p>
|
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
|
|
|
<tr bgcolor="#eeaa77">
|
|
|
|
|
<td colspan=3 valign=bottom> <br>
|
|
|
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
2015-12-26 23:45:28 +01:00
|
|
|
<td width="100%"><dl><dt><a name="-add_cmd"><strong>add_cmd</strong></a>(func, name=None)</dt><dd><tt>Binds an IRC command function to the given command name.</tt></dd></dl>
|
|
|
|
|
<dl><dt><a name="-add_hook"><strong>add_hook</strong></a>(func, command)</dt><dd><tt>Binds a hook function to the given command name.</tt></dd></dl>
|
2015-10-04 01:39:52 +02:00
|
|
|
<dl><dt><a name="-applyModes"><strong>applyModes</strong></a>(irc, target, changedmodes)</dt><dd><tt>Takes a list of parsed IRC modes, and applies them on the given target.<br>
|
|
|
|
|
<br>
|
2016-05-12 06:56:02 +02:00
|
|
|
The target can be either a channel or a user; this is handled automatically.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This method is deprecated. Use irc.<a href="#-applyModes">applyModes</a>() instead.</tt></dd></dl>
|
2015-12-26 23:45:28 +01:00
|
|
|
<dl><dt><a name="-getDatabaseName"><strong>getDatabaseName</strong></a>(dbname)</dt><dd><tt>Returns a database filename with the given base DB name appropriate for the<br>
|
|
|
|
|
current PyLink instance.<br>
|
|
|
|
|
<br>
|
|
|
|
|
This returns '<dbname>.db' if the running config name is PyLink's default<br>
|
|
|
|
|
(config.yml), and '<dbname>-<config name>.db' for anything else. For example,<br>
|
|
|
|
|
if this is called from an instance running as './pylink testing.yml', it<br>
|
|
|
|
|
would return '<dbname>-testing.db'.</tt></dd></dl>
|
|
|
|
|
<dl><dt><a name="-getProtocolModule"><strong>getProtocolModule</strong></a>(protoname)</dt><dd><tt>Imports and returns the protocol module requested.</tt></dd></dl>
|
|
|
|
|
<dl><dt><a name="-isChannel"><strong>isChannel</strong></a>(s)</dt><dd><tt>Returns whether the string given is a valid channel name.</tt></dd></dl>
|
2015-10-04 01:39:52 +02:00
|
|
|
<dl><dt><a name="-isHostmask"><strong>isHostmask</strong></a>(text)</dt><dd><tt>Returns whether the given text is a valid hostmask.</tt></dd></dl>
|
2015-12-26 23:45:28 +01:00
|
|
|
<dl><dt><a name="-isNick"><strong>isNick</strong></a>(s, nicklen=None)</dt><dd><tt>Returns whether the string given is a valid nick.</tt></dd></dl>
|
|
|
|
|
<dl><dt><a name="-isServerName"><strong>isServerName</strong></a>(s)</dt><dd><tt>Returns whether the string given is a valid IRC server name.</tt></dd></dl>
|
|
|
|
|
<dl><dt><a name="-loadModuleFromFolder"><strong>loadModuleFromFolder</strong></a>(name, folder)</dt><dd><tt>Imports and returns a module, if existing, from a specific folder.</tt></dd></dl>
|
2015-10-04 01:39:52 +02:00
|
|
|
<dl><dt><a name="-parseModes"><strong>parseModes</strong></a>(irc, target, args)</dt><dd><tt>Parses a modestring list into a list of (mode, argument) tuples.<br>
|
2016-05-12 06:56:02 +02:00
|
|
|
['+mitl-o', '3', 'person'] => [('+m', None), ('+i', None), ('+t', None), ('+l', '3'), ('-o', 'person')]<br>
|
2015-10-04 01:39:52 +02:00
|
|
|
<br>
|
2016-05-12 06:56:02 +02:00
|
|
|
This method is deprecated. Use irc.<a href="#-parseModes">parseModes</a>() instead.</tt></dd></dl>
|
2015-10-04 01:39:52 +02:00
|
|
|
</td></tr></table><p>
|
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
|
|
|
<tr bgcolor="#55aa55">
|
|
|
|
|
<td colspan=3 valign=bottom> <br>
|
|
|
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
|
|
|
|
|
|
|
|
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
|
|
|
|
<td width="100%"><strong>hostmaskRe</strong> = re.compile('^\\S+!\\S+@\\S+$')<br>
|
|
|
|
|
<strong>log</strong> = <logging.RootLogger object></td></tr></table>
|
|
|
|
|
</body></html>
|
