From a91fa46549e7601cb339fd9fc02e5ed47fbd1797 Mon Sep 17 00:00:00 2001 From: James Lu Date: Sat, 26 Mar 2016 11:42:12 -0700 Subject: [PATCH] Regenerate pydoc documentation --- docs/technical/autogen/classes.html | 27 ++++- docs/technical/autogen/conf.html | 4 +- docs/technical/autogen/coreplugin.html | 1 + docs/technical/autogen/inspircd.html | 7 +- docs/technical/autogen/log.html | 5 +- docs/technical/autogen/ts6.html | 7 +- docs/technical/autogen/ts6_common.html | 5 +- docs/technical/autogen/unreal.html | 7 +- docs/technical/autogen/utils.html | 131 +++++++++++++++++++++++-- docs/technical/autogen/world.html | 2 +- 10 files changed, 178 insertions(+), 18 deletions(-) diff --git a/docs/technical/autogen/classes.html b/docs/technical/autogen/classes.html index c6cdeaa..e639b74 100644 --- a/docs/technical/autogen/classes.html +++ b/docs/technical/autogen/classes.html @@ -267,12 +267,34 @@ Data descriptors defined here:
PyLink IRC channel class.
    Methods defined here:
-
__init__(self)
Initialize self.  See help(type(self)) for accurate signature.
+
__init__(self, name=None)
Initialize self.  See help(type(self)) for accurate signature.
__repr__(self)
Return repr(self).
deepcopy(self)
Returns a deep copy of the channel object.
+
getPrefixModes(self, uid, prefixmodes=None)
Returns a list of all named prefix modes the given user has in the channel.
+ 
+Optionally, a prefixmodes argument can be given to look at an earlier state of
+the channel's prefix modes mapping, e.g. for checking the op status of a mode
+setter before their modes are processed and added to the channel state.
+ +
isAdmin(self, uid)
Returns whether the given user is admin (&) in the channel.
+ +
isHalfop(self, uid)
Returns whether the given user is halfop in the channel.
+ +
isHalfopPlus(self, uid)
Returns whether the given user is halfop or above in the channel.
+ +
isOp(self, uid)
Returns whether the given user is op in the channel.
+ +
isOpPlus(self, uid)
Returns whether the given user is op or above in the channel.
+ +
isOwner(self, uid)
Returns whether the given user is owner (~) in the channel.
+ +
isVoice(self, uid)
Returns whether the given user is voice in the channel.
+ +
isVoicePlus(self, uid)
Returns whether the given user is voice or above in the channel.
+
removeuser(self, target)
Removes a user from a channel.
@@ -428,12 +450,13 @@ Data descriptors inherited from builtins.B Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f07198fc840>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f8f3fcbc9d8>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
log = <logging.RootLogger object>
logdir = '/home/gl/pylink/log'
logformatter = <logging.Formatter object>
+stdout_handler = <logging.StreamHandler object>
stdout_level = 'CRITICAL' \ No newline at end of file diff --git a/docs/technical/autogen/conf.html b/docs/technical/autogen/conf.html index 08c55cf..6dece02 100644 --- a/docs/technical/autogen/conf.html +++ b/docs/technical/autogen/conf.html @@ -47,8 +47,8 @@ configurations from arbitrary files.

Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7ff39bba5598>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fbb4a5c3840>, {})}
confname = 'testconf'
fname = None
-testconf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7ff39bba5598>, {})} +testconf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fbb4a5c3840>, {})} \ No newline at end of file diff --git a/docs/technical/autogen/coreplugin.html b/docs/technical/autogen/coreplugin.html index 3de97c0..96c2c20 100644 --- a/docs/technical/autogen/coreplugin.html +++ b/docs/technical/autogen/coreplugin.html @@ -34,6 +34,7 @@
handle_mode(irc, source, command, args)
Protect against forced deoper attempts.
handle_operup(irc, source, command, args)
Logs successful oper-ups on networks.
handle_services_login(irc, source, command, args)
Sets services login status for users.
+
handle_version(irc, source, command, args)
Handles requests for the PyLink server version.
handle_whois(irc, source, command, args)
Handle WHOIS queries, for IRCds that send them across servers (charybdis, UnrealIRCd; NOT InspIRCd).
identify(irc, source, args)
<username> <password>
 
