Welcome to Spye’s documentation!

Contents:

class spye.baseplugin.plugin(parent)

Root plugin

complete(func, args)
config_get(key, default=None, require=False, subsection=None, section=None)
config_get_all(subsection=None, section=None)
config_get_boolean(key, default=None, require=False, subsection=None, section=None)
config_get_float(key, default=None, require=False, subsection=None, section=None)
config_get_integer(key, default=None, require=False, subsection=None, section=None)
config_get_string(key, default=None, require=False, subsection=None, section=None, glue=' ')
config_resolve(subsection, section)
config_section()
config_section_exists(subsection=None, section=None)
config_subsection_list(subsection=None, section=None)
debug_get_entrypoint()
debug_get_message()
debug_get_position()
docname(recursive=True)
dump_plugins(indent='')
execute(name, *args, **kwargs)
lookup(names)
match(re, line)
metafunction_find(name)
print_debug(msg, *fmt)
print_error(msg, *fmt)
print_exception()
print_fatal(msg, *fmt)
print_hint(msg, *fmt)
print_line(msg, *fmt)
print_minute(msg, *fmt)
print_note(msg, *fmt)
print_output(sev, msg, *fmt)
print_progress(percent, message='', prefix='', width=42)
print_progress_end(clear=True)
print_warn(msg, *fmt)
procname_meta_list()
read_boolean(prompt=None, default=None)
read_command(prompt=None, text=None, save=True, completion=None)
read_password(prompt='> ', text=None)
read_string(prompt='> ', text=None)
register(root, dir, files)
register_plugin(root, modname)
register_plugins(root, path='')
validate(name, *allargs, **kwargs)
class spye.config.file.plugin(root, name, input)
merge(merges)
parse(input)
section(name)
exception spye.config.ConfigErrorException
spye.config.register(path)
spye.config.register_file(name)
class spye.config.merge.plugin(root, merges)
class spye.config.section.plugin(root, name)
add(key, op, value)
apply(data)
class spye.editor.editor
append(data)
begin()
char_class(char)
commit(save=True)
delete_backwards_char()
delete_backwards_line()
delete_backwards_word()
delete_forward_char()
delete_forward_line()
delete_forward_word()
file_append(name, append=True)
file_load(name)
getlength()
getline()
getpos()
history_down()
history_up()
longest_common_prefix(strings)
move_backwards_char()
move_backwards_word()
move_end()
move_forward_char()
move_forward_word()
move_home()
scan_backwards_word(string, index)
scan_forward_word(string, index)
setline(value)
spye.framework.config_load(path)
spye.framework.config_load_global()
spye.framework.config_load_user()
spye.framework.configure()
spye.framework.enter()
spye.framework.history_load()
spye.framework.history_save()
spye.framework.homedir_check()
spye.framework.initialize()
spye.framework.leave()
spye.framework.parse_args(args=None)
spye.framework.parse_driver_args(args)
spye.framework.plugins_load(path)
spye.framework.plugins_load_global()
spye.framework.plugins_load_spye(path='/home/chrivers/software-development/spye/spye-python/spye')
spye.framework.plugins_load_user()
spye.framework.print_banner()
class spye.frontend.cgi.plugin(parent)

Console frontend for spye

request_execute(data)
request_get()
request_parse(uri)
run()
class spye.frontend.console.plugin(parent)

Console frontend for spye

request_execute(cmd)
request_get()
request_parse(cmd)
run()
class spye.frontend.http.SpyeHandler(request, client_address, server)
action()
do_GET()
do_HEAD()
do_POST()
log_error(format, *args)
log_message(format, *args)
respond(code, message=None, **headers)
send_error(code, error, message=None)
setup()
version_string()

Return the server software version string.

class spye.frontend.http.SpyeServer(parent, listen_addr, listen_port)
class spye.frontend.http.plugin(parent)

HTTP frontend for spye

configure(**args)
run()
class spye.frontend.plugin(parent)

Frontend plugin for spye

configure(**args)
enter()
leave()
class spye.input.console.plugin(parent)

Console-based input plugin

action_break()
action_clear()
action_cr()
action_default(char)
action_delete_backwards_char()
action_delete_backwards_line()
action_delete_backwards_word()
action_delete_forward_char()
action_delete_forward_line()
action_delete_forward_word()
action_down()
action_move_backwards_char()
action_move_backwards_word()
action_move_end()
action_move_forward_char()
action_move_forward_word()
action_move_home()
action_tab(completion=None)
action_up()
configure(*args)
raw_begin()
raw_end()
read_boolean(prompt=None, default=None)
read_char()
read_command(prompt=None, text=None, save=True, completion=None)
read_key()
read_password(prompt='> ', text=None)
read_string(prompt='> ', text=None)
unbound_key(key)
class spye.input.plugin(parent)

