fix: Make filename relative to sys.path (#121)

* fix: Make filename relative to sys.path

* fix: Add suggestion from armin

* fix: replace .pyc with .py

Author: untitaker

sentry_sdk/utils.py

@@ -304,6 +304,23 @@ def extract_locals(frame):
     return rv
 
 
+def filename_for_module(module, abs_path):
+    try:
+        if abs_path.endswith(".pyc"):
+            abs_path = abs_path[:-1]
+
+        base_module = module.split(".", 1)[0]
+        if base_module == module:
+            return os.path.basename(abs_path)
+
+        base_module_path = sys.modules[base_module].__file__
+        return abs_path.split(base_module_path.rsplit(os.sep, 2)[0], 1)[-1].lstrip(
+            os.sep
+        )
+    except Exception:
+        return abs_path
+
+
 def serialize_frame(frame, tb_lineno=None, with_locals=True):
     f_code = getattr(frame, "f_code", None)
     if f_code:
@@ -323,8 +340,8 @@ def serialize_frame(frame, tb_lineno=None, with_locals=True):
     pre_context, context_line, post_context = get_source_context(frame, tb_lineno)
 
     rv = {
-        "filename": abs_path and os.path.basename(abs_path) or None,
-        "abs_path": os.path.abspath(abs_path),
+        "filename": filename_for_module(module, abs_path) or None,
+        "abs_path": os.path.abspath(abs_path) if abs_path else None,
         "function": function or "<unknown>",
         "module": module,
         "lineno": tb_lineno,

tests/test_utils.py

@@ -12,6 +12,7 @@
     exceptions_from_error_tuple,
     format_and_strip,
     strip_string,
+    filename_for_module,
 )
 from sentry_sdk._compat import text_type
 
@@ -41,12 +42,13 @@ def test_abs_path():
         exceptions = exceptions_from_error_tuple(sys.exc_info())
 
     exception, = exceptions
-    frames = exception["stacktrace"]["frames"]
-    assert len(frames) == 2
+    frame1, frame2 = frames = exception["stacktrace"]["frames"]
 
     for frame in frames:
         assert os.path.abspath(frame["abs_path"]) == frame["abs_path"]
-        assert os.path.basename(frame["filename"]) == frame["filename"]
+
+    assert frame1["filename"] == "tests/test_utils.py"
+    assert frame2["filename"] == "test.py"
 
 
 def test_non_string_variables():
@@ -96,3 +98,16 @@ def x(template, params):
         "len": 14,
         "rem": [["!limit", "x", 3, 6], ["!limit", "x", 9, 12]],
     }
+
+
+def test_filename():
+    x = filename_for_module
+
+    assert x("bogus", "bogus") == "bogus"
+
+    assert x("os", os.__file__) == "os.py"
+    assert x("pytest", pytest.__file__) == "pytest.py"
+
+    import sentry_sdk.utils
+
+    assert x("sentry_sdk.utils", sentry_sdk.utils.__file__) == "sentry_sdk/utils.py"