Package rivescript :: Class RiveScript

Class RiveScript

A RiveScript interpreter for Python 2.

Instance Methods

[hide private]

__init__(self, debug=False, strict=True, depth=50, log='')
Initialize a new RiveScript interpreter. source code

_say(self, message)

source code

_warn(self, message, fname='', lineno=0) source code

load_directory(self, directory, ext='.rs')
Load RiveScript documents from a directory. source code

load_file(self, filename)
Load and parse a RiveScript document.

source code

stream(self, code)
Stream in RiveScript source code dynamically.

source code

_parse(self, fname, code)
Parse RiveScript code into memory.

source code

check_syntax(self, cmd, line)
Syntax check a RiveScript command and line.

source code

_initTT(self, toplevel, topic, trigger, what='')
Initialize a Topic Tree data structure. source code

sort_replies(self, thats=False)
Sort the loaded triggers.

source code

_sort_that_triggers(self)
Make a sorted list of triggers that correspond to %Previous groups.

source code

_sort_trigger_set(self, triggers)
Sort a group of triggers in optimal sorting order.

source code

_sort_list(self, name, items)
Sort a simple list by number of words and length.

source code

_init_sort_track(self)
Returns a new dict for keeping track of triggers for sorting.

source code

set_handler(self, language, obj)
Define a custom language handler for RiveScript objects.

source code

set_subroutine(self, name, code)
Define a Python object from your program.

source code

set_global(self, name, value)
Set a global variable.

source code

set_variable(self, name, value)
Set a bot variable.

source code

set_substitution(self, what, rep)
Set a substitution.

source code

set_person(self, what, rep)
Set a person substitution.

source code

set_uservar(self, user, name, value)
Set a variable for a user.

source code

get_uservar(self, user, name)
Get a variable about a user.

source code

get_uservars(self, user=None)
Get all variables about a user (or all users).

source code

clear_uservars(self, user=None)
Delete all variables about a user (or all users).

source code

freeze_uservars(self, user)
Freeze the variable state for a user.

source code

thaw_uservars(self, user, action='thaw')
Thaw a user's frozen variables. source code

last_match(self, user)
Get the last trigger matched for the user.

source code

reply(self, user, msg)
Fetch a reply from the RiveScript brain.

source code

_format_message(self, msg)
Format a user's message for safe processing.

source code

_getreply(self, user, msg, context='normal', step=0) source code

_substitute(self, msg, list)
Run a kind of substitution on a message.

source code

_reply_regexp(self, user, regexp)
Prepares a trigger for the regular expression engine.

source code

_process_tags(self, user, msg, reply, st=[], bst=[], depth=0)
Post process tags in a message. source code

_string_format(self, msg, method)
Format a string (upper, lower, formal, sentence).

source code

_topic_triggers(self, topic, triglvl, depth=0, inheritence=0, inherited=False)
Recursively scan a topic and return a list of all triggers.

source code

_find_trigger_by_inheritence(self, topic, trig, depth=0)
Locate the replies for a trigger in an inherited/included topic.

source code

_get_topic_tree(self, topic, depth=0)
Given one topic, get the list of all included/inherited topics.

source code

_is_atomic(self, trigger)
Determine if a trigger is atomic or not.

source code

_word_count(self, trigger, all=False)
Count the words that aren't wildcards in a trigger.

source code

_rot13(self, n)
Encode and decode a string into ROT13.

source code

_strip_nasties(self, s)
Formats a string for ASCII regex matching.

source code

_dump(self)
For debugging, dump the entire data structure.

source code

Class Methods

[hide private]

VERSION(self=None)
Return the version number of the RiveScript library.

source code

Class Variables

[hide private]

_debug = False

_strict = True

_logf = ''

_depth = 50

_gvars = {}

_bvars = {}

_subs = {}

_person = {}

_arrays = {}

_users = {}

_freeze = {}

_includes = {}

_lineage = {}

_handlers = {}

_objlangs = {}

_topics = {}

_thats = {}

_sorted = {}

Method Details

[hide private]

init(self, debug=False, strict=True, depth=50, log=`''`)
(Constructor)

source code

Initialize a new RiveScript interpreter.

