From 89ed92b46a4376abf69698b76955fec010a230b4 Mon Sep 17 00:00:00 2001 From: James Lu Date: Fri, 27 May 2016 22:39:27 -0700 Subject: [PATCH] Update autogen docs --- docs/technical/autogen/classes.html | 112 ++++++---------------- docs/technical/autogen/conf.html | 4 +- docs/technical/autogen/coreplugin.html | 13 ++- docs/technical/autogen/hybrid.html | 18 ++-- docs/technical/autogen/inspircd.html | 20 ++-- docs/technical/autogen/log.html | 7 +- docs/technical/autogen/nefarious.html | 18 ++-- docs/technical/autogen/structures.html | 62 ++++++++++-- docs/technical/autogen/ts6.html | 14 ++- docs/technical/autogen/ts6_common.html | 12 ++- docs/technical/autogen/unreal.html | 18 ++-- docs/technical/autogen/utils.html | 127 +++++++++++++++++++++++-- docs/technical/autogen/world.html | 7 +- 13 files changed, 282 insertions(+), 150 deletions(-) diff --git a/docs/technical/autogen/classes.html b/docs/technical/autogen/classes.html index 5e14a91..38f3ff8 100644 --- a/docs/technical/autogen/classes.html +++ b/docs/technical/autogen/classes.html @@ -45,8 +45,7 @@ Here be dragons.

builtins.Exception(builtins.BaseException)
-
NotAuthenticatedError -
ProtocolError +
ProtocolError
builtins.object @@ -86,11 +85,12 @@ Here be dragons.

Methods defined here:
-
connect(self)
+
connect(self)
Runs the connect loop for the IRC object. This is usually called by
+__init__ in a separate thread to allow multiple concurrent connections.
run(self, data)
Queues a message to the fake IRC server.
-
send(self, data)
+
send(self, data)
Sends raw text to the uplink server.
takeCommands(self, msgs)
Returns a list of commands parsed from the output of takeMsgs().
@@ -106,7 +106,7 @@ Methods inherited from Irc:
(a string), the name of the protocol module to use for this connection,
and a configuration object. -
__repr__(self)
+
__repr__(self)
Return repr(self).
applyModes(self, target, changedmodes)
Takes a list of parsed IRC modes, and applies them on the given target.
 
