Reorganize sources (#85)

* File structure:
  * src/*.* contains glue code to define the extension module
  * src/scorepy contains namespaced implementation
* Rename instrumenters to _instrumenters to show it is private
* Use Py_RETURN_NONE macro

Author: Flamefire

CMakeLists.txt

@@ -10,8 +10,10 @@ 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 src/scorep.cpp)
-target_link_libraries(scorep_bindings PRIVATE Scorep::Scorep)
+Python_add_library(scorep_bindings
+  src/methods.cpp src/scorep_bindings.cpp src/scorepy/events.cpp
+)
+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)

scorep/instrumenters/__init__.py scorep/_instrumenters/__init__.pyscorep/instrumenters/__init__.py renamed to scorep/_instrumenters/__init__.py

@@ -1,6 +1,6 @@
 __all__ = ['ScorepDummy']
 
-import scorep.instrumenters.base_instrumenter as base_instrumenter
+import scorep._instrumenters.base_instrumenter as base_instrumenter
 
 
 class ScorepDummy(base_instrumenter.BaseInstrumenter):

scorep/instrumenters/base_instrumenter.py …orep/_instrumenters/base_instrumenter.pyscorep/instrumenters/base_instrumenter.py renamed to scorep/_instrumenters/base_instrumenter.py scorep/instrumenters/base_instrumenter.py renamed to scorep/_instrumenters/base_instrumenter.py

@@ -1,7 +1,7 @@
 import abc
 import inspect
 import os
-from scorep.instrumenters import base_instrumenter
+from scorep._instrumenters import base_instrumenter
 from scorep import scorep_bindings
 
 

scorep/instrumenters/dummy.py scorep/_instrumenters/dummy.pyscorep/instrumenters/dummy.py renamed to scorep/_instrumenters/dummy.py

@@ -1,8 +1,8 @@
 __all__ = ['ScorepProfile']
 
 import sys
-from scorep.instrumenters.utils import get_module_name, get_file_name
-from scorep.instrumenters.scorep_instrumenter import ScorepInstrumenter
+from scorep._instrumenters.utils import get_module_name, get_file_name
+from scorep._instrumenters.scorep_instrumenter import ScorepInstrumenter
 from scorep import scorep_bindings
 
 try:

…rep/instrumenters/scorep_instrumenter.py …ep/_instrumenters/scorep_instrumenter.pyscorep/instrumenters/scorep_instrumenter.py renamed to scorep/_instrumenters/scorep_instrumenter.py scorep/instrumenters/scorep_instrumenter.py renamed to scorep/_instrumenters/scorep_instrumenter.py

@@ -1,8 +1,8 @@
 __all__ = ['ScorepTrace']
 
 import sys
-from scorep.instrumenters.utils import get_module_name, get_file_name
-from scorep.instrumenters.scorep_instrumenter import ScorepInstrumenter
+from scorep._instrumenters.utils import get_module_name, get_file_name
+from scorep._instrumenters.scorep_instrumenter import ScorepInstrumenter
 from scorep import scorep_bindings
 
 try:

scorep/instrumenters/scorep_profile.py scorep/_instrumenters/scorep_profile.pyscorep/instrumenters/scorep_profile.py renamed to scorep/_instrumenters/scorep_profile.py

@@ -16,13 +16,13 @@ def get_instrumenter(enable_instrumenter=False,
     global global_instrumenter
     if global_instrumenter is None:
         if instrumenter_type == "profile":
-            from scorep.instrumenters.scorep_profile import ScorepProfile
+            from scorep._instrumenters.scorep_profile import ScorepProfile
             global_instrumenter = ScorepProfile(enable_instrumenter)
         elif instrumenter_type == "trace":
-            from scorep.instrumenters.scorep_trace import ScorepTrace
+            from scorep._instrumenters.scorep_trace import ScorepTrace
             global_instrumenter = ScorepTrace(enable_instrumenter)
         elif instrumenter_type == "dummy":
-            from scorep.instrumenters.dummy import ScorepDummy
+            from scorep._instrumenters.dummy import ScorepDummy
             global_instrumenter = ScorepDummy(enable_instrumenter)
         else:
             raise RuntimeError('instrumenter_type "{}" unkown'.format(instrumenter_type))
@@ -58,6 +58,7 @@ class enable():
     This overides --no-instrumenter (--nopython leagacy)
     If a region name is given, the region the contextmanager is active will be marked in the trace or profile
     """
+
     def __init__(self, region_name=None):
         self.region_name = region_name
 
@@ -99,6 +100,7 @@ class disable():
     This overides --no-instrumenter (--nopython leagacy)
     If a region name is given, the region the contextmanager is active will be marked in the trace or profile
     """
+
     def __init__(self, region_name=None):
         self.region_name = region_name
 

scorep/instrumenters/scorep_trace.py scorep/_instrumenters/scorep_trace.pyscorep/instrumenters/scorep_trace.py renamed to scorep/_instrumenters/scorep_trace.py

@@ -23,11 +23,13 @@
 (include, _, _, _, _) = scorep.helper.generate_compile_deps()
 src_folder = os.path.abspath('src')
 include += [src_folder]
+sources = ['src/methods.cpp', 'src/scorep_bindings.cpp', 'src/scorepy/events.cpp']
+
 cmodules.append(Extension('scorep.scorep_bindings',
                           include_dirs=include,
                           define_macros=[('PY_SSIZE_T_CLEAN', '1')],
                           extra_compile_args=["-std=c++11"],
-                          sources=['src/scorep.cpp']))
+                          sources=sources))
 
 setup(
     name='scorep',
@@ -42,7 +44,7 @@
 To enable tracing it uses LD_PRELOAD to load the Score-P runtime libraries.
 Besides this, it uses the traditional python-tracing infrastructure.
 ''',
-    packages=['scorep', 'scorep.instrumenters'],
+    packages=['scorep', 'scorep._instrumenters'],
     ext_modules=cmodules,
     classifiers=[
         'Development Status :: 4 - Beta',