bool debug:  Specify a debug mode.
bool strict: Strict mode (RS syntax errors are fatal)
str  log:    Specify a log file for debug output to go to (instead of STDOUT).
int  depth:  Specify the recursion depth limit.

VERSION(self=None)
Class Method

source code

Return the version number of the RiveScript library.

This may be called as either a class method of a method of a RiveScript object.

stream(self, code)

source code

Stream in RiveScript source code dynamically.

`code` should be an array of lines of RiveScript code.

check_syntax(self, cmd, line)

source code

Syntax check a RiveScript command and line.

Returns a syntax error string on error; None otherwise.

set_handler(self, language, obj)

source code

Define a custom language handler for RiveScript objects.

language: The lowercased name of the programming language,
          e.g. python, javascript, perl
obj:      An instance of a class object that provides the following interface:

    class MyObjectHandler:
        def __init__(self):
            pass
        def load(self, name, code):
            # name = the name of the object from the RiveScript code
            # code = the source code of the object
        def call(self, rs, name, fields):
            # rs     = the current RiveScript interpreter object
            # name   = the name of the object being called
            # fields = array of arguments passed to the object
            return reply

Pass in a None value for the object to delete an existing handler (for example,
to prevent Python code from being able to be run by default).

Look in the `eg` folder of the rivescript-python distribution for an example
script that sets up a JavaScript language handler.

set_subroutine(self, name, code)

source code

Define a Python object from your program.

This is equivalent to having an object defined in the RiveScript code, except
your Python code is defining it instead. `name` is the name of the object, and
`code` is a Python function (a `def`) that accepts rs,args as its parameters.

This method is only available if there is a Python handler set up (which there
is by default, unless you've called set_handler("python", None)).

set_global(self, name, value)

source code

Set a global variable.

Equivalent to `! global` in RiveScript code. Set to None to delete.

set_variable(self, name, value)

source code

Set a bot variable.

Equivalent to `! var` in RiveScript code. Set to None to delete.

set_substitution(self, what, rep)

source code

Set a substitution.

Equivalent to `! sub` in RiveScript code. Set to None to delete.

set_person(self, what, rep)

source code

Set a person substitution.

Equivalent to `! person` in RiveScript code. Set to None to delete.

get_uservar(self, user, name)

source code

Get a variable about a user.

If the user has no data at all, returns None. If the user doesn't have a value
set for the variable you want, returns the string 'undefined'.

get_uservars(self, user=None)

source code

Get all variables about a user (or all users).

If no username is passed, returns the entire user database structure. Otherwise,
only returns the variables for the given user, or None if none exist.

clear_uservars(self, user=None)

source code

Delete all variables about a user (or all users).

If no username is passed, deletes all variables about all users. Otherwise, only
deletes all variables for the given user.

freeze_uservars(self, user)

source code

Freeze the variable state for a user.

This will clone and preserve a user's entire variable state, so that it can be
restored later with `thaw_uservars`.

thaw_uservars(self, user, action=`'thaw'`)

source code

Thaw a user's frozen variables.

The `action` can be one of the following options:

    discard: Don't restore the user's variables, just delete the frozen copy.
    keep:    Keep the frozen copy after restoring the variables.
    thaw:    Restore the variables, then delete the frozen copy (default).

last_match(self, user)

source code

Get the last trigger matched for the user.

This will return the raw trigger text that the user's last message matched. If
there was no match, this will return None.

Class RiveScript

__init__(self, debug=False, strict=True, depth=50, log='') (Constructor)

VERSION(self=None) Class Method

stream(self, code)

check_syntax(self, cmd, line)

set_handler(self, language, obj)

set_subroutine(self, name, code)

set_global(self, name, value)

set_variable(self, name, value)

set_substitution(self, what, rep)

set_person(self, what, rep)

get_uservar(self, user, name)

get_uservars(self, user=None)

clear_uservars(self, user=None)

freeze_uservars(self, user)

thaw_uservars(self, user, action='thaw')

last_match(self, user)

init(self, debug=False, strict=True, depth=50, log=`''`)
(Constructor)

VERSION(self=None)
Class Method

thaw_uservars(self, user, action=`'thaw'`)