@@ -118,7 +118,7 @@ full, unparsed text of the message.
callHooks(self, hook_args)
Calls a hook function with the given hook args.
checkAuthenticated(self, uid, allowAuthed=True, allowOper=True)
Checks whether the given user has operator status on PyLink, raising
-NotAuthenticatedError and logging the access denial if not.
+NotAuthenticatedError and logging the access denial if not.
disconnect(self)
Handle disconnects from the remote server.
@@ -148,6 +148,9 @@ or having user mode +o set (if allowOper  allowAuthed or allowOper must be True for this to give any meaningful
results. +
isServiceBot(self, uid)
Checks whether the given UID is a registered service bot. If True,
+returns the cooresponding ServiceBot object.
+
logSetup(self)
Initializes any channel loggers defined for the current network.
msg(self, target, text, notice=False, source=None)
Handy function to send messages/notices to clients. Source
@@ -177,8 +180,6 @@ This function allows both mode strings or mod
schedulePing(self)
Schedules periodic pings in a loop.
-
spawnMain(self)
Spawns the main PyLink client.
-
toLower(self, text)
Returns a lowercase representation of text based on the IRC object's
casemapping (rfc1459 or ascii).
@@ -230,7 +231,7 @@ Data and other attributes defined here:
Methods inherited from Protocol:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
be used for multi-word arguments that last until the end of a line.
@@ -262,7 +263,7 @@ Data descriptors inherited from Protocol:
and a configuration object.
-
__repr__(self)
+
__repr__(self)
Return repr(self).
applyModes(self, target, changedmodes)
Takes a list of parsed IRC modes, and applies them on the given target.
 
@@ -274,7 +275,7 @@ full, unparsed text of the message.
callHooks(self, hook_args)
Calls a hook function with the given hook args.
checkAuthenticated(self, uid, allowAuthed=True, allowOper=True)
Checks whether the given user has operator status on PyLink, raising
-NotAuthenticatedError and logging the access denial if not.
+NotAuthenticatedError and logging the access denial if not.
connect(self)
Runs the connect loop for the IRC object. This is usually called by
__init__ in a separate thread to allow multiple concurrent connections.
@@ -307,6 +308,9 @@ or having user mode +o set (if allowOper  allowAuthed or allowOper must be True for this to give any meaningful
results. +
isServiceBot(self, uid)
Checks whether the given UID is a registered service bot. If True,
+returns the cooresponding ServiceBot object.
+
logSetup(self)
Initializes any channel loggers defined for the current network.
msg(self, target, text, notice=False, source=None)
Handy function to send messages/notices to clients. Source
@@ -340,8 +344,6 @@ This function allows both mode strings or mod
send(self, data)
Sends raw text to the uplink server.
-
spawnMain(self)
Spawns the main PyLink client.
-
toLower(self, text)
Returns a lowercase representation of text based on the IRC object's
casemapping (rfc1459 or ascii).
@@ -373,9 +375,9 @@ Data descriptors defined here:
PyLink IRC channel class.
    Methods defined here:
-
__init__(self, name=None)
+
__init__(self, name=None)
Initialize self.  See help(type(self)) for accurate signature.
-
__repr__(self)
+
__repr__(self)
Return repr(self).
deepcopy(self)
Returns a deep copy of the channel object.
@@ -426,9 +428,9 @@ name: The name of the server.
internal: Whether the server is an internal PyLink PseudoServer.
    Methods defined here:
-
__init__(self, uplink, name, internal=False, desc='(None given)')
+
__init__(self, uplink, name, internal=False, desc='(None given)')
Initialize self.  See help(type(self)) for accurate signature.
-
__repr__(self)
+
__repr__(self)
Return repr(self).
Data descriptors defined here:
@@ -448,9 +450,9 @@ Data descriptors defined here:
PyLink IRC user class.
    Methods defined here:
-
__init__(self, nick, ts, uid, ident='null', host='null', realname='PyLink dummy client', realhost='null', ip='0.0.0.0', manipulatable=False, opertype='IRC Operator')
+
__init__(self, nick, ts, uid, ident='null', host='null', realname='PyLink dummy client', realhost='null', ip='0.0.0.0', manipulatable=False, opertype='IRC Operator')
Initialize self.  See help(type(self)) for accurate signature.
-
__repr__(self)
+
__repr__(self)
Return repr(self).
Data descriptors defined here:
@@ -464,75 +466,13 @@ Data descriptors defined here:
- - - - -
 
-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__(...)
- -
__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 Protocol(builtins.object)
    Base Protocol module class for PyLink.
 
  Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
parseArgs(self, args)
Parses a string of RFC1459-style arguments split into a list, where ":" may
be used for multi-word arguments that last until the end of a line.
@@ -556,7 +496,9 @@ Data descriptors defined here:
 
class ProtocolError(builtins.Exception)
    
   Common base class for all non-exit exceptions.
 
 
Method resolution order:
ProtocolError
builtins.Exception
@@ -580,7 +522,7 @@ Methods inherited from builtins.BaseExcept
__getattribute__(self, name, /)
Return getattr(self, name).
-
__reduce__(...)
+
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
@@ -616,7 +558,7 @@ 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 0x7f36077522f0>, {})}
+		conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fcfaf78de18>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/conf.html b/docs/technical/autogen/conf.html index 947675c..7aa280a 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 0x7fcd1260b730>, {})}
+		conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fee74c229d8>, {})}
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 0x7fcd1260b730>, {})}
+testconf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fee74c229d8>, {})} \ No newline at end of file diff --git a/docs/technical/autogen/coreplugin.html b/docs/technical/autogen/coreplugin.html index db9c302..6eabff2 100644 --- a/docs/technical/autogen/coreplugin.html +++ b/docs/technical/autogen/coreplugin.html @@ -32,9 +32,11 @@ Functions         -

