[PyROOT] Move CPython extensions in subdirectories

bindings/jupyroot/python/JupyROOT/helpers/handlers.py

@@ -12,14 +12,14 @@
 # For the list of contributors see $ROOTSYS/README/CREDITS.                    #
 ################################################################################
 
 from threading import Thread
 from time import sleep as timeSleep
 from sys import platform
 from os import path
 import queue
 
 from JupyROOT import helpers
-import libROOTPythonizations as _lib
+import ROOT.libROOTPythonizations as _lib
 
 
 class IOHandler(object):
@@ -179,7 +179,7 @@
         if not silent:
             printFunction(ioHandler)
             ioHandler.Clear()
         if executor.HasFinished(): break
         timeSleep(.1)
     executor.Wait()
     ioHandler.EndCapture()

bindings/pyroot/pythonizations/CMakeLists.txt

@@ -169,6 +169,19 @@ set(libname ROOTPythonizations)
 
 add_library(${libname} SHARED ${cpp_sources})
 
+# To make sure that the library also ends up in the right subdirectory in the
+# build directory tree.
+if(MSVC)
+  set_target_properties(${libname}
+      PROPERTIES
+          RUNTIME_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/bin/ROOT
+          RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}/bin/ROOT
+          RUNTIME_OUTPUT_DIRECTORY_MINSIZEREL ${CMAKE_BINARY_DIR}/bin/ROOT
+          RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO ${CMAKE_BINARY_DIR}/bin/ROOT)
+else()
+  set_target_properties(${libname} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/ROOT)
+endif()
+
 # Insert the ROOTPythonizationsPySources in the dependency graph
 add_dependencies(${libname} ROOTPythonizationsPySources)
 
