Merge pull request #125 from AndreasGocht/master

using our own `abspath` function as `os.path.abspath` might fail during shutdown.
See https://bugs.python.org/msg315588 for more details.

Author: AndreasGocht

scorep/_instrumenters/utils.py

@@ -1,9 +1,9 @@
-import os
+from scorep._bindings import abspath
 
 
 def get_module_name(frame):
     """Get the name of the module the given frame resides in"""
-    modulename = frame.f_globals.get('__name__', None)
+    modulename = frame.f_globals.get("__name__", None)
     if modulename is None:
         # this is a NUMPY special situation, see NEP-18, and Score-P Issue
         # issues #63
@@ -18,7 +18,7 @@ def get_file_name(frame):
     """Get the full path to the file the given frame resides in"""
     file_name = frame.f_code.co_filename
     if file_name is not None:
-        full_file_name = os.path.abspath(file_name)
+        full_file_name = abspath(file_name)
     else:
         full_file_name = "None"
     return full_file_name

scorep/_version.py

@@ -1 +1 @@
-__version__ = "3.3.0"
+__version__ = "3.3.1"

setup.py

@@ -5,80 +5,92 @@
 from scorep.instrumenter import has_c_instrumenter
 
 if scorep.helper.get_scorep_version() < 5.0:
-    raise RuntimeError(
-        "Score-P version less than 5.0, plase use Score-P >= 5.0")
+    raise RuntimeError("Score-P version less than 5.0, plase use Score-P >= 5.0")
 
 link_mode = scorep.helper.get_scorep_config("Link mode:")
 if not ("shared=yes" in link_mode):
     raise RuntimeError(
-        "Score-P not build with \"--enable-shared\". Link mode is:\n{}".format(link_mode))
+        'Score-P not build with "--enable-shared". Link mode is:\n{}'.format(link_mode)
+    )
 
 check_compiler = scorep.helper.get_scorep_config("C99 compiler used:")
 if "gcc" in check_compiler:
     gcc_plugin = scorep.helper.get_scorep_config("GCC plug-in support:")
     if not ("yes" in gcc_plugin):
-        raise RuntimeError("Score-P uses GCC but is not build with GCC Compiler Plugin. "
-                           "GCC plug-in support is:\n{}".format(gcc_plugin))
+        raise RuntimeError(
+            "Score-P uses GCC but is not build with GCC Compiler Plugin. "
+            "GCC plug-in support is:\n{}".format(gcc_plugin)
+        )
 
 
 cmodules = []
 (include, _, _, _, _) = scorep.helper.generate_compile_deps([])
-src_folder = os.path.abspath('src')
+src_folder = os.path.abspath("src")
 include += [src_folder]
-sources = ['src/methods.cpp', 'src/scorep_bindings.cpp', 'src/scorepy/events.cpp']
-define_macros = [('PY_SSIZE_T_CLEAN', '1')]
+sources = [
+    "src/methods.cpp",
+    "src/scorep_bindings.cpp",
+    "src/scorepy/events.cpp",
+    "src/scorepy/pathUtils.cpp",
+]
+define_macros = [("PY_SSIZE_T_CLEAN", "1")]
 # We are using the UTF-8 string features from Python 3
 # The C Instrumenter functions are not available on PyPy
 if has_c_instrumenter():
-    sources.extend([
-        'src/classes.cpp',
-        'src/scorepy/cInstrumenter.cpp',
-        'src/scorepy/pythonHelpers.cpp',
-        'src/scorepy/pathUtils.cpp',
-    ])
-    define_macros.append(('SCOREPY_ENABLE_CINSTRUMENTER', '1'))
+    sources.extend(
+        [
+            "src/classes.cpp",
+            "src/scorepy/cInstrumenter.cpp",
+            "src/scorepy/pythonHelpers.cpp",
+        ]
+    )
+    define_macros.append(("SCOREPY_ENABLE_CINSTRUMENTER", "1"))
 else:
-    define_macros.append(('SCOREPY_ENABLE_CINSTRUMENTER', '0'))
+    define_macros.append(("SCOREPY_ENABLE_CINSTRUMENTER", "0"))
 
