mitkPythonHelper.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
#ifndef mitkPythonHelper_h
#define mitkPythonHelper_h
 
#include <cassert>
 
#include <mitkFileSystem.h>
#include <MitkPythonHelperExports.h>
 
#define MITK_PYTHON_LIBRARY_FILENAME "libpython3.12.so"
 
namespace mitk::PythonHelper
{
  // DO NOT EDIT THIS FILE DIRECTLY.
  // This header is auto-generated from mitkPythonHelper.h.in by CMake.
  // To make changes, modify mitkPythonHelper.h.in instead.
 
  MITKPYTHONHELPER_EXPORT fs::path GetHomePath();
  MITKPYTHONHELPER_EXPORT fs::path GetLibraryPath();
  MITKPYTHONHELPER_EXPORT fs::path GetExecutablePath();
 
  MITKPYTHONHELPER_EXPORT fs::path GetVirtualEnvBasePath();
  MITKPYTHONHELPER_EXPORT fs::path GetVirtualEnvPath(const std::string& name);
  MITKPYTHONHELPER_EXPORT bool VirtualEnvExists(const std::string& name);
 
  // Path to the Python interpreter inside the named virtual environment, or an
  // empty path if the environment or its interpreter is missing. Use this for
  // short-lived subprocesses that must run with the venv's own interpreter
  // rather than the embedded one.
  MITKPYTHONHELPER_EXPORT fs::path GetVirtualEnvExecutablePath(const std::string& name);
 
  // Path to a named console script (entry point) inside the named virtual
  // environment: bin/<scriptName> on POSIX, Scripts/<scriptName>.exe on Windows
  // (e.g. GetVirtualEnvScriptPath(name, "TotalSegmentator")). Returns an empty
  // path only if the environment location cannot be resolved; the script file
  // itself is not checked for existence, so the caller decides how to handle a
  // missing script.
  MITKPYTHONHELPER_EXPORT fs::path GetVirtualEnvScriptPath(const std::string& name, const std::string& scriptName);
 
  MITKPYTHONHELPER_EXPORT fs::path CreateVirtualEnv(const std::string& name);
  MITKPYTHONHELPER_EXPORT bool ActivateVirtualEnv(const std::string& name);
  MITKPYTHONHELPER_EXPORT bool ActivateVirtualEnv(const fs::path& path);
  MITKPYTHONHELPER_EXPORT bool RemoveVirtualEnv(const std::string& name);
  MITKPYTHONHELPER_EXPORT bool RemoveVirtualEnv(const fs::path& path);
 
  // Returns true if any shared library (.dll/.so/.dylib/.pyd) currently
  // loaded into this process originates from the given virtual environment
  // directory. RemoveVirtualEnv on such a venv would partial-fail on Windows
  // (locked files) and on POSIX would unlink files still in use.
  //
  // Note: only modules loaded into THIS process are considered. A virtual
  // environment in use by another running MITK instance cannot be detected.
  MITKPYTHONHELPER_EXPORT bool IsAnyVirtualEnvModuleLoaded(const std::string& name);
  MITKPYTHONHELPER_EXPORT bool IsAnyVirtualEnvModuleLoaded(const fs::path& path);
 
  // String-literal overloads. Without these, calls like ActivateVirtualEnv("foo")
  // are ambiguous because const char* converts equally well to both std::string
  // and fs::path; an exact-match const char* overload disambiguates.
  //
  // \pre name != nullptr.
  inline bool ActivateVirtualEnv(const char* name)
  {
    assert(name != nullptr);
    return ActivateVirtualEnv(std::string(name));
  }
 
  inline bool RemoveVirtualEnv(const char* name)
  {
    assert(name != nullptr);
    return RemoveVirtualEnv(std::string(name));
  }
 
  inline bool IsAnyVirtualEnvModuleLoaded(const char* name)
  {
    assert(name != nullptr);
    return IsAnyVirtualEnvModuleLoaded(std::string(name));
  }
}
 
#endif