Class PythonRunner

This class encapsulates the Unity Editor API support for Python.

Inheritance

object

PythonRunner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.Scripting.Python

Assembly: Unity.Scripting.Python.Editor.dll

Syntax

public static class PythonRunner

Properties

IsInitialized

Verify whether Python has been initialized yet.

Normally you'd simply call EnsureInitialized without checking. This access is principally useful when shutting down.

Declaration

public static bool IsInitialized { get; }

Property Value

Type	Description
bool

PythonInterpreter

The full path to the Python interpreter.

Accessing this initializes Python if it hasn't been already.

Declaration

public static string PythonInterpreter { get; }

Property Value

Type	Description
string	A string representing the full path to the Python executable.

PythonVersion

The version of the Python interpreter.

Accessing this initializes Python if it hasn't been already.

Declaration

public static string PythonVersion { get; }

Property Value

Type	Description
string	A string representing the version.

Methods

EnsureInitialized()

Ensures the Python API is initialized.

Safe to call frequently.

Throws if there's an installation error.

Declaration

public static void EnsureInitialized()

RunFile(string, string)

Runs a Python script in the Unity process.

Declaration

public static void RunFile(string pythonFileToExecute, string scopeName = null)

Parameters

Type	Name	Description
string	pythonFileToExecute	The script to execute.
string	scopeName	Value to write to Python special variable __name__

RunString(string, string)

Runs Python code in the Unity process.

Declaration

public static void RunString(string pythonCodeToExecute, string scopeName = null)

Parameters

Type	Name	Description
string	pythonCodeToExecute	The code to execute.
string	scopeName	Value to write to Python special variable __name__

SpawnShell()

Spawns a Windows Powershell with the PATH set up to find the Python Scripting's installed Python interpreter.

Declaration

public static void SpawnShell()