# $Id: Pylog.README,v 1.1 1997/09/29 01:47:57 wp0002 Exp wp0002 $
# FILE: Pylog.README -- A brief synopsis of the Pylog class.
# AUTHOR: W. Michael Petullo,
[email protected]
# DATE: 28 SEPT 97
Pylog is a Python wrapper for the SWI Prolog interpreter. It allows
interaction between Python and Prolog code. Directly, Pylog interacts with
pylogServer.pl, which presents a front end for the SWI Prolog interpreter.
PylogServer.pl makes it easy to communicate directly with the SWI Prolog
interpreter using pipes. The Pylog class allows you to:
* load a SWI Prolog source file or issue a query (Pylog.Query ())
* check to see if there are any more solutions to your query
(Pylog.MoreSolutions ())
* get the state of the variables involved in your query in dictionary
form (Pylog.GetSolution ())
* force the SWI Prolog interpreter into a sane state
(Pylog.ForceSanity ())
* shutdown the SWI Prolog interpreter and close any pipes
(Pylog.Shutdown ())
When a run-time error occurs in the SWI Prolog interpreter, a
PrologRuntimeError exception is raised. In addition, when a BadQuery is issued
to SWI Prolog, a BadQuery exception is raised.
To use the Pylog class, you will also need the files PipeDream.py and
pylogServer.pl. In addition, you will need SWI Prolog installed on your
machine.
Pylog.py includes an "if __name__ == '__main__':" clause to illustrate its use.