tasbot Package

tasbot Package

Client Module

class tasbot.Client.Flags

norecwait = False

register = False

class tasbot.Client.ServerEvents

oncommandfromserver(command, args, socket)

onconnected()

onconnectedplugin()

ondisconnected()

onexit()

onloggedin(socket)

onmotd(content)

onpong()

onsaid(channel, user, message)

onsaidex(channel, user, message)

onsaidprivate(user, message)

class tasbot.Client.Tasclient(app)

Bases: object

the main interaction with server class

connect(server, port)

disconnect(hard=False)

join(channel)

leave(channel)

login(username, password, client, cpu, lanip='*')

mainloop()

parsecommand(command, args)

ping()

receive()

register(username, password)

say(channel, phrase)

sayex(channel, phrase)

class tasbot.Client.User(username, id, country, cpu)

clientstatus(status)

Main Module

class tasbot.Main.MainApp(configfile, pidfile, register, verbose)

Bases: tasbot.daemon.Daemon

main application object that has creates tasclient, pluginhandler and PingLoop instances

Dologin()

handle tasserver login

PingLoop()

sned a PING to the server every 10 seconds until either force_quit is true or i got into an error state

Register(username, password)

register new account on tasserver

ReloadConfig()

reload config and admins from file

SaveConfig()

commit current config dictionary to file

destroy()

deprecated

isAdmin(username)

return true if either username or the asscoiated id is in self.admins

onlogin(socket)

start PingLoop and client mainloop, connect event handlers

run()

the main loop for MainApp, once this exists MainApp will be in unsable state

ParseConfig Module

class tasbot.ParseConfig.Config(filename)

GetOptionList(key, seperator=', ', default=[])

GetSingleOption(key, default)

write(filename)

tasbot.ParseConfig.parselist(string, sep)

tasbot.ParseConfig.readconfigfile(filename)

tasbot.ParseConfig.writeconfigfile(filename, entries)

Plugin Module

class tasbot.Plugin.IPlugin(name, tasclient)

Bases: object

base class all plugins should derive from (and expose fitting ctor)

ondestroy()

tell myself i’m dying and try to stop all my threads

startThread(func, *args)

run a given function with args in a new thread that is added to an internal list

class tasbot.Plugin.PluginHandler(main)

Bases: object

manage runtime loaded modules (plugins)

addplugin(name, tasc)

try to import module name and init it

forall(func_name, *args)

execute a given function(name) on all plugins that expose it

forceunloadplugin(name, tasc)

simply removes name from internal list, only call if unload else fails

oncommandfromserver(command, args, socket)

onconnected()

ondisconnected()

onexit()

onloggedin(socket)

onmotd(content)

onpong()

onsaid(channel, user, message)

onsaidex(channel, user, message)

onsaidprivate(user, message)

react on a few given keywords and also pass the call to all plugins

reloadplugin(name)

broken

unloadAll()

convenience function to unload all plugins at once

unloadplugin(name)

unload plugin, stop all its threads via ondestroy and remove from interal list

class tasbot.Plugin.PluginThread(func, *args)

Bases: threading.Thread

tiny wrapper to execute function with args in a thread

run()

color_formatter Module

class tasbot.color_formatter.ColoredFormatter(msg, use_color=True)

Bases: logging.Formatter

format(record)

tasbot.color_formatter.formatter_message(message, use_color=True)

customlog Module

class tasbot.customlog.CLog

Bases: tasbot.customlog.ILogger

Init(logfile_name, level='info', stdout_log=True)

getPluginLogger(name)

class tasbot.customlog.ILogger(prefix=None)

Bases: object

Debug(msg, prefix=None)

Error(msg, prefix=None)

Except(e)

Info(msg, prefix=None)

bad(t)

good(t)

loaded(t)

notice(t)

reloaded(t)

class tasbot.customlog.PrefixedLogger(clog, name)

Bases: tasbot.customlog.ILogger

daemon Module

* Modified generic daemon class *

Author: http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/

www.boxedice.com

License: http://creativecommons.org/licenses/by-sa/3.0/

Changes: 23rd Jan 2009 (David Mytton <david@boxedice.com>)

• Replaced hard coded ‘/dev/null in __init__ with os.devnull
• Added OS check to conditionally remove code that doesn’t work on OS X
• Added output to console on completion
• Tidied up formatting

11th Mar 2009 (David Mytton <david@boxedice.com>) - Fixed problem with daemon exiting on Python 2.4 (before SystemExit was part of the Exception base) 13th Aug 2010 (David Mytton <david@boxedice.com> - Fixed unhandled exception if PID file is empty

class tasbot.daemon.Daemon(pidfile, stdin='/dev/null', stdout='/dev/null', stderr='/dev/null')

Bases: object

A generic daemon class.

Usage: subclass the Daemon class and override the run() method

daemonize()

Do the UNIX double-fork magic, see Stevens’ “Advanced Programming in the UNIX Environment” for details (ISBN 0201563177) http://www.erlenstar.demon.co.uk/unix/faq_2.html#SEC16

delpid()

restart()

Restart the daemon

run()

You should override this method when you subclass Daemon. It will be called after the process has been daemonized by start() or restart().

start()

Start the daemon

stop()

Stop the daemon

tasbot.daemon.check_pid(pid)

Check For the existence of a unix pid.

testplugin Module

class tasbot.testplugin.Main

oncommandfromserver(command, args, socket)

onconnected()

ondisconnected()

onexit()

onloggedin(socket)

onmotd(content)

onpong()

onsaid(channel, user, message)

onsaidex(channel, user, message)

onsaidprivate(user, message)

utilities Module

tasbot.utilities.getally(status)

tasbot.utilities.getaway(status)

tasbot.utilities.getbot(status)

tasbot.utilities.getcolor(status)

tasbot.utilities.gethand(status)

tasbot.utilities.getingame(status)

tasbot.utilities.getmod(status)

tasbot.utilities.getrank(status)

tasbot.utilities.getready(status)

tasbot.utilities.getside(status)

tasbot.utilities.getspec(status)

tasbot.utilities.getsync(status)

tasbot.utilities.getteam(status)

Subpackages

• plugins Package
  • join_channels Module
  • lag Module