com.chaquo.python

Class Python

Object

Python

public class Python
extends Object

Interface to Python.

Unless otherwise specified, all methods in this class throw PyException on failure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Python.Platform Provides information needed to start Python.

Method Summary

Modifier and Type	Method and Description
PyObject	getBuiltins() Returns the builtins module, which contains Python’s built-in functions (e.g.
static Python	getInstance() Gets the interface to Python.
PyObject	getModule(String name) Returns the module with the given name.
static Python.Platform	getPlatform() Returns the Platform object which was used to start Python, or null if Python has not yet been started.
static boolean	isStarted() Return whether the Python virtual machine is running
static void	start(Python.Platform platform) Starts the Python virtual machine.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBuiltins

public PyObject getBuiltins()

Returns the builtins module, which contains Python’s built-in functions (e.g. open), types (e.g. dict), constants (e.g. True) and exceptions (e.g. ValueError).

getInstance

public static Python getInstance()

Gets the interface to Python. This method always returns the same object. If start() has not yet been called, it will be called with a new GenericPlatform.

getModule

public PyObject getModule(String name)

Returns the module with the given name. Dot notation may be used to get submodules (e.g. os.path).

getPlatform

public static Python.Platform getPlatform()

Returns the Platform object which was used to start Python, or null if Python has not yet been started.

isStarted

public static boolean isStarted()

Return whether the Python virtual machine is running

start

public static void start(Python.Platform platform)

Starts the Python virtual machine. If this method is called, it can only be called once, and it must be before any call to getInstance().

If running on Android, see the notes here on how to call this method in an app. If running on any other platform, there’s no need to call this method, unless you want to customize the Python startup process.