PyKrita Namespace Reference

Classes
class	Python
class	version
	Class version. More...
class	version_checker
	Class version_checker. More...

Enumerations
enum	InitResult {   INIT_UNINITIALIZED , INIT_OK , INIT_CANNOT_LOAD_PYTHON_LIBRARY , INIT_CANNOT_SET_PYTHON_PATHS ,   INIT_CANNOT_LOAD_PYKRITA_MODULE }

Functions
void	finalize ()
InitResult	initialize ()
bool	operator!= (const version &left, const version &right)
bool	operator< (const version &left, const version &right)
bool	operator<= (const version &left, const version &right)
bool	operator== (const version &left, const version &right)
bool	operator> (const version &left, const version &right)
bool	operator>= (const version &left, const version &right)
PythonPluginManager *	pluginManager ()

Variables
static InitResult	initStatus = INIT_UNINITIALIZED
static QScopedPointer< PythonPluginManager >	pluginManagerInstance

Enumeration Type Documentation

InitResult

enum PyKrita::InitResult

Enumerator
INIT_UNINITIALIZED
INIT_OK
INIT_CANNOT_LOAD_PYTHON_LIBRARY
INIT_CANNOT_SET_PYTHON_PATHS
INIT_CANNOT_LOAD_PYKRITA_MODULE

Definition at line 27 of file utilities.h.

                    {
        INIT_UNINITIALIZED,
        INIT_OK,
        INIT_CANNOT_LOAD_PYTHON_LIBRARY,
        INIT_CANNOT_SET_PYTHON_PATHS,
        INIT_CANNOT_LOAD_PYKRITA_MODULE,
    };

Function Documentation

finalize()

void PyKrita::finalize

(

)

Cleanup after Python. Note: doing this as part of static/global destruction will not work. The call to Py_Finalize() would happen after the Python runtime has already been finalized, leading to a segfault.

Definition at line 99 of file utilities.cpp.

                    {
        dbgScript << "Going to destroy the Python engine";
        if (pluginManagerInstance) {
            pluginManagerInstance->unloadAllModules();
 
            PyKrita::Python::maybeFinalize();
            PyKrita::Python::libraryUnload();
 
            pluginManagerInstance.reset();
            initStatus = INIT_UNINITIALIZED;
        }
    }

References dbgScript, INIT_UNINITIALIZED, initStatus, PyKrita::Python::libraryUnload(), PyKrita::Python::maybeFinalize(), pluginManagerInstance, and PythonPluginManager::unloadAllModules().

initialize()

InitResult PyKrita::initialize

(

)

Initialize the Python environment and plugin manager. This should be called first before using the manager or the Python class.

Definition at line 44 of file utilities.cpp.

    {
        // Already initialized?
        if (initStatus == INIT_OK) return INIT_OK;
 
        dbgScript << "Initializing Python plugin for Python" << PY_MAJOR_VERSION << "," << PY_MINOR_VERSION;
 
        if (!Python::libraryLoad()) {
            return INIT_CANNOT_LOAD_PYTHON_LIBRARY;
        }
 
        // Update PYTHONPATH
        // 0) custom plugin directories (prefer local dir over systems')
        // 1) shipped krita module's dir
        QStringList pluginDirectories = KoResourcePaths::findDirs("pythonscripts");
        dbgScript << "Plugin Directories: " << pluginDirectories;
        if (!Python::setPath(pluginDirectories)) {
            initStatus = INIT_CANNOT_SET_PYTHON_PATHS;
            return initStatus;
        }
 
        if (0 != PyImport_AppendInittab(Python::PYKRITA_ENGINE, PYKRITA_INIT)) {
            initStatus = INIT_CANNOT_LOAD_PYKRITA_MODULE;
            return initStatus;
        }
 
        Python::ensureInitialized();
        Python py = Python();
 
        // Initialize 'plugins' dict of module 'pykrita'
        PyObject* plugins = PyDict_New();
        py.itemStringSet("plugins", plugins);
 
        pluginManagerInstance.reset(new PythonPluginManager());
 
        // Initialize our built-in module.
        auto pykritaModule = PYKRITA_INIT();
 
        if (!pykritaModule) {
            initStatus = INIT_CANNOT_LOAD_PYKRITA_MODULE;
            return initStatus;
            //return i18nc("@info:tooltip ", "No <icode>pykrita</icode> built-in module");
        }
 
        initStatus = INIT_OK;
        return initStatus;
    }

References dbgScript, PyKrita::Python::ensureInitialized(), KoResourcePaths::findDirs(), INIT_CANNOT_LOAD_PYKRITA_MODULE, INIT_CANNOT_LOAD_PYTHON_LIBRARY, INIT_CANNOT_SET_PYTHON_PATHS, INIT_OK, initStatus, PyKrita::Python::itemStringSet(), PyKrita::Python::libraryLoad(), pluginManagerInstance, PyKrita::Python::PYKRITA_ENGINE, PYKRITA_INIT, and PyKrita::Python::setPath().

operator!=()

bool PyKrita::operator!= ( const version & left, const version & right )

inline

Definition at line 149 of file version_checker.h.

{
    return !(left == right);
}

operator<()

bool PyKrita::operator< ( const version & left, const version & right )

inline

Definition at line 154 of file version_checker.h.

{
    return left._major() < right._major()
           || (left._major() == right._major() && left._minor() < right._minor())
           || (left._major() == right._major() && left._minor() == right._minor() && left.patch() < right.patch())
           ;
}

References PyKrita::version::_major(), PyKrita::version::_minor(), and PyKrita::version::patch().

operator<=()

bool PyKrita::operator<= ( const version & left, const version & right )

inline

Definition at line 170 of file version_checker.h.

{
    return left == right || left < right;
}

operator==()

bool PyKrita::operator== ( const version & left, const version & right )

inline

Definition at line 141 of file version_checker.h.

{
    return left._major() == right._major()
           && left._minor() == right._minor()
           && left.patch() == right.patch()
           ;
}

References PyKrita::version::_major(), PyKrita::version::_minor(), and PyKrita::version::patch().

operator>()

bool PyKrita::operator> ( const version & left, const version & right )

inline

Definition at line 162 of file version_checker.h.

{
    return left._major() > right._major()
           || (left._major() == right._major() && left._minor() > right._minor())
           || (left._major() == right._major() && left._minor() == right._minor() && left.patch() > right.patch())
           ;
}

References PyKrita::version::_major(), PyKrita::version::_minor(), and PyKrita::version::patch().

operator>=()

bool PyKrita::operator>= ( const version & left, const version & right )

inline

Definition at line 175 of file version_checker.h.

{
    return left == right || left > right;
}

pluginManager()

PythonPluginManager * PyKrita::pluginManager

(

)

Gets the instance of the plugin manager. Note: PyKrita::initialize() must be called before using this function.

Definition at line 92 of file utilities.cpp.

    {
        auto pluginManager = pluginManagerInstance.data();
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(pluginManager, nullptr);
        return pluginManager;
    }

References KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, pluginManager(), and pluginManagerInstance.

Variable Documentation

initStatus

InitResult PyKrita::initStatus = INIT_UNINITIALIZED

static

Definition at line 41 of file utilities.cpp.

pluginManagerInstance

QScopedPointer<PythonPluginManager> PyKrita::pluginManagerInstance

static

Definition at line 42 of file utilities.cpp.