PythonInterpreter.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 *  and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Redistribution and modification of this code is strictly prohibited.
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_TOOLBOXES_PYTHON_PYTHONINTERPRETER_H_
#define _MIRA_TOOLBOXES_PYTHON_PYTHONINTERPRETER_H_

#include <boost/optional.hpp>

#include <Python.h>

#include <python/BoostPythonWrapper.h>

#include <error/Logging.h>
#include <error/Exceptions.h>
#include <utils/Singleton.h>
#include <utils/Path.h>
#include <python/PythonException.h>
#include <python/ScopedGIL.h>

namespace mira { namespace python {


class PythonEnvironment : public EagerSingleton<PythonEnvironment>
{
public:
    void setVirtualEnvironmentPath(const Path& path);

    boost::optional<Path> getVirtualEnvironmentPath() const { return mVirtualEnvironmentPath; }

    // Tell the singleton, that the Python interpreter was initialized
    void setInterpreterInitialized() { mInterpreterInitialized = true; }

private:
    bool mInterpreterInitialized = false;
    boost::optional<Path> mVirtualEnvironmentPath;
};


class PythonInterpreter : public LazySingleton<PythonInterpreter>
{
public:

    boost::python::object getMainModule() { return mMainModule; }
    boost::python::dict getGlobalDict() { return  boost::python::extract<boost::python::dict>(mGlobalDict); }
    boost::python::dict getLocalDict() { return getGlobalDict().copy(); }
    boost::python::object importModule(const std::string & name);
    void extendPath(const std::string& path);

protected:

    PythonInterpreter();
    ~PythonInterpreter();

    friend class mira::singleton::CreateUsingNew<PythonInterpreter>;
    boost::python::object mMainModule;
    boost::python::object mGlobalDict;

    PyThreadState* mMainThreadState;
};


}

} // namespace

#endif