rext package

Subpackages

• rext.contrib package
  • Submodules
    • rext.contrib.feedparser module
    • rext.contrib.rijndael module
  • Module contents
• rext.plugs package
  • Submodules
    • rext.plugs.add module
    • rext.plugs.all module
    • rext.plugs.api module
    • rext.plugs.cfg module
    • rext.plugs.dump module
    • rext.plugs.find module
    • rext.plugs.first module
    • rext.plugs.init module
    • rext.plugs.irc module
    • rext.plugs.join module
    • rext.plugs.last module
    • rext.plugs.ls module
    • rext.plugs.mbox module
    • rext.plugs.rm module
    • rext.plugs.rss module
    • rext.plugs.slice module
    • rext.plugs.spider module
    • rext.plugs.status module
    • rext.plugs.test module
    • rext.plugs.timer module
    • rext.plugs.udp module
    • rext.plugs.version module
    • rext.plugs.wiki module
    • rext.plugs.xmpp module
  • Module contents

Submodules

• rext.completer module
• rext.defines module
• rext.log module
• rext.test module
• rext.utils module

Module contents

Basic package for the Rext program.

Defines all the basic Objects and functionality.

class Bot(zelf, *args, **kwargs)

Bases: rext.Dispatcher

Base Bot class.

announce(zelf, *args, **kwargs)

begin(zelf, *args, **kwargs)

connect(zelf, *args, **kwargs)

do_one(zelf, *args, **kwargs)

exit(zelf, *args, **kwargs)

get_prompt(zelf, *args, **kwargs)

join_channels(zelf, *args, **kwargs)

set_cfg(zelf, *args, **kwargs)

class ConsoleBot(zelf, *args, **kwargs)

Bases: rext.Bot

boot(zelf, *args, **kwargs)

do_one(zelf, *args, **kwargs)

get_prompt(zelf, *args, **kwargs)

say(zelf, *args, **kwargs)

class Dispatcher(zelf, *args, **kwargs)

Bases: rext.Object

The Dispatcher is the object to delegate the workload to the Runners. Runners get instantiated when needed.

cleanup(zelf, dojoin=False)

Remove idle Runners.

dispatch(zelf, *args, **kwargs)

dispatch an event (object) onto a runner if matching command is found.

do_func(zelf, *args, **kwargs)

Execute command/event pair if command is registered.

execute(zelf, *args, **kwargs)

Execute a command, event pair. If the “threaded” attribute is set, dispatch to a Runner.

exit(zelf, name=None)

Stop the Runners running in this Dispatcher.

is_alive(zelf, *args, **kwargs)

Check whether there are any Runners running.

make_new(zelf, *args, **kwargs)

Create a Runner, try for idle Runners already available first.

put(zelf, *args, **kwargs)

Put load to the Runner, create a new Runner if necessary.

register(zelf, *args, **kwargs)

register a callback type with corresponding callback function.

exception Error

Bases: builtins.BaseException

Basic Exception used in the Rext program.

exception FileNotFoundError

Bases: rext.Error

Exception thrown when file is not found.

class IRCBot(zelf, *args, **kwargs)

Bases: rext.Bot

action(zelf, printto, what, event=None, *args, **kwargs)

bind(zelf)

broadcast(zelf, txt)

cc = '.'

close(zelf)

connect(zelf, reconnect=True)

ctcp(zelf, printto, what)

ctcpreply(zelf, printto, what)

delop(zelf, channel, who)

do_one(zelf, *args, **kwargs)

donick(zelf, nick, setorig=False, save=False, whois=False)

doop(zelf, channel, who)

getchannelmode(zelf, channel)

handle_366(zelf, *args, **kwargs)

handle_433(zelf, event)

handle_513(zelf, event)

handle_ctcp(zelf, event)

handle_invite(zelf, event)

handle_notice(zelf, event)

handle_ping(zelf, event)

handle_privmsg(zelf, event)

join(zelf, channel, password=None)

join_channels(zelf, *args, **kwargs)

logon(zelf)

marker = '\r\n'

names(zelf, channel)

notice(zelf, printto, what)

part(zelf, channel)

ping(zelf, *args, **kwargs)

pong(zelf, *args, **kwargs)

privmsg(zelf, printto, what)

quit(zelf, reason='https://pikacode.com/bthate/z2')

read_some(zelf, *args, **kwargs)

say(zelf, *args, **kwargs)

send(zelf, txt)

settopic(zelf, channel, txt)

voice(zelf, channel, who)

who(zelf, who)

whois(zelf, who)

class Looper(zelf, *args, **kwargs)

Bases: rext.Object

A Looper calls a function every x seconds.

func_do(zelf, *args, **kwargs)

start(zelf, *args, **kwargs)

exception NoJSON

Bases: rext.Error

Exception thrown incase no JSON could be decoded/encoded.

exception NoTarget

Bases: rext.Error

Exception thrown incase of missing argument attribute.

exception NotSet

Bases: rext.Error

Exception thrown when a attribute is not set.

class Object

Bases: builtins.dict

THE Basic Object on which the rest of the Rext program is based.

announce(zelf, *args, **kwargs)

announce to all the running bots.

check_notwanted(zelf, *args, **kwargs)

function to check whether an objects is not desired, first argument is a dict that has the attributes to be matched.

check_wanted(zelf, *args, **kwargs)

