Python Scripting Help

Rekall provides automatic prompting when you are editing a python script. For instance, if you enter something like:

button.setEnabled (true)
      

Immediately after entering the opening parenthesis, Rekall will show summary information for possible setEnabled method; in this case there are two, for an KBObject (such as a button) and an KBItem (such as a text field). Because python is a dynamically typed language, Rekall cannot make any assumptions about what sort of object button in the above example is ( You may call the object variable button, but that is entirely up to you; it has no special meaning to python. ) and hence shows both methods.

The help information remains visible until you either type a closing parenthesis, or move to another line in the script. It can also be dismissed using the escape key.

An additional way of getting help is to enter ctrl-H. In this case Rekall looks for a method name immediately in front of the current cursor position, and shows all methods which start with the string so found. For instance. with the cursor positioned immediately after button.set in the above example, Rekall will show all methods which start with set (setEnabled, setValue, and so forth).