adapter loader to new ogdf packaging

Author: N-Coder

src/ogdf_python/info.py

@@ -1,6 +1,6 @@
 from ogdf_python.loader import *
 
-__all__ = ["get_ogdf_info", "get_macro", "get_library_path", "get_include_path", "get_ogdf_include_path"]
+__all__ = ["get_ogdf_info", "get_macro"]
 
 
 def get_macro(m):
@@ -31,35 +31,13 @@ def conf_which(n):
     return getattr(cppyy.gbl.conf_which, w)().decode("ascii")
 
 
-def get_library_path(name=None):
-    if name is None:
-        return get_library_path("OGDF") or get_library_path("libOGDF")
-    return cppyy.gbl.gSystem.FindDynamicLibrary(cppyy.gbl.CppyyLegacy.TString(name), True)
-
-
-def get_ogdf_include_path():
-    include = "ogdf/basic/Graph.h"
-    path = get_include_path(include)
-    if path:
-        path = path.removesuffix(include)
-    return path
-
-
-def get_include_path(name="ogdf/basic/Graph.h"):
-    import ctypes
-    s = ctypes.c_char_p()
-    if cppyy.gbl.gSystem.IsFileInIncludePath(name, s):
-        return s.value.decode()
-    else:
-        return None
-
-
 def get_ogdf_info():
     from ogdf_python import __version__
     cppinclude("ogdf/basic/System.h")
     data = {
-        "ogdf_path": get_library_path() or "unknown",
-        "ogdf_include_path": get_ogdf_include_path() or "unknown",
+        "ogdf_path": get_loaded_library_path() or "unknown",
+        "ogdf_include_path": get_base_include_path() or "unknown",
+        "ogdf_config_include_path": get_base_include_path("ogdf/basic/internal/config_autogen.h") or "unknown",
         "ogdf_version": get_macro("OGDF_VERSION").strip('"'),
         "ogdf_python_version": __version__,
         "ogdf_debug": get_macro("OGDF_DEBUG") is not None,

src/ogdf_python/loader.py

@@ -1,5 +1,7 @@
 import os
 import platform
+import warnings
+from pathlib import Path
 
 import importlib_resources
 import sys
@@ -27,60 +29,131 @@
     raise
 
 cppyy.ll.set_signals_as_exception(True)
-cppyy.add_include_path(os.path.dirname(os.path.realpath(__file__)))
+CONFIG = os.getenv("OGDF_PYTHON_MODE", "release")
+if CONFIG not in ("release", "debug"):
+    warnings.warn(f"Environment variable OGDF_PYTHON_MODE set to '{CONFIG}' instead of 'debug' or 'release'.")
+
+
+## Search Utils
+
+def get_library_path(name=None):
+    if name is None:
+        if CONFIG == "release":
+            return get_library_path("OGDF") or get_library_path("libOGDF")
+        else:
+            return get_library_path(f"OGDF-{CONFIG}") or get_library_path(f"libOGDF-{CONFIG}")
+    return cppyy.gbl.gSystem.FindDynamicLibrary(cppyy.gbl.CppyyLegacy.TString(name), True)
+
+
+def get_loaded_library_path(name="OGDF"):
+    from pathlib import Path
+    return [s for s in cppyy.gbl.gSystem.GetLibraries().split(" ") if name in Path(s).name]
+
+
+def get_base_include_path(include="ogdf/basic/Graph.h"):
+    path = get_include_path(include)
+    if path:
+        path = path.removesuffix(include)
+    return path
+
+
+def get_include_path(name="ogdf/basic/Graph.h"):
+    import ctypes
+    s = ctypes.c_char_p()
+    if cppyy.gbl.gSystem.IsFileInIncludePath(name, s):
+        return s.value.decode()
+    else:
+        return None
+
+
+def call_if_exists(func, path):
+    if Path(path).is_dir():
+        func(str(path))
+        return True
+    return False
+
+
+## Setup Search Paths
 
 if "OGDF_INSTALL_DIR" in os.environ:
-    INSTALL_DIR = os.path.expanduser(os.getenv("OGDF_INSTALL_DIR"))
-    cppyy.add_include_path(os.path.join(INSTALL_DIR, "include"))
-    cppyy.add_library_path(os.path.join(INSTALL_DIR, "lib"))  # TODO windows?
+    INSTALL_DIR = Path(os.getenv("OGDF_INSTALL_DIR")).absolute()
+    if call_if_exists(cppyy.add_library_path, INSTALL_DIR / "lib64"):
+        call_if_exists(cppyy.add_library_path, INSTALL_DIR / "lib")
+    else:
+        cppyy.add_library_path(str(INSTALL_DIR / "lib"))
+    cppyy.add_include_path(str(INSTALL_DIR / "include"))
+
 if "OGDF_BUILD_DIR" in os.environ:
-    BUILD_DIR = os.path.expanduser(os.getenv("OGDF_BUILD_DIR"))
-    cppyy.add_include_path(os.path.join(BUILD_DIR, "include"))
-    cppyy.add_include_path(os.path.join(BUILD_DIR, "..", "include"))  # TODO not canonical
-    cppyy.add_library_path(BUILD_DIR)
+    BUILD_DIR = Path(os.getenv("OGDF_BUILD_DIR")).absolute()
+    cppyy.add_library_path(str(BUILD_DIR))
+    call_if_exists(cppyy.add_library_path, BUILD_DIR / "Debug")
+    call_if_exists(cppyy.add_library_path, BUILD_DIR / "Release")
+    cppyy.add_include_path(str(BUILD_DIR / "include"))
+    for line in open(BUILD_DIR / "CMakeCache.txt"):
+        line = line.strip()
+        if line.startswith("OGDF-PROJECT_SOURCE_DIR"):
+            key, _, val = line.partition("=")
+            cppyy.add_include_path(str(Path(val) / "include"))
+
 try:
     wheel_inst_dir = importlib_resources.files("ogdf_wheel") / "install"
     if wheel_inst_dir.is_dir():
         cppyy.add_library_path(str(wheel_inst_dir / "lib"))
-        cppyy.add_library_path(str(wheel_inst_dir / "bin"))
         cppyy.add_include_path(str(wheel_inst_dir / "include"))
 except ImportError:
     pass
 
+## Now do the actual loading
+
 cppyy.cppdef("#undef NDEBUG")
+if CONFIG == "release":
+    cppyy.cppdef("#define NDEBUG")
+cppyy.include("cassert")
 cppyy.cppdef("#define OGDF_INSTALL")
+
 try:
-    cppyy.load_library("OGDF")
+    if CONFIG == "release":
+        cppyy.load_library("COIN")
+        cppyy.load_library("OGDF")
+    else:
+        cppyy.load_library(f"COIN-{CONFIG}")
+        cppyy.load_library(f"OGDF-{CONFIG}")
+
+    config_autogen_h = "ogdf/basic/internal/config_autogen.h"
+    if not get_include_path(config_autogen_h):
+        # try to find the config-dependent header include path if it isn't correctly configured yet
+        config_include = get_include_path(f"ogdf-{CONFIG}/{config_autogen_h}")
+        if config_include:
+            config_include = config_include.removesuffix(config_autogen_h)
+            cppyy.add_include_path(config_include)
+    cppyy.include(config_autogen_h)
 
-    cppyy.include("ogdf/basic/internal/config_autogen.h")
     cppyy.include("ogdf/basic/internal/config.h")
     cppyy.include("ogdf/basic/Graph.h")
-    try:
-        cppyy.include("ogdf/cluster/ClusterGraphObserver.h")  # otherwise only pre-declared
-    except ImportError:
-        pass # gone in newer versions
     cppyy.include("ogdf/fileformats/GraphIO.h")
     cppyy.include("ogdf/basic/LayoutStandards.h")
-except:
-    print(  # TODO check if the issue is really that the file couldn't be found
-        "ogdf-python couldn't load OGDF. "
+except (RuntimeError, ImportError) as e:
+    raise ImportError(
+        f"ogdf-python couldn't load OGDF in mode '{CONFIG}'.\n"
+        "Please check the above underlying error and check that the below search paths contain "
+        "OGDF headers and shared libraries in the correct release/debug configuration.\n"
         "If you haven't installed OGDF globally to your system, "
-        "please set environment variables OGDF_INSTALL_DIR or OGDF_BUILD_DIR. "
-        "The current search path is:\n%s\n"
-        "The current include path is:\n%s\n" %
-        (cppyy.gbl.gSystem.GetDynamicPath(), cppyy.gbl.gInterpreter.GetIncludePath()),
-        file=sys.stderr)
-    raise
+        "you can use the environment variables OGDF_INSTALL_DIR or OGDF_BUILD_DIR.\n"
+        f"The current search path is:\n{cppyy.gbl.gSystem.GetDynamicPath()}\n"
+        f"The current include path is:\n{cppyy.gbl.gInterpreter.GetIncludePath()}\n"
+    ) from e
 
-if cppyy.gbl.ogdf.debugMode:
-    cppyy.cppdef("#undef NDEBUG")
+if CONFIG == "release":
+    if cppyy.gbl.ogdf.debugMode:
+        warnings.warn("Attempted to load OGDF release build, but the found library was built in debug mode.")
 else:
-    cppyy.cppdef("#define NDEBUG")
-cppyy.include("cassert")
+    if not cppyy.gbl.ogdf.debugMode:
+        warnings.warn("Attempted to load OGDF debug build, but the found library was built in release mode.")
 
-# Load re-exports
+## Load re-exports
 from cppyy import include as cppinclude, cppdef, cppexec, nullptr
 from cppyy.gbl import ogdf
 
-__all__ = ["cppyy", "cppinclude", "cppdef", "cppexec", "nullptr", "ogdf"]
+__all__ = ["cppyy", "cppinclude", "cppdef", "cppexec", "nullptr", "ogdf",
+           "get_library_path", "get_loaded_library_path", "get_include_path", "get_base_include_path"]
 __keep_imports = [cppyy, cppinclude, cppdef, cppexec, nullptr, ogdf]