function to check whether an objects is desired, first argument is a dict that has the attributes to be matched.

clear(zelf)

clear the object’s ready state.

define(zelf, *args, **kwargs)

set a attribute on this object.

dump(zelf, *args, **kwargs)

create a JSON string ready to be saved to disk.

exec_str(zelf, *args, **kwargs)

execute a string as a command.

first(zelf, *args, **kwargs)

return the first object where the key and/or value matches.

get_args(zelf, *args, **kwargs)

get the arguments of the txt attribute.

get_clean(zelf, *args, **kwargs)

return a cloned object, with only the proper keys used.

get_cmnd(zelf, *args, **kwargs)

determine the command in the zelf.txt attribute, if present.

get_days(zelf, *args, **kwargs)

get the number of days relative to the objects creation time.

get_filetime(zelf, *args, **kwargs)

get timestamp related filename.

get_keys(zelf, *args, **kwargs)

return the keys of this object, skipping the unwanted keys e.g those that start with a “_”.

get_parsed(zelf, *args, **kwargs)

parse the txt attribute, so command can be determined.

get_rest(zelf, *args, **kwargs)

get the rest of the txt arguments (words) e.g. minus the first word (the command).

get_root(zelf, *args, **kwargs)

return the root dir of the Rext program.

get_slice(zelf, *args, **kwargs)

args: list of keywords to slice the dict.

get_timed(zelf, *args, **kwargs)

retrieve the creation time of an object.

get_url_file(zelf, *args, **kwargs)

get the url of the object’s file so that it can be retrieved when API server is running.

get_url_show(zelf, *args, **kwargs)

return url that gives a readable representation of the object’s JSON file.

last(zelf, *args, **kwargs)

return the last object where the key and/or value matches.

load(zelf, *args, **kwargs)

load a JSON file into this object.

make_path(zelf, *args, **kwargs)

return workdir path and create the workdir if necessary.

make_signature(zelf, sig=None)

create a signature of the data contained in this object.

obj_iter(zelf, *args, **kwargs)

iterate over the pure keys (not starting with “_”).

objects(zelf, *args, **kwargs)

return a list of all object’s in the workdir.

pretty(zelf)

return a nice formatted JSON string of this object.

read(zelf, *args, **kwargs)

read the JSON file from disk.

ready(zelf)

signal the object into the ready state.

register(zelf, *args, **kwargs)

register a value in a list on this object.

reply(zelf, *args, **kwargs)

send reply to object’s origin.

save(zelf, *args, **kwargs)

save this object’s JSON onto disk.

say(zelf, *args, **kwargs)

output text through the _target attribute (the bot that received the object).

selected(zelf, *args, **kwargs)

return a list of desired objects, first argument is a dict giving the desired attributes.

selector(zelf, *args, **kwargs)

boolean function to see if this objects has the desired attributes.

show(zelf)

return a list of key,value pairs of this object’s attributes.

sync(zelf, *args, **kwargs)

sync this object’s JSON to disk.

to_full(zelf, *args, **kwargs)

return full JSON dump of this object.

to_json(zelf, *args, **kwargs)

return the JSON string representation of this object.

wait(zelf, sec=180.0)

wait for the object to be put in a ready state.

class Plugins(zelf, *args, **kwargs)

Bases: rext.Object

Object to register Plugins with.

do_init(zelf, *args, **kwargs)

Call the init function of all plugin or a specific one if argument is given.

exit(zelf, *args, **kwargs)

close all plugins by calling there shutdown() function.

get_names(zelf, plugsdir)

Return plugnames from the plugin directory.

load_mod(zelf, plugname, pdir='', force=False)

load a plugin;’s module.

load_package(zelf, modname)

Load the plugins package.

load_plugs(zelf, path)

Load plugins from the plugin directory.

plug_init(zelf, *args, **kwargs)

Initialize a plugin, use the init() function provided in the plugin, if available.

plug_shutdown(zelf, plugname)

Shutdown a plugin by calling the shutdown() function, if provided.

reload(zelf, plugname, force=False)

Reload (unload, load) a plugin.

exception RemoteDisconnect

Bases: rext.Error

Exception thrown when the connection is disconnected.

class Runner(zelf, *args, **kwargs)

Bases: threading.Thread

The working unit of the Rext program, arguments are function, objects pairs pushed to the Runner.

exit(zelf, *args, **kwargs)

stop the Runner by setting the status to an empty string.

put(zelf, *args, **kwargs)

put arguments/kwargs to the Runner.

class XMPPBot(zelf, *args, **kwargs)

Bases: rext.Bot

announce(zelf, *args, **kwargs)

connect(zelf)

do_one(zelf, *args, **kwargs)

exception(zelf, ex)

handle_connected(zelf, *args, **kwargs)

handle_disconnected(zelf, *args, **kwargs)

handle_failedauth(zelf, error, *args)

handle_failure(zelf, ex, *args, **kwargs)

handle_message(zelf, data, *args, **kwargs)

handle_presence(zelf, data, *args, **kwargs)

loop(zelf, *args, **kwargs)

say(zelf, *args, **kwargs)

session_start(zelf, event)

boot(*args, **kwargs)

The boot() function is needed to get the Rext program properly initialized. Use it at the beginning of your program.

irc_parse(obj, *args, **kwargs)

shutdown()

The shutdown() function is used to close the Rext program in a apropiate manner.