core package

Subpackages

• core.plugs package
  • Submodules
    • core.plugs.add module
    • core.plugs.all module
    • core.plugs.allow module
    • core.plugs.api module
    • core.plugs.clone module
    • core.plugs.cmnds module
    • core.plugs.deny module
    • core.plugs.edit module
    • core.plugs.find module
    • core.plugs.first module
    • core.plugs.irc module
    • core.plugs.join module
    • core.plugs.last module
    • core.plugs.log module
    • core.plugs.manage module
    • core.plugs.mbox module
    • core.plugs.reload module
    • core.plugs.rm module
    • core.plugs.rss module
    • core.plugs.show module
    • core.plugs.test module
    • core.plugs.timer module
    • core.plugs.trim module
    • core.plugs.udp module
    • core.plugs.version module
    • core.plugs.xmpp module
  • Module contents

Submodules

• core.bots module
• core.completer module
• core.defines module
• core.dispatch module
• core.errors module
• core.log module
• core.looper module
• core.plugins module
• core.test module
• core.utils module

Module contents

basic package for the program.

class Object

Bases: builtins.dict

basic Object on which the rest of the program is based.

announce(zelf, *args, **kwargs)

announce to all the running cores.

check_notwanted(zelf, *args, **kwargs)

whether an object is not desired.

check_wanted(zelf, *args, **kwargs)

whether an object is desired.

clear(zelf)

clear the ready state.

define(zelf, *args, **kwargs)

set a attribute on this object.

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_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 object’s creation time.

get_filetime(zelf, *args, **kwargs)

timestamp of related filename.

get_keys(zelf, *args, **kwargs)

skip the unwanted keys e.g those that start with a “_”.

get_obj(zelf, *args, **kwargs)

cloned object, with only the proper keys used.

get_parsed(zelf, *args, **kwargs)

parse the txt attribute.

get_path(zelf, *args, **kwargs)

timestamp of related filename.

get_rest(zelf, *args, **kwargs)

get the rest of the txt attribute.

get_root(zelf, *args, **kwargs)

root directory of the program.

get_slice(zelf, *args, **kwargs)

take a slice of the Object.

get_timed(zelf, *args, **kwargs)

retrieve the creation time of an object.

get_url(zelf, *args, **kwargs)

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

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)

create workdir if necessary.

make_signature(zelf, sig=None)

signature of the data contained in this object.

objects(zelf, *args, **kwargs)

list of all object’s.

ok(zelf, *args, **kwargs)

signal ok.

pretty(zelf)

nice formatted JSON string of this object.

read(zelf, *args, **kwargs)

read the JSON file from disk.

ready(zelf)

signal to ready state.

register(zelf, *args, **kwargs)

register a value in a list on this object.

remove(zelf, *args, **kwargs)

reply(zelf, *args, **kwargs)

send reply to origin.

save(zelf, *args, **kwargs)

save JSON to disk.

say(zelf, *args, **kwargs)

output text through the _target attribute.

selected(zelf, *args, **kwargs)

list of desired objects.

selector(zelf, *args, **kwargs)

see if this objects has the desired attributes.

show(zelf)

list of key,value pairs.

sync(zelf, *args, **kwargs)

sync JSON to disk.

to_disk(zelf, *args, **kwargs)

create JSON ready to be saved to disk.

to_full(zelf, *args, **kwargs)

full JSON dump of this object.

to_json(zelf, *args, **kwargs)

JSON string representation of this object.

wait(zelf, sec=180.0)

wait for ready state.

write(zelf, *args, **kwargs)

actual write to disk.

boot(*args, **kwargs)

get the program properly initialized.

shutdown()

close the program in a appropiate manner.