-cmodules.append(Extension('scorep._bindings',
-                          include_dirs=include,
-                          define_macros=define_macros,
-                          extra_compile_args=["-std=c++11"],
-                          sources=sources))
+cmodules.append(
+    Extension(
+        "scorep._bindings",
+        include_dirs=include,
+        define_macros=define_macros,
+        extra_compile_args=["-std=c++11"],
+        sources=sources,
+    )
+)
 
 setup(
-    name='scorep',
+    name="scorep",
     version=scorep._version.__version__,
-    description='This is a Score-P tracing package for python',
-    author='Andreas Gocht',
-    author_email='andreas.gocht@tu-dresden.de',
-    url='https://github.com/score-p/scorep_binding_python',
-    long_description='''
+    description="This is a Score-P tracing package for python",
+    author="Andreas Gocht",
+    author_email="andreas.gocht@tu-dresden.de",
+    url="https://github.com/score-p/scorep_binding_python",
+    long_description="""
 This package allows tracing of python code using Score-P.
 A working Score-P version is required.
 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',
-        'Environment :: Console',
-        'Intended Audience :: Developers',
-        'Topic :: Software Development :: Testing',
-        'Topic :: Software Development :: Quality Assurance',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
-        'Programming Language :: Python :: 3.7',
-        'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: Implementation :: CPython',
-        'Programming Language :: Python :: Implementation :: PyPy',
-        'Operating System :: POSIX',
-        'Operating System :: Unix',
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Testing",
+        "Topic :: Software Development :: Quality Assurance",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy",
+        "Operating System :: POSIX",
+        "Operating System :: Unix",
     ],
 )

src/methods.cpp

@@ -1,5 +1,6 @@
 #include "methods.hpp"
 #include "scorepy/events.hpp"
+#include "scorepy/pathUtils.hpp"
 #include <Python.h>
 #include <cstdint>
 #include <scorep/SCOREP_User_Functions.h>
@@ -180,6 +181,16 @@ extern "C"
         return PyUnicode_FromString(SCOREP_GetExperimentDirName());
     }
 
+    static PyObject* abspath(PyObject* self, PyObject* args)
+    {
+        const char* path;
+
+        if (!PyArg_ParseTuple(args, "s", &path))
+            return NULL;
+
+        return PyUnicode_FromString(scorepy::abspath(path).c_str());
+    }
+
     static PyMethodDef ScorePMethods[] = {
         { "region_begin", region_begin, METH_VARARGS, "enter a region." },
         { "region_end", region_end, METH_VARARGS, "exit a region." },
@@ -194,6 +205,7 @@ extern "C"
         { "parameter_string", parameter_string, METH_VARARGS, "User parameter string." },
         { "get_experiment_dir_name", get_experiment_dir_name, METH_VARARGS,
           "Get the Score-P experiment dir." },
+        { "abspath", abspath, METH_VARARGS, "Estimates the absolute Path." },
         { NULL, NULL, 0, NULL } /* Sentinel */
     };
 }

test/test_scorep.py

@@ -19,14 +19,22 @@ def call(arguments, expected_returncode=0, env=None):
             arguments, env=env, stdout=subprocess.PIPE, stderr=subprocess.PIPE
         )
         print(out.stdout, out.stderr)
-        assert out.returncode == expected_returncode
+        try:
+            assert out.returncode == expected_returncode
+        except AssertionError as e:
+            e.args += ("stderr: {}".format(out.stderr.decode("utf-8")),)
+            raise
         stdout, stderr = (out.stdout, out.stderr)
     else:
         p = subprocess.Popen(
             arguments, env=env, stdout=subprocess.PIPE, stderr=subprocess.PIPE
         )
         stdout, stderr = p.communicate()
-        assert p.returncode == expected_returncode
+        try:
+            assert p.returncode == expected_returncode
+        except AssertionError as e:
+            e.args += ("stderr: {}".format(stderr.decode("utf-8")),)
+            raise
     return stdout.decode("utf-8"), stderr.decode("utf-8")
 
 
@@ -51,8 +59,8 @@ def requires_package(name):
 
 
 cinstrumenter_skip_mark = pytest.mark.skipif(
-    sys.version_info.major < 3 or platform.python_implementation() == 'PyPy',
-    reason="CInstrumenter only available in Python 3 and not in PyPy"
+    sys.version_info.major < 3 or platform.python_implementation() == "PyPy",
+    reason="CInstrumenter only available in Python 3 and not in PyPy",
 )
 # All instrumenters (except dummy which isn't a real one)
 ALL_INSTRUMENTERS = [
@@ -90,6 +98,7 @@ def test_has_version():
 @cinstrumenter_skip_mark
 def test_has_c_instrumenter():
     from scorep.instrumenter import has_c_instrumenter
+
     assert has_c_instrumenter()