diff --git a/docs/technical/autogen/inspircd.html b/docs/technical/autogen/inspircd.html index 0c333ed..d1edce2 100644 --- a/docs/technical/autogen/inspircd.html +++ b/docs/technical/autogen/inspircd.html @@ -123,6 +123,8 @@ servers.
handle_uid(self, numeric, command, args)
Handles incoming UID commands (user introduction).
+
handle_version(self, numeric, command, args)
Stub VERSION handler (does nothing) to override the one in ts6_common.
+
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
join(self, client, channel)
Joins a PyLink client to a channel.
@@ -320,6 +322,8 @@ servers.
handle_uid(self, numeric, command, args)
Handles incoming UID commands (user introduction).
+
handle_version(self, numeric, command, args)
Stub VERSION handler (does nothing) to override the one in ts6_common.
+
invite(self, numeric, target, channel)
Sends an INVITE from a PyLink client..
join(self, client, channel)
Joins a PyLink client to a channel.
@@ -444,12 +448,13 @@ Data descriptors inherited from classes.Protocol Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f67e167a378>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f5f06e526a8>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
log = <logging.RootLogger object>
logdir = '/home/gl/pylink/log'
logformatter = <logging.Formatter object>
+stdout_handler = <logging.StreamHandler object>
stdout_level = 'CRITICAL' \ No newline at end of file diff --git a/docs/technical/autogen/log.html b/docs/technical/autogen/log.html index 38d4bbc..9652463 100644 --- a/docs/technical/autogen/log.html +++ b/docs/technical/autogen/log.html @@ -125,7 +125,7 @@ The default is to allow the record to be this and the record is then dropped. Returns a zero value if a record
is to be dropped, else non-zero.
 
-.. versionchanged: 3.2
+.. versionchanged:: 3.2
 
   Allow filters to be just callables. @@ -154,12 +154,13 @@ Data descriptors inherited from logging.Filterer Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f18ebfaea60>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fdc93aefc80>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
log = <logging.RootLogger object>
logdir = '/home/gl/pylink/log'
logformatter = <logging.Formatter object>
+stdout_handler = <logging.StreamHandler object>
stdout_level = 'CRITICAL' \ No newline at end of file diff --git a/docs/technical/autogen/ts6.html b/docs/technical/autogen/ts6.html index 993f5da..575f776 100644 --- a/docs/technical/autogen/ts6.html +++ b/docs/technical/autogen/ts6.html @@ -185,6 +185,8 @@ the SID of the uplink server.
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
+
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
+
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
@@ -375,6 +377,8 @@ the SID of the uplink server.
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
+
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
+
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
@@ -430,12 +434,13 @@ Data descriptors inherited from classes.Protocol Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fce06b832f0>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f7bc713a598>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
log = <logging.RootLogger object>
logdir = '/home/gl/pylink/log'
logformatter = <logging.Formatter object>
+stdout_handler = <logging.StreamHandler object>
stdout_level = 'CRITICAL' \ No newline at end of file diff --git a/docs/technical/autogen/ts6_common.html b/docs/technical/autogen/ts6_common.html index 6b680c0..e1929b9 100644 --- a/docs/technical/autogen/ts6_common.html +++ b/docs/technical/autogen/ts6_common.html @@ -96,6 +96,8 @@ the SID of the uplink server.
handle_topic(self, numeric, command, args)
Handles incoming TOPIC changes from clients. For topic bursts,
TB (TS6/charybdis) and FTOPIC (InspIRCd) are used instead.
+
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
+
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
@@ -153,12 +155,13 @@ Data descriptors inherited from classes.Protocol Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fc131b711e0>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f2667895488>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
log = <logging.RootLogger object>
logdir = '/home/gl/pylink/log'
logformatter = <logging.Formatter object>
+stdout_handler = <logging.StreamHandler object>
stdout_level = 'CRITICAL' \ No newline at end of file diff --git a/docs/technical/autogen/unreal.html b/docs/technical/autogen/unreal.html index acb7241..05206f9 100644 --- a/docs/technical/autogen/unreal.html +++ b/docs/technical/autogen/unreal.html @@ -189,6 +189,8 @@ the SID of the uplink server.
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
+
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
+
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
@@ -382,6 +384,8 @@ the SID of the uplink server.
handle_save(self, numeric, command, args)
Handles incoming SAVE messages, used to handle nick collisions.
+
handle_version(self, numeric, command, args)
Handles requests for the PyLink server version.
+
kick(self, numeric, channel, target, reason=None)
Sends kicks from a PyLink client/server.
message(self, numeric, target, text)
Sends a PRIVMSG from a PyLink client.
@@ -437,12 +441,13 @@ Data descriptors inherited from classes.Protocol Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fa00e8c19d8>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f0f1f40fc80>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
log = <logging.RootLogger object>
logdir = '/home/gl/pylink/log'
logformatter = <logging.Formatter object>
+stdout_handler = <logging.StreamHandler object>
stdout_level = 'CRITICAL' \ No newline at end of file diff --git a/docs/technical/autogen/utils.html b/docs/technical/autogen/utils.html index 7b720c9..4c9831d 100644 --- a/docs/technical/autogen/utils.html +++ b/docs/technical/autogen/utils.html @@ -20,13 +20,14 @@ framework.