Plugin template for input plugins

configure(**args)
enter()
leave()
read_boolean(prompt=None, default=None)
read_command(prompt=None, text=None, save=True, completion=None)
read_password(prompt='> ', text=None)
read_string(prompt='> ', text=None)
class spye.input.null.plugin(parent)

Null input plugin

class spye.output.console.plugin(parent)

Output plugin for console output

configure(nocolor=False, noprogress=False, wfile=<open file '<stdout>', mode 'w' at 0x2ad6f12ba140>, **args)
get_size()
output_line(debug, msg, *fmt)
output_log(sev, debug, msg, *fmt)
output_progress(percent, message='', prefix='', width=42)
output_progress_end(clear=True)
prompt_print()
screen_clear()
class spye.output.html.plugin(parent)

Output plugin for console output

configure(nocolor=False, noprogress=False, wfile=<open file '<stdout>', mode 'w' at 0x2ad6f12ba140>, **args)
enter()
leave()
output_log(sev, debug, msg, *fmt)
prompt_print()
screen_clear()
write(msg)
class spye.output.plugin(parent)

Default output plugin

buffer_end(discard=False)
buffer_start()
configure(**args)
enter()
flush()
leave()
output_backtrace()
output_exception()
output_line(debug, msg, *fmt)
output_log(sev, debug, msg, *fmt)
output_progress(percent, message='', prefix='', width=42)
output_progress_end(clear=True)
output_traceback(tb)
prompt_begin(s)
prompt_end()
prompt_make(p)
prompt_print()
prompt_size(s)
write(msg)
class spye.output.null.plugin(parent)

Null output plugin

configure(**args)
flush()
log(sev, color, msg, *fmt)
output_backtrace()
output_exception()
output_progress(percent, message='', prefix='', width=42)
output_progress_end(clear=True)
output_traceback(tb)
write(msg)
class spye.output.stdout.plugin(parent)

Output plugin for console output

configure(noprogress=False, wfile=<open file '<stdout>', mode 'w' at 0x2ad6f12ba140>, **args)
log(sev, color, msg, *fmt)
output_progress(percent, message='', prefix='', width=42)
output_progress_end(clear=True)
prompt_print()
screen_clear()
class spye.output.syslog.plugin(parent)

Output plugin for syslog output

configure(**args)
output_line(debug, msg, *fmt)
output_log(sev, debug, msg, *fmt)
output_progress(percent, message='', prefix='', width=42)
output_progress_end(clear=True)
prompt_print()
write(msg)
class spye.presentation.console.plugin(parent)

Base template for presentation plugins

present__str(value)
class spye.presentation.html.plugin(parent)

Base template for presentation plugins

present__generator(value)
class spye.presentation.plugin(parent)

Base template for presentation plugins

configure(wfile=<open file '<stdout>', mode 'w' at 0x2ad6f12ba140>, **args)
enter()
error(result, name)
leave()
output(value)
present(result)
present__NoneType(value)
class spye.presentation.rpc.plugin(parent)

Remote Procedure Call interface for spye

present(result)
class spye.presentation.text.plugin(parent)

Base template for presentation plugins

present(result)
class spye.util.db.cursor(parent, cur)
execute(query, *args)
next()
next_dict()
class spye.util.db.database(parent, db)
commit()
cursor()
execute_and_commit(query, *args)
fetch_dict(query, *args)
fetch_row(query, *args)
fetch_value(query, *args)
query(query, *args)
rollback()
class spye.util.db.plugin(parent)

Database utility code for spye

