MiniPython

java.lang.Object
- com.rogerbinns.MiniPython

```
public class MiniPython
extends Object
```
Encapsulates running a Python syntax file. The source should have been transformed using jmp-compile. The class cannot be used concurrently. There is no shared state between instances.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MiniPython.Client` Provide platform behaviour
`class`	`MiniPython.ExecutionError` Encapsulates what would be an Exception in Python.

Constructor Summary

Constructors
Constructor and Description

MiniPython()

Constructors
Constructor and Description
`MiniPython()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addModule(String name, Object object)` Makes methods on the methods Object available to the Python
`Object`	`callMethod(String name, Object... args)` Calls a method in Python and returns the result
`void`	`clear()` Removes all internal state.
`void`	`setClient(MiniPython.Client client)` Callbacks to use for specific behaviour
`void`	`setCode(InputStream stream)` Reads and executes code from the supplied stream The stream provided must satisfy reads completely (eg if 27 bytes is asked for then that number should be returned in the read() call unless end of file is reached.)
`void`	`signalError(String exctype, String message)` Call this method when your callbacks need to halt execution due to an error This method will do the internal bookkeeping necessary in order to provide diagnostics to the original caller and then throw an ExecutionError which you should not catch.
`void`	`signalError(String exctype, String message, Throwable cause)` Call this method when your callbacks need to halt execution due to an error This method will do the internal bookkeeping necessary in order to provide diagnostics to the original caller and then throw an ExecutionError which you should not catch.
`static String`	`toPyReprString(Object o)` Same as toPyString except strings are quoted and backslash escaped.
`static String`	`toPyString(Object o)` Returns a string representing the object using Python nomenclature where possible For example `null` is returned as `None`, `true` as `True` etc.
`static String`	`toPyTypeString(Object o)` Returns a string representing the type of the object using Python nomenclature where possible For example `null` is returned as `NoneType`, `true` as `bool`, `Map` as `dict` etc.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MiniPython
```
public MiniPython()
```
- Method Detail
  - clear
```
public void clear()
```
    Removes all internal state. This ensures that garbage collection is easier. You can reuse this instance by calling addModule to reregister modules and setCode to run new code.
  - setCode
```
public void setCode(InputStream stream)
             throws IOException,
                    MiniPython.ExecutionError
```
    Reads and executes code from the supplied stream The stream provided must satisfy reads completely (eg if 27 bytes is asked for then that number should be returned in the read() call unless end of file is reached.)
    
    Parameters:
    stream - The stream is not closed and you can have additional content after the jmp.
    
    Throws:
    
    IOException - Passed on from read() calls on the stream
    
    EOFException - When the stream is truncated
    
    MiniPython.ExecutionError - Any issues from executing the code
  - callMethod
```
public Object callMethod(String name,
                Object... args)
                  throws MiniPython.ExecutionError
```
    Calls a method in Python and returns the result
    
    Parameters:
    name - Global method name
    args - Variable list of arguments that it takes
    
    Throws:
    
    MiniPython.ExecutionError - On any issues encountered
  - signalError
```
public void signalError(String exctype,
               String message)
                 throws MiniPython.ExecutionError
```
    Call this method when your callbacks need to halt execution due to an error This method will do the internal bookkeeping necessary in order to provide diagnostics to the original caller and then throw an ExecutionError which you should not catch.
    
    Parameters:
    exctype - Best practise is to use the name of a Python exception (eg "TypeError")
    message - Text describing the error.
    
    Throws:
    
    MiniPython.ExecutionError - Always thrown
  - signalError
```
public void signalError(String exctype,
               String message,
               Throwable cause)
                 throws MiniPython.ExecutionError
```
    Call this method when your callbacks need to halt execution due to an error This method will do the internal bookkeeping necessary in order to provide diagnostics to the original caller and then throw an ExecutionError which you should not catch.
    
    Parameters:
    exctype - Best practise is to use the name of a Python exception (eg "TypeError")
    message - Text describing the error.
    cause - The underlying reason why this exception is being caused
    
    Throws:
    
    MiniPython.ExecutionError - Always thrown
  - toPyString
```
public static String toPyString(Object o)
```
    Returns a string representing the object using Python nomenclature where possible For example `null` is returned as `None`, `true` as `True` etc. Container types like dict/Map and list/List will include the items.
    
    Parameters:
    o - Object to stringify. Can be null.
  - toPyReprString
```
public static String toPyReprString(Object o)
```
    Same as toPyString except strings are quoted and backslash escaped. If you emit an error message this is preferable as it makes it clear a value is a string.
    
    Parameters:
    o - Object to stringify. Can be null.
  - toPyTypeString
```
public static String toPyTypeString(Object o)
```
    Returns a string representing the type of the object using Python nomenclature where possible For example `null` is returned as `NoneType`, `true` as `bool`, `Map` as `dict` etc. You can also pass in Class objects as well as instances. Note that primitives (eg `int`) and the corresponding boxed type (eg `Integer`) will both be returned as the same string (`int` in this case).
    
    Parameters:
    o - Object whose type to stringify, or a Class or null
  - setClient
```
public void setClient(MiniPython.Client client)
```
    Callbacks to use for specific behaviour
    
    Parameters:
    client - Replaces existing client with this one
  - addModule
```
public void addModule(String name,
             Object object)
```
    Makes methods on the methods Object available to the Python
    
    Parameters:
    name - Module name in the Python environment
    object - Object to introspect looking for methods
    See Also:
    Adding methods

Class MiniPython

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MiniPython

Method Detail

clear

setCode

callMethod

signalError

signalError

toPyString

toPyReprString

toPyTypeString

setClient

addModule