Make binding submodule private by renaming it scorep._bindings

Author: Flamefire

CMakeLists.txt

@@ -10,22 +10,22 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 find_package(Scorep REQUIRED)
 find_package(Python REQUIRED COMPONENTS Interpreter Development)
 
-Python_add_library(scorep_bindings
+Python_add_library(_bindings
   src/methods.cpp src/scorep_bindings.cpp src/scorepy/events.cpp
 )
 if(Python_VERSION_MAJOR GREATER_EQUAL 3)
-  target_sources(scorep_bindings PRIVATE src/classes.cpp src/scorepy/cInstrumenter.cpp src/scorepy/pythonHelpers.cpp)
+  target_sources(_bindings PRIVATE src/classes.cpp src/scorepy/cInstrumenter.cpp src/scorepy/pythonHelpers.cpp)
 endif()
-target_link_libraries(scorep_bindings PRIVATE Scorep::Plugin)
-target_compile_features(scorep_bindings PRIVATE cxx_std_11)
-target_compile_definitions(scorep_bindings PRIVATE PY_SSIZE_T_CLEAN)
-target_include_directories(scorep_bindings PRIVATE src)
+target_link_libraries(_bindings PRIVATE Scorep::Plugin)
+target_compile_features(_bindings PRIVATE cxx_std_11)
+target_compile_definitions(_bindings PRIVATE PY_SSIZE_T_CLEAN)
+target_include_directories(_bindings PRIVATE src)
 
-set_target_properties(scorep_bindings PROPERTIES
+set_target_properties(_bindings PROPERTIES
   LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/site-packages/scorep
 )
 add_custom_target(ScorepModule ALL
-  ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/scorep $<TARGET_FILE_DIR:scorep_bindings>
+  ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/scorep $<TARGET_FILE_DIR:_bindings>
   COMMENT "Copying module files to build tree"
 )
 
@@ -43,4 +43,4 @@ set_tests_properties(ScorepPythonTests PROPERTIES ENVIRONMENT "PYTHONPATH=${pyth
 set(INSTALL_DIR "lib/python${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}/site-packages")
 
 install(DIRECTORY scorep DESTINATION ${INSTALL_DIR})
-install(TARGETS scorep_bindings DESTINATION ${INSTALL_DIR}/scorep)
+install(TARGETS _bindings DESTINATION ${INSTALL_DIR}/scorep)

scorep/_instrumenters/scorep_cProfile.py

@@ -1,5 +1,5 @@
 from scorep._instrumenters.scorep_instrumenter import ScorepInstrumenter
-from scorep import scorep_bindings
+from scorep import _bindings as scorep_bindings
 
 
 class ScorepCProfile(scorep_bindings.CInstrumenter, ScorepInstrumenter):

scorep/_instrumenters/scorep_cTrace.py

@@ -1,5 +1,5 @@
 from scorep._instrumenters.scorep_instrumenter import ScorepInstrumenter
-from scorep import scorep_bindings
+from scorep import _bindings as scorep_bindings
 
 
 class ScorepCTrace(scorep_bindings.CInstrumenter, ScorepInstrumenter):

scorep/_instrumenters/scorep_instrumenter.py

@@ -2,7 +2,7 @@
 import inspect
 import os
 from scorep._instrumenters import base_instrumenter
-from scorep import scorep_bindings
+from scorep import _bindings as scorep_bindings
 
 
 class ScorepInstrumenter(base_instrumenter.BaseInstrumenter):

scorep/_instrumenters/scorep_profile.py

@@ -3,7 +3,7 @@
 import sys
 from scorep._instrumenters.utils import get_module_name, get_file_name
 from scorep._instrumenters.scorep_instrumenter import ScorepInstrumenter
-from scorep import scorep_bindings
+from scorep import _bindings as scorep_bindings
 
 try:
     import threading

scorep/_instrumenters/scorep_trace.py

@@ -3,7 +3,7 @@
 import sys
 from scorep._instrumenters.utils import get_module_name, get_file_name
 from scorep._instrumenters.scorep_instrumenter import ScorepInstrumenter
-from scorep import scorep_bindings
+from scorep import _bindings as scorep_bindings
 
 try:
     import threading

setup.py

@@ -28,7 +28,7 @@
 if sys.version_info.major >= 3:
     sources.extend(['src/classes.cpp', 'src/scorepy/cInstrumenter.cpp', 'src/scorepy/pythonHelpers.cpp'])
 
-cmodules.append(Extension('scorep.scorep_bindings',
+cmodules.append(Extension('scorep._bindings',
                           include_dirs=include,
                           define_macros=[('PY_SSIZE_T_CLEAN', '1')],
                           extra_compile_args=["-std=c++11"],

src/classes.cpp

@@ -92,9 +92,9 @@ PyTypeObject& getCInstrumenterType()
     };
     // Sets the first few fields explicitely and remaining ones to zero
     static PyTypeObject type = {
-        PyVarObject_HEAD_INIT(nullptr, 0)       /* header */
-        "scorep.scorep_bindings.CInstrumenter", /* tp_name */
-        sizeof(CInstrumenter),                  /* tp_basicsize */
+        PyVarObject_HEAD_INIT(nullptr, 0) /* header */
+        "scorep._bindings.CInstrumenter", /* tp_name */
+        sizeof(CInstrumenter),            /* tp_basicsize */
     };
     type.tp_new = call_object_new;
     type.tp_init = scorepy::castToPyFunc(CInstrumenter_init);

src/scorep_bindings.cpp

@@ -3,19 +3,18 @@
 #include <Python.h>
 
 #if PY_VERSION_HEX < 0x03000000
-PyMODINIT_FUNC initscorep_bindings(void)
+PyMODINIT_FUNC init_bindings(void)
 {
-    (void)Py_InitModule("scorep_bindings", scorepy::getMethodTable());
+    (void)Py_InitModule("_bindings", scorepy::getMethodTable());
 }
 #else  /*python 3*/
-static struct PyModuleDef scorepmodule = { PyModuleDef_HEAD_INIT,
-                                           "scorep_bindings", /* name of module */
+static struct PyModuleDef scorepmodule = { PyModuleDef_HEAD_INIT, "_bindings", /* name of module */
                                            NULL, /* module documentation, may be NULL */
                                            -1,   /* size of per-interpreter state of the module,
                                                     or -1 if the module keeps state in global
                                                     variables. */
                                            scorepy::getMethodTable() };
-PyMODINIT_FUNC PyInit_scorep_bindings(void)
+PyMODINIT_FUNC PyInit__bindings(void)
 {
     auto* ctracerType = &scorepy::getCInstrumenterType();
     if (PyType_Ready(ctracerType) < 0)