handle_commands(irc, source, command, args)
Handle commands sent to the PyLink client (PRIVMSG).
-
handle_kick(irc, source, command, args)
Handle KICKs to the main PyLink client, rejoining channels as needed.
-
handle_kill(irc, source, command, args)
Handle KILLs to the main PyLink client, respawning it as needed.
+
handle_commands(irc, source, command, args)
Handle commands sent to the PyLink service bots (PRIVMSG).
+
handle_disconnect(irc, source, command, args)
Handles network disconnections.
+
handle_endburst(irc, source, command, args)
Handles network bursts.
+
handle_kick(irc, source, command, args)
Handle KICKs to the PyLink service bots, rejoining channels as needed.
+
handle_kill(irc, source, command, args)
Handle KILLs to PyLink service bots, respawning them as needed.
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.
@@ -58,6 +60,7 @@ Loads a plugin from the plugin folder.
sighup_handler(_signo, _stack_frame)
Handles SIGHUP by rehashing the PyLink daemon.
sigterm_handler(_signo, _stack_frame)
Handles SIGTERM gracefully by shutting down the PyLink daemon.
+
spawn_service(irc, source, command, args)
Handles new service bot introductions.
unload(irc, source, args)
<plugin name>.
 
Unloads a currently loaded plugin.
@@ -68,5 +71,7 @@ Unloads a currently loaded plugin. Data         -log = <logging.RootLogger object> +log = <logging.RootLogger object>
+myident = 'pylink'
+mynick = 'PyLink' \ No newline at end of file diff --git a/docs/technical/autogen/hybrid.html b/docs/technical/autogen/hybrid.html index 55c681e..685af49 100644 --- a/docs/technical/autogen/hybrid.html +++ b/docs/technical/autogen/hybrid.html @@ -52,7 +52,9 @@  
Class = class HybridProtocol(ts6.TS6Protocol) -     +    +Base Protocol module class for PyLink.
  + 
Method resolution order:
HybridProtocol
ts6.TS6Protocol
@@ -62,11 +64,11 @@
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
connect(self)
Initializes a connection to a server.
-
handle_capab(self, numeric, command, args)
+
handle_capab(self, numeric, command, args)
Handles the CAPAB command, used for TS6 capability negotiation.
handle_eob(self, numeric, command, args)
@@ -253,7 +255,9 @@ Data descriptors inherited from classes.Protocol  
class HybridProtocol(ts6.TS6Protocol) -     +    +Base Protocol module class for PyLink.
  + 
Method resolution order:
HybridProtocol
ts6.TS6Protocol
@@ -263,11 +267,11 @@ Data descriptors inherited from classes.Protocol
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
connect(self)
Initializes a connection to a server.
-
handle_capab(self, numeric, command, args)
+
handle_capab(self, numeric, command, args)
Handles the CAPAB command, used for TS6 capability negotiation.
handle_eob(self, numeric, command, args)
@@ -455,7 +459,7 @@ 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 0x7f183a5c3bf8>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f737f074378>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/inspircd.html b/docs/technical/autogen/inspircd.html index 422c4cc..6df8d9a 100644 --- a/docs/technical/autogen/inspircd.html +++ b/docs/technical/autogen/inspircd.html @@ -52,7 +52,9 @@  
Class = class InspIRCdProtocol(ts6_common.TS6BaseProtocol) -     +    +Base Protocol module class for PyLink.
  + 
Method resolution order:
InspIRCdProtocol
ts6_common.TS6BaseProtocol
@@ -61,7 +63,7 @@
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
to unset AWAY status.
@@ -136,7 +138,8 @@ servers.
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
-
numeric(self, source, numeric, target, text)
+
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
+replies.
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
automatically by the Irc() internals; plugins shouldn't have to use this.
@@ -248,7 +251,9 @@ Data descriptors inherited from classes.Protocol  
class InspIRCdProtocol(ts6_common.TS6BaseProtocol) -     +    +Base Protocol module class for PyLink.
  + 
