Package ghidra.python
Class PythonUtils
- java.lang.Object
-
- ghidra.python.PythonUtils
-
public class PythonUtils extends java.lang.Object
Python utility method class.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PYTHON_CACHEDIR
static java.lang.String
PYTHON_NAME
static java.lang.String
PYTHON_SRC
-
Constructor Summary
Constructors Constructor Description PythonUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.io.File
setupPythonCacheDir(TaskMonitor monitor)
Sets up the python cache directory.static java.io.File
setupPythonHomeDir()
Sets up the python home directory.
-
-
-
Field Detail
-
PYTHON_NAME
public static final java.lang.String PYTHON_NAME
- See Also:
- Constant Field Values
-
PYTHON_CACHEDIR
public static final java.lang.String PYTHON_CACHEDIR
- See Also:
- Constant Field Values
-
PYTHON_SRC
public static final java.lang.String PYTHON_SRC
- See Also:
- Constant Field Values
-
-
Method Detail
-
setupPythonHomeDir
public static java.io.File setupPythonHomeDir() throws java.io.IOException
Sets up the python home directory. This is the directory that has the "Lib" directory in it.- Returns:
- The python home directory.
- Throws:
java.io.IOException
- If there was a disk-related problem setting up the home directory.
-
setupPythonCacheDir
public static java.io.File setupPythonCacheDir(TaskMonitor monitor) throws CancelledException, java.io.IOException
Sets up the python cache directory. This is a temporary space that python source files get compiled to and cached. It should NOT be in the Ghidra installation directory, because some installations will not have the appropriate directory permissions to create new files in.- Parameters:
monitor
- A monitor to use during the cache directory setup.- Returns:
- The python cache directory.
- Throws:
java.io.IOException
- If there was a disk-related problem setting up the cache directory.CancelledException
- If the user cancelled the setup.
-
-