ApplicationsLib Namespace Reference

Detailed Description

The LinearSolverLibrarySetup takes care of proper initialization and shutting down of an external linear solver library. The concrete implementation is chosen by the build system. An object of this class must be created at the beginning of the scope where it is used. When the scope closes (or the object is destroyed explicitly) library shutting down functions are automatically called. The default implementation is empty providing polymorphic behaviour when using this class.

Namespaces
namespace	anonymous_namespace{ogs_embedded_python.cpp}

Classes
struct	LinearSolverLibrarySetup
class	TestDefinition

Functions
pybind11::scoped_interpreter	setupEmbeddedPython ()
void	setupEmbeddedPythonVenvPaths ()

Function Documentation

setupEmbeddedPython()

OGS_EXPORT_SYMBOL pybind11::scoped_interpreter ApplicationsLib::setupEmbeddedPython

(

)

Sets up an embedded Python interpreter and makes sure that the OpenGeoSys Python module is not removed by the linker.

Definition at line 32 of file ogs_embedded_python.cpp.

{
    // Allows ogs to be interrupted by SIGINT, which otherwise is handled by
    // python. See
    // https://docs.python.org/3/c-api/exceptions.html#c.PyErr_CheckSignals and
    // https://pybind11.readthedocs.io/en/stable/faq.html#how-can-i-properly-handle-ctrl-c-in-long-running-functions
    constexpr bool init_signal_handlers = false;
    return pybind11::scoped_interpreter{init_signal_handlers};
}

setupEmbeddedPythonVenvPaths()

OGS_EXPORT_SYMBOL void ApplicationsLib::setupEmbeddedPythonVenvPaths

(

)

Checks for activated and matching virtual environment and adds it to sys.path.

Definition at line 172 of file ogs_embedded_python.cpp.

{
    namespace py = pybind11;
    namespace fs = std::filesystem;
 
    // Get embedded Python version
    py::object const version_info =
        py::module_::import("sys").attr("version_info");
    int const emb_major = version_info.attr("major").cast<int>();
    int const emb_minor = version_info.attr("minor").cast<int>();
 
    // Check for virtual environment
    char const* const venv = std::getenv("VIRTUAL_ENV");
    if (venv == nullptr)
    {
        DBUG("No virtual environment detected (VIRTUAL_ENV not set).");
        return;
    }
 
    fs::path const venv_path(venv);
    DBUG("Virtual environment detected at: {}", venv_path.string());
 
    auto const venv_version = getPythonVersionFromVenv(venv_path);
    if (!venv_version.has_value())
    {
        OGS_FATAL(
            "Failed to determine Python version from virtual environment at "
            "'{}'. "
            "Please ensure the virtual environment is valid.",
            venv_path.string());
    }
 
    int const venv_major = venv_version->first;
    int const venv_minor = venv_version->second;
 
    // Validate version match
    if (venv_major != emb_major || venv_minor != emb_minor)
    {
        OGS_FATAL(
            "Python version mismatch:\n"
            "  Embedded interpreter: {}.{}\n"
            "  Virtual environment:  {}.{}\n"
            "The virtual environment must use the same Python version as the "
            "embedded interpreter.",
            emb_major, emb_minor, venv_major, venv_minor);
    }
 
    // Find and validate site-packages path
    fs::path const site_packages = findSitePackagesPath(venv_path);
    INFO("Using virtual environment site-packages: {}", site_packages.string());
 
    // Add to sys.path (insert at beginning for highest priority)
    py::list sys_path = py::module_::import("sys").attr("path");
    sys_path.insert(0, py::str(site_packages.string()));
}

References DBUG(), INFO(), and OGS_FATAL.