Method resolution order:
InspIRCdProtocol
ts6_common.TS6BaseProtocol
@@ -257,7 +262,7 @@ Data descriptors inherited from classes.Protocol
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
to unset AWAY status.
@@ -332,7 +337,8 @@ servers.
mode(self, numeric, target, modes, ts=None)
Sends mode changes from a PyLink client/server.
-
numeric(self, source, numeric, target, text)
+
numeric(self, source, numeric, target, text)
Sends raw numerics from a server to a remote client, used for WHOIS
+replies.
ping(self, source=None, target=None)
Sends a PING to a target server. Periodic PINGs are sent to our uplink
automatically by the Irc() internals; plugins shouldn't have to use this.
@@ -445,7 +451,7 @@ 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 0x7fb165343f28>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7ff146c496a8>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/log.html b/docs/technical/autogen/log.html index 0f134b3..5bde462 100644 --- a/docs/technical/autogen/log.html +++ b/docs/technical/autogen/log.html @@ -57,7 +57,8 @@ access the global logger object by importing 
Methods defined here:
-
__init__(self, irc, channel, level=None)
+
__init__(self, irc, channel, level=None)
Initializes the instance - basically setting the formatter to None
+and the filter list to empty.
emit(self, record)
Logs a record to the configured channels for the network given.
@@ -125,7 +126,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,7 +155,7 @@ 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 0x7f81857da950>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f496c510e18>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/nefarious.html b/docs/technical/autogen/nefarious.html index e01c878..9357aba 100644 --- a/docs/technical/autogen/nefarious.html +++ b/docs/technical/autogen/nefarious.html @@ -64,7 +64,9 @@  
Class = class P10Protocol(classes.Protocol) -     +    +Base Protocol module class for PyLink.
  + 
Method resolution order:
P10Protocol
classes.Protocol
@@ -72,7 +74,7 @@
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
to unset AWAY status.
@@ -231,7 +233,9 @@ Data descriptors inherited from classes.Protocol  
class P10Protocol(classes.Protocol) -     +    +Base Protocol module class for PyLink.
  + 
Method resolution order:
P10Protocol
classes.Protocol
@@ -239,7 +243,7 @@ Data descriptors inherited from classes.Protocol
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
to unset AWAY status.
@@ -400,7 +404,7 @@ Data descriptors inherited from classes.Protocol      Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
next_sid(self)
Returns the next available SID.
@@ -428,7 +432,7 @@ Data descriptors defined here:
Methods defined here:
-
__init__(self, sid)
+
__init__(self, sid)
Initialize self.  See help(type(self)) for accurate signature.
Methods inherited from utils.IncrementalUIDGenerator:
@@ -460,7 +464,7 @@ https://github.com/evilnet/nefarious2/blob/a29b63144/doc/p10.txt#L69-L92Data         -conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f4243176488>, {})}
+conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7fcf7b6db510>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/structures.html b/docs/technical/autogen/structures.html index d8d8555..7495a92 100644 --- a/docs/technical/autogen/structures.html +++ b/docs/technical/autogen/structures.html @@ -20,7 +20,8 @@ This module contains custom data structures that&n        
collections
-

+json
+

 
@@ -28,6 +29,12 @@ This module contains custom data structures that&n
       
+
builtins.object +
+
+
DataStore +
+
collections.defaultdict(builtins.dict)
@@ -39,6 +46,46 @@ This module contains custom data structures that&n + + +
 
+class DataStore(builtins.object)
    Methods defined here:
+
__contains__(self, key)
# single keys
+ +
__init__(self, name, filename, db_format='json', save_frequency={'seconds': 30})
Initialize self.  See help(type(self)) for accurate signature.
+ +
create_or_load(self)
+ +
delete(self, key)
+ +
delete_keys(self, prefix)
Delete all keys with the given prefix.
+ +
get(self, key, default=None)
+ +
list_keys(self, prefix=None)
Return all key names. If prefix given, return only keys that start with it.
+ +
put(self, key, value)
+ +
save(self)
+ +
save_callback(self, starting=False)
Start the DB save loop.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
initial_version = 1
+ +

+ + + @@ -52,7 +99,10 @@ This module contains custom data structures that&n
Methods defined here:
-
__missing__(self, key)
+
__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:
@@ -105,7 +155,7 @@ Methods inherited from builtins.dict:
__ne__(self, value, /)
Return self!=value.
-
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
+
__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.
@@ -117,9 +167,9 @@ Methods inherited from builtins.dict:
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
+
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
+
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
@@ -134,7 +184,7 @@ If E is present and has 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
+
values(...)
D.values() -> an object providing a view on D's values
Data and other attributes inherited from builtins.dict:
diff --git a/docs/technical/autogen/ts6.html b/docs/technical/autogen/ts6.html index 4f3226a..cf678c9 100644 --- a/docs/technical/autogen/ts6.html +++ b/docs/technical/autogen/ts6.html @@ -52,7 +52,9 @@ - + + + - + + + - - + + + - - + + + - + + + - -
 
class KeyedDefaultdict(collections.defaultdict)
     
Class = class TS6Protocol(ts6_common.TS6BaseProtocol)
    
   Base Protocol module class for PyLink.
 
 
Method resolution order:
TS6Protocol
ts6_common.TS6BaseProtocol
@@ -61,7 +63,7 @@
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
connect(self)
Initializes a connection to a server.
@@ -242,7 +244,9 @@ Data descriptors inherited from classes.Protocol 		 
class TS6Protocol(ts6_common.TS6BaseProtocol)
    
   Base Protocol module class for PyLink.
 
 
Method resolution order:
TS6Protocol
ts6_common.TS6BaseProtocol
@@ -251,7 +255,7 @@ Data descriptors inherited from classes.Protocol
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
connect(self)
Initializes a connection to a server.
@@ -433,7 +437,7 @@ 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 0x7f8cbdc44c80>, {})}
+		conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f3f91da9488>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/ts6_common.html b/docs/technical/autogen/ts6_common.html index d5a91c8..95f1421 100644 --- a/docs/technical/autogen/ts6_common.html +++ b/docs/technical/autogen/ts6_common.html @@ -63,7 +63,9 @@ 		 
class TS6BaseProtocol(classes.Protocol)
    
   Base Protocol module class for PyLink.
 
 
Method resolution order:
TS6BaseProtocol
classes.Protocol
@@ -71,7 +73,7 @@
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
away(self, source, text)
Sends an AWAY message from a PyLink client. <text> can be an empty string
to unset AWAY status.
@@ -183,7 +185,7 @@ Example queries:
    "6##" would give: 600, 601, 602, ... 60Y, 60Z, 610, 611, ... 6ZZ (1296 total results)
 
  Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
increment(self, pos=2)
Increments the SID generator to the next available SID.
@@ -213,7 +215,7 @@ Data descriptors defined here:
Methods defined here:
-
__init__(self, sid)
+
__init__(self, sid)
Initialize self.  See help(type(self)) for accurate signature.
Methods inherited from utils.IncrementalUIDGenerator:
@@ -236,7 +238,7 @@ Data descriptors inherited from uti Data
       conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f683a0b9d90>, {})}
+		conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f1e3a24e488>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/unreal.html b/docs/technical/autogen/unreal.html index 4d1cf3d..5d8894c 100644 --- a/docs/technical/autogen/unreal.html +++ b/docs/technical/autogen/unreal.html @@ -53,7 +53,9 @@ 		 
Class = class UnrealProtocol(ts6_common.TS6BaseProtocol)
    
   Base Protocol module class for PyLink.
 
 