config_get(obj)
connect(host, dbname, user, password, port='5432', ssl='require')
connect_config(obj)
connect_string(connstring)
class spye.util.html.HTMLTag(*items, **attr)
append(element)
extend(element)
str_begin()
str_end()
str_items()
class spye.util.html.Tdel(*items, **attr)
class spye.util.html.a(*items, **attr)
class spye.util.html.abbr(*items, **attr)
class spye.util.html.acronym(*items, **attr)
class spye.util.html.address(*items, **attr)
class spye.util.html.area(*items, **attr)
class spye.util.html.b(*items, **attr)
class spye.util.html.base(*items, **attr)
class spye.util.html.bdo(*items, **attr)
class spye.util.html.big(*items, **attr)
class spye.util.html.blockquote(*items, **attr)
class spye.util.html.body(*items, **attr)
class spye.util.html.br(*items, **attr)
class spye.util.html.button(*items, **attr)
class spye.util.html.caption(*items, **attr)
class spye.util.html.cite(*items, **attr)
class spye.util.html.code(*items, **attr)
class spye.util.html.col(*items, **attr)
class spye.util.html.colgroup(*items, **attr)
class spye.util.html.dd(*items, **attr)
class spye.util.html.dfn(*items, **attr)
class spye.util.html.div(*items, **attr)
class spye.util.html.dl(*items, **attr)
class spye.util.html.dt(*items, **attr)
class spye.util.html.em(*items, **attr)
class spye.util.html.fieldset(*items, **attr)
class spye.util.html.form(*items, **attr)
class spye.util.html.frame(*items, **attr)
class spye.util.html.frameset(*items, **attr)
class spye.util.html.h1(*items, **attr)
class spye.util.html.h2(*items, **attr)
class spye.util.html.h3(*items, **attr)
class spye.util.html.h4(*items, **attr)
class spye.util.html.h5(*items, **attr)
class spye.util.html.h6(*items, **attr)
class spye.util.html.head(*items, **attr)
class spye.util.html.hr(*items, **attr)
class spye.util.html.html(*items, **attr)
class spye.util.html.i(*items, **attr)
class spye.util.html.iframe(*items, **attr)
class spye.util.html.img(*items, **attr)
class spye.util.html.input(*items, **attr)
class spye.util.html.ins(*items, **attr)
class spye.util.html.kbd(*items, **attr)
class spye.util.html.label(*items, **attr)
class spye.util.html.legend(*items, **attr)
class spye.util.html.li(*items, **attr)
class spye.util.html.map(*items, **attr)
class spye.util.html.meta(*items, **attr)
class spye.util.html.noframes(*items, **attr)
class spye.util.html.noscript(*items, **attr)
class spye.util.html.object(*items, **attr)
class spye.util.html.ol(*items, **attr)
class spye.util.html.optgroup(*items, **attr)
class spye.util.html.option(*items, **attr)
class spye.util.html.p(*items, **attr)
class spye.util.html.param(*items, **attr)
class spye.util.html.pre(*items, **attr)
class spye.util.html.q(*items, **attr)
class spye.util.html.samp(*items, **attr)
class spye.util.html.script(*items, **attr)
class spye.util.html.select(*items, **attr)
class spye.util.html.small(*items, **attr)
class spye.util.html.span(*items, **attr)
class spye.util.html.strong(*items, **attr)
class spye.util.html.style(*items, **attr)
class spye.util.html.sub(*items, **attr)
class spye.util.html.sup(*items, **attr)
class spye.util.html.table(*items, **attr)
class spye.util.html.tbody(*items, **attr)
class spye.util.html.td(*items, **attr)
class spye.util.html.textarea(*items, **attr)
class spye.util.html.tfoot(*items, **attr)
class spye.util.html.th(*items, **attr)
class spye.util.html.thead(*items, **attr)
class spye.util.html.title(*items, **attr)
class spye.util.html.tr(*items, **attr)
class spye.util.html.tt(*items, **attr)
class spye.util.html.ul(*items, **attr)
class spye.util.html.var(*items, **attr)
class spye.util.plugin(parent)
class spye.util.mail.plugin(parent)

Mail utility code for spye

send(message, server='localhost')
set_envelope(From, To)
set_headers(flowed=True, **headers)
class spye.util.rpc.HTTPCaller(parent, server, port)
build_get(func, *args, **kwargs)
build_post(func, *args, **kwargs)
call(func, *args, **kwargs)
class spye.util.rpc.plugin(parent)
create_http(server, port=None)
class spye.validation.Invalid(fmt, *args)
class spye.validation.Valid
valid(valueclass, raw, *args)
validate(value)
class spye.validation.ValidBool
validate(value)
class spye.validation.ValidFloat(minval=None, maxval=None)
validate(value)
class spye.validation.ValidInt(minval=None, maxval=None, base=10)
validate(value)
class spye.validation.ValidList(itemvalidator)
validate(value)
class spye.validation.ValidString(minlen=None, maxlen=None, allowed_chars=None)
validate(value)
class spye.validation.ValidatedBool
class spye.validation.ValidatedComplex
class spye.validation.ValidatedEmail
class spye.validation.ValidatedFloat
class spye.validation.ValidatedInt
class spye.validation.ValidatedList
class spye.validation.ValidatedString
class spye.validation.ValidatedUnicode

Indices and tables

Table Of Contents

This Page