@@ -212,16 +225,16 @@ target_link_libraries(PyROOT INTERFACE cppyy_backend cppyy ROOTPythonizations)
 
 # Install library
 install(TARGETS ${libname} EXPORT ${CMAKE_PROJECT_NAME}Exports
-                            RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT libraries
-                            LIBRARY DESTINATION ${CMAKE_INSTALL_PYTHONDIR} COMPONENT libraries
-                            ARCHIVE DESTINATION ${CMAKE_INSTALL_PYTHONDIR} COMPONENT libraries)
+                            RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}/ROOT COMPONENT libraries
+                            LIBRARY DESTINATION ${CMAKE_INSTALL_PYTHONDIR}/ROOT COMPONENT libraries
+                            ARCHIVE DESTINATION ${CMAKE_INSTALL_PYTHONDIR}/ROOT COMPONENT libraries)
 
 # Install meta-target PyROOT3 (INTERFACE library)
 # Install library
 install(TARGETS PyROOT EXPORT ${CMAKE_PROJECT_NAME}Exports
-                            RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT libraries
-                            LIBRARY DESTINATION ${CMAKE_INSTALL_PYTHONDIR} COMPONENT libraries
-                            ARCHIVE DESTINATION ${CMAKE_INSTALL_PYTHONDIR} COMPONENT libraries)
+                            RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}/ROOT COMPONENT libraries
+                            LIBRARY DESTINATION ${CMAKE_INSTALL_PYTHONDIR}/ROOT COMPONENT libraries
+                            ARCHIVE DESTINATION ${CMAKE_INSTALL_PYTHONDIR}/ROOT COMPONENT libraries)
 
 # Install Python sources and bytecode
 install(DIRECTORY ${localruntimedir}/ROOT

bindings/pyroot/pythonizations/python/ROOT/__init__.py

@@ -8,23 +8,32 @@
 # For the list of contributors see $ROOTSYS/README/CREDITS.                    #
 ################################################################################
 
-from os import environ
+import importlib
+import os
+import sys
 
 # Prevent cppyy's check for the PCH
-environ["CLING_STANDARD_PCH"] = "none"
+os.environ["CLING_STANDARD_PCH"] = "none"
 
 # Prevent cppyy's check for extra header directory
-environ["CPPYY_API_PATH"] = "none"
+os.environ["CPPYY_API_PATH"] = "none"
 
 # Prevent cppyy from filtering ROOT libraries
-environ["CPPYY_NO_ROOT_FILTER"] = "1"
+os.environ["CPPYY_NO_ROOT_FILTER"] = "1"
+
+# The libROOTPythonizations CPython extension is in the same directory as the
+# ROOT Python module, but to find the other ROOT libraries we need to also add
+# the path of the ROOT library directory (only needed on Windows). For example,
+# if the ROOT Python module is in $ROOTSYS/bin/ROOT/__init__.py, the libraries
+# are usually in $ROOTSYS/bin.
+if 'win32' in sys.platform:
+    root_module_path = os.path.dirname(__file__) # expected to be $ROOTSYS/bin/ROOT
+    os.add_dll_directory(os.path.dirname(root_module_path)) # expected to be $ROOTSYS/bin
 
 # Do setup specific to AddressSanitizer environments
 from . import _asan
 
 import cppyy
-import sys, importlib
-import libROOTPythonizations
 
 # Build cache of commonly used python strings (the cache is python intern, so
 # all strings are shared python-wide, not just in PyROOT).
@@ -34,12 +43,12 @@
     _cached_strings.append(sys.intern(s))
 
 # Trigger the addition of the pythonizations
 from ._pythonization import _register_pythonizations
 
 _register_pythonizations()
 
 # Check if we are in the IPython shell
 import builtins
 
 _is_ipython = hasattr(builtins, "__IPYTHON__")
 
@@ -64,7 +73,7 @@
 __all__ = _PoisonedDunderAll()
 
 # Configure ROOT facade module
 import sys
 from ._facade import ROOTFacade
 
 _root_facade = ROOTFacade(sys.modules[__name__], _is_ipython)

bindings/pyroot/pythonizations/python/ROOT/_application.py

@@ -13,7 +13,7 @@
 
 from cppyy.gbl import gSystem, gInterpreter, gEnv
 
-from libROOTPythonizations import InitApplication, InstallGUIEventInputHook
+from ROOT.libROOTPythonizations import InitApplication, InstallGUIEventInputHook
 
 
 class PyROOTApplication(object):
@@ -35,6 +35,7 @@ def _ipython_config():
 
         from IPython import get_ipython
         from IPython.terminal import pt_inputhooks
+        from IPython.terminal.interactiveshell import TerminalInteractiveShell
 
         def inputhook(context):
             while not context.input_is_ready():
@@ -44,7 +45,10 @@ def inputhook(context):
         pt_inputhooks.register('ROOT', inputhook)
 
         ipy = get_ipython()
-        if ipy:
+
+        # Only the TerminalInteractiveShell will use the input hooks that are
+        # registered via terminal.pt_inputhooks.
+        if ipy and isinstance(ipy, TerminalInteractiveShell):
             get_ipython().run_line_magic('gui', 'ROOT')
 
     @staticmethod
@@ -75,10 +79,11 @@ def init_graphics(self):
 
         # Note that we only end up in this function if gROOT.IsBatch() is false
         import __main__
-        if self._is_ipython and 'IPython' in sys.modules and sys.modules['IPython'].version_info[0] >= 5:
+
+        if self._is_ipython and "IPython" in sys.modules and sys.modules["IPython"].version_info[0] >= 5:
             # ipython and notebooks, register our event processing with their hooks
             self._ipython_config()
-        elif sys.flags.interactive == 1 or not hasattr(__main__, '__file__') or gSystem.InheritsFrom('TMacOSXSystem'):
+        elif sys.flags.interactive == 1 or not hasattr(__main__, "__file__") or gSystem.InheritsFrom("TMacOSXSystem"):
             # Python in interactive mode, use the PyOS_InputHook to call our event processing
             # - sys.flags.interactive checks for the -i flags passed to python
             # - __main__ does not have the attribute __file__ if the Python prompt is started directly
@@ -94,12 +99,13 @@ def _process_root_events(self):
                 while self.keep_polling:
                     gSystem.ProcessEvents()
                     time.sleep(0.01)
+
             import threading
-            self.keep_polling = True # Used to shut down the thread safely at teardown time
+
+            self.keep_polling = True  # Used to shut down the thread safely at teardown time
             update_thread = threading.Thread(None, _process_root_events, None, (self,))
-            self.process_root_events = update_thread # The thread is joined at teardown time
+            self.process_root_events = update_thread  # The thread is joined at teardown time
             update_thread.daemon = True
             update_thread.start()
 
         self._set_display_hook()
-

bindings/pyroot/pythonizations/python/ROOT/_facade.py

@@ -173,7 +173,7 @@ def _register_converters_and_executors(self):
             "Double32_t&": "double&",
         }
 