Method resolution order:
UnrealProtocol
ts6_common.TS6BaseProtocol
@@ -62,7 +64,7 @@
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
checkCloakChange(self, uid, parsedmodes)
Checks whether +x/-x was set in the mode query, and changes the
hostname of the user given to or from their cloaked host if True.
@@ -95,7 +97,7 @@ hostname of the user given to or from th
handle_pong(self, source, command, args)
-
handle_privmsg(self, source, command, args)
+
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
handle_protoctl(self, numeric, command, args)
Handles protocol negotiation.
@@ -246,7 +248,9 @@ Data descriptors inherited from classes.Protocol 		 
class UnrealProtocol(ts6_common.TS6BaseProtocol)
    
   Base Protocol module class for PyLink.
 
 
Method resolution order:
UnrealProtocol
ts6_common.TS6BaseProtocol
@@ -255,7 +259,7 @@ Data descriptors inherited from classes.Protocol
Methods defined here:
-
__init__(self, irc)
+
__init__(self, irc)
Initialize self.  See help(type(self)) for accurate signature.
checkCloakChange(self, uid, parsedmodes)
Checks whether +x/-x was set in the mode query, and changes the
hostname of the user given to or from their cloaked host if True.
@@ -288,7 +292,7 @@ hostname of the user given to or from th
handle_pong(self, source, command, args)
-
handle_privmsg(self, source, command, args)
+
handle_privmsg(self, source, command, args)
Handles incoming PRIVMSG/NOTICE.
handle_protoctl(self, numeric, command, args)
Handles protocol negotiation.
@@ -440,7 +444,7 @@ 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 0x7fcbbf211620>, {})}
+		conf = {'bot': {'nick': 'PyLink', 'realname': 'PyLink Service Client', 'serverdesc': 'PyLink unit tests', 'user': 'pylink'}, 'logging': {'stdout': 'CRITICAL'}, 'servers': defaultdict(<function <lambda> at 0x7f19895c4bf8>, {})}
confname = 'testconf'
curdir = '/home/gl/pylink'
files = None
diff --git a/docs/technical/autogen/utils.html b/docs/technical/autogen/utils.html index cc11f71..8c3273a 100644 --- a/docs/technical/autogen/utils.html +++ b/docs/technical/autogen/utils.html @@ -20,13 +20,14 @@ framework.

Modules
       
conf
-importlib
-		os
-re
-		string
-world
-

+

collections
+conf
+		importlib
+os
+		re
+string
+		world
+

 
@@ -34,10 +35,17 @@ framework.

       
+
builtins.Exception(builtins.BaseException) +
+
+
NotAuthenticatedError +
+
builtins.object
IncrementalUIDGenerator +
ServiceBot
@@ -52,12 +60,113 @@ framework.

https://github.com/inspircd/inspircd/blob/f449c6b296ab/src/server.cpp#L85-L156
 
  Methods defined here:
-
__init__(self, sid)
+
__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__
@@ -97,6 +206,8 @@ would return '<dbname>-testing.db'.
['+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.

diff --git a/docs/technical/autogen/world.html b/docs/technical/autogen/world.html index 04275cf..2dad6d2 100644 --- a/docs/technical/autogen/world.html +++ b/docs/technical/autogen/world.html @@ -27,16 +27,15 @@ Data -
       commands = defaultdict(<class 'list'>, {})
-hooks = defaultdict(<class 'list'>, {})
+		hooks = defaultdict(<class 'list'>, {})
networkobjects = {}
plugins = {}
plugins_folder = '/home/gl/pylink/plugins'
protocols_folder = '/home/gl/pylink/protocols'
+services = {}
source = 'https://github.com/GLolol/PyLink'
started = <threading.Event object>
testing = True
testing_ircd = 'inspircd'
-version = 'v0.8-alpha2-5-g6b40c97'
-whois_handlers = []
+version = 'v0.8-alpha2-60-g8c55eb4' \ No newline at end of file