Modules         -
conf
-importlib
-		inspect
-os
-		re
-string
-		world
+
collections
+conf
+		importlib
+inspect
+		os
+re
+		string
+world

@@ -48,11 +49,125 @@ framework.

TS6UIDGenerator
+
collections.defaultdict(builtins.dict) +
+
+
KeyedDefaultdict +
+

+ + + + +
 
+class KeyedDefaultdict(collections.defaultdict)
   Subclass of defaultdict allowing the key to be passed to the default factory.
 
 
Method resolution order:
+
KeyedDefaultdict
+
collections.defaultdict
+
builtins.dict
+
builtins.object
+
+
+Methods defined here:
+
__missing__(self, key)
__missing__(key) # Called by __getitem__ for missing key; pseudo-code:
+if self.default_factory is None: raise KeyError((key,))
+self[key] = value = self.default_factory()
+return value
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from collections.defaultdict:
+
__copy__(...)
D.copy() -> a shallow copy of D.
+ +
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__reduce__(...)
Return state information for pickling.
+ +
__repr__(self, /)
Return repr(self).
+ +
copy(...)
D.copy() -> a shallow copy of D.
+ +
+Data descriptors inherited from collections.defaultdict:
+
default_factory
+
Factory for default value called by __missing__().
+
+
+Methods inherited from builtins.dict:
+
__contains__(self, key, /)
True if D has a key k, else False.
+ +
__delitem__(self, key, /)
Delete self[key].
+ +
__eq__(self, value, /)
Return self==value.
+ +
__ge__(self, value, /)
Return self>=value.
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__gt__(self, value, /)
Return self>value.
+ +
__iter__(self, /)
Implement iter(self).
+ +
__le__(self, value, /)
Return self<=value.
+ +
__len__(self, /)
Return len(self).
+ +
__lt__(self, value, /)
Return self<value.
+ +
__ne__(self, value, /)
Return self!=value.
+ +
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
+ +
__setitem__(self, key, value, /)
Set self[key] to value.
+ +
__sizeof__(...)
D.__sizeof__() -> size of D in memory, in bytes
+ +
clear(...)
D.clear() -> None.  Remove all items from D.
+ +
fromkeys(iterable, value=None, /) from builtins.type
Returns a new dict with keys from iterable and values equal to value.
+ +
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
+ +
items(...)
D.items() -> a set-like object providing a view on D's items
+ +
keys(...)
D.keys() -> a set-like object providing a view on D's keys
+ +
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
+If key is not found, d is returned if given, otherwise KeyError is raised
+ +
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
+2-tuple; but raise KeyError if D is empty.
+ +
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
+ +
update(...)
D.update([E, ]**F) -> None.  Update D from dict/iterable E and F.
+If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
+If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
+In either case, this is followed by: for k in F:  D[k] = F[k]
+ +
values(...)
D.values() -> an object providing a view on D's values
+ +
+Data and other attributes inherited from builtins.dict:
+
__hash__ = None
+ +

+ + + @@ -186,6 +301,8 @@ Data descriptors defined here:
The target can be either a channel or a user; this is handled automatically.
checkAuthenticated(irc, uid, allowAuthed=True, allowOper=True)
Checks whether the given user has operator status on PyLink, raising
NotAuthenticatedError and logging the access denial if not.
+
fullVersion(irc)
Returns a detailed version string including the PyLink daemon version,
+the protocol module in use, and the server hostname.
getDatabaseName(dbname)
Returns a database filename with the given base DB name appropriate for the
current PyLink instance.
 
diff --git a/docs/technical/autogen/world.html b/docs/technical/autogen/world.html index 096b1bf..486840f 100644 --- a/docs/technical/autogen/world.html +++ b/docs/technical/autogen/world.html @@ -37,6 +37,6 @@ started = <threading.Event object>
testing = True
testing_ircd = 'inspircd'
-version = 'v0.6.1-dev-36-g2e8d63a'
+version = 'v0.7.0-dev-29-gc8a3514'
whois_handlers = []
 
class NotAuthenticatedError(builtins.Exception)
   
\ No newline at end of file