-        from libROOTPythonizations import CPyCppyyRegisterConverterAlias, CPyCppyyRegisterExecutorAlias
+        from ROOT.libROOTPythonizations import CPyCppyyRegisterConverterAlias, CPyCppyyRegisterExecutorAlias
 
         for name, target in converter_aliases.items():
             CPyCppyyRegisterConverterAlias(name, target)

bindings/pyroot/pythonizations/python/ROOT/_pythonization/_cppinstance.py

@@ -10,7 +10,7 @@
 
 def pythonize_cppinstance():
     import cppyy
-    from libROOTPythonizations import AddCPPInstancePickling
+    from ROOT.libROOTPythonizations import AddCPPInstancePickling
 
     klass = cppyy._backend.CPPInstance
 

bindings/pyroot/pythonizations/python/ROOT/_pythonization/_generic.py

@@ -8,7 +8,7 @@
 # For the list of contributors see $ROOTSYS/README/CREDITS.                    #
 ################################################################################
 
-from libROOTPythonizations import AddPrettyPrintingPyz
+from ROOT.libROOTPythonizations import AddPrettyPrintingPyz
 
 def _add_getitem_checked(klass):
     # Parameters:

bindings/pyroot/pythonizations/python/ROOT/_pythonization/_rdf_namespace.py

@@ -94,7 +94,7 @@ def _rdataframe(local_rdf, distributed_rdf):
 
     def rdataframe(*args, **kwargs):
         import ROOT
-        from libROOTPythonizations import PyObjRefCounterAsStdAny
+        from ROOT.libROOTPythonizations import PyObjRefCounterAsStdAny
 
         if kwargs.get("executor", None) is not None:
             rdf = distributed_rdf(*args, **kwargs)

bindings/pyroot/pythonizations/python/ROOT/_pythonization/_tclass.py

@@ -9,7 +9,7 @@
 ################################################################################
 
 import cppyy
-from libROOTPythonizations import AddTClassDynamicCastPyz
+from ROOT.libROOTPythonizations import AddTClassDynamicCastPyz
 
 
 def pythonize_tclass():

bindings/pyroot/pythonizations/python/ROOT/_pythonization/_tobject.py

@@ -8,7 +8,7 @@
 # For the list of contributors see $ROOTSYS/README/CREDITS.                    #
 ################################################################################
 
-from libROOTPythonizations import AddTObjectEqNePyz
+from ROOT.libROOTPythonizations import AddTObjectEqNePyz
 import cppyy
 
 # Searching

bindings/pyroot/pythonizations/python/ROOT/_pythonization/_ttree.py

@@ -159,7 +159,7 @@
 \endpythondoc
 """
 
-from libROOTPythonizations import GetBranchAttr, BranchPyz
+from ROOT.libROOTPythonizations import GetBranchAttr, BranchPyz
 from ._rvec import _array_interface_dtype_map, _get_cpp_type_from_numpy_type
 from . import pythonization
 from ROOT._pythonization._memory_utils import _should_give_up_ownership, _constructor_releasing_ownership, _SetDirectory_SetOwnership