Merge pull request #58 from Callek/frame_traversal

Better support for missing __name__ in frame traversal

AUTHORS.rst

@@ -20,6 +20,7 @@ The following folks helped forming ``structlog`` into what it is now:
 - `Itamar Turner-Trauring <https://github.com/itamarst>`_
 - `Jack Pearkes <https://github.com/pearkes>`_
 - `Jean-Paul Calderone <http://as.ynchrono.us>`_
+- `Justin Wood (Callek) <https://github.com/Callek>`_
 - `Lakshmi Kannan <https://github.com/lakshmi-kannan>`_
 - `Lynn Root <https://github.com/econchick>`_
 - `Mathieu Leplatre <https://github.com/leplatrem>`_

docs/changelog.rst

@@ -2,6 +2,7 @@
 Changelog
 =========
 
+- :bug:`- major` Tolerate frames without a ``__name__``, better.
 - :feature:`-` Officially support Python 3.5.
 - :feature:`-` Add :func:`structlog.ReturnLogger.failure` and :func:`structlog.PrintLogger.failure` as preparation for the new Twisted logging system.
 - :release:`15.2.0 <2015-06-10>`

structlog/_frames.py

@@ -37,10 +37,10 @@ def _find_first_app_frame_and_name(additional_ignores=None):
     """
     ignores = ["structlog"] + (additional_ignores or [])
     f = sys._getframe()
-    name = f.f_globals.get("__name__", "?")
+    name = f.f_globals.get("__name__") or "?"
     while any(name.startswith(i) for i in ignores):
         f = f.f_back
-        name = f.f_globals.get("__name__", "?")
+        name = f.f_globals.get("__name__") or "?"
     return f, name
 
 

tests/test_frames.py

@@ -28,7 +28,7 @@ def test_ignores_structlog_by_default(self, monkeypatch):
         f2 = stub(f_globals={'__name__': 'structlog.blubb'}, f_back=f1)
         monkeypatch.setattr(structlog._frames.sys, '_getframe', lambda: f2)
         f, n = _find_first_app_frame_and_name()
-        assert ((f1, 'test') == f, n)
+        assert ((f1, 'test') == (f, n))
 
     def test_ignoring_of_additional_frame_names_works(self, monkeypatch):
         """
@@ -38,17 +38,37 @@ def test_ignoring_of_additional_frame_names_works(self, monkeypatch):
         f2 = stub(f_globals={'__name__': 'ignored.bar'}, f_back=f1)
         f3 = stub(f_globals={'__name__': 'structlog.blubb'}, f_back=f2)
         monkeypatch.setattr(structlog._frames.sys, '_getframe', lambda: f3)
-        f, n = _find_first_app_frame_and_name()
-        assert ((f1, 'test') == f, n)
+        f, n = _find_first_app_frame_and_name(additional_ignores=['ignored'])
+        assert ((f1, 'test') == (f, n))
 
     def test_tolerates_missing_name(self, monkeypatch):
         """
         Use ``?`` if `f_globals` lacks a `__name__` key
         """
         f1 = stub(f_globals={}, f_back=None)
+        monkeypatch.setattr(structlog._frames.sys, "_getframe", lambda: f1)
         f, n = _find_first_app_frame_and_name()
+        assert ((f1, "?") == (f, n))
+
+    def test_tolerates_name_explicitly_None_oneframe(self, monkeypatch):
+        """
+        Use ``?`` if `f_globals` has a `None` valued `__name__` key
+        """
+        f1 = stub(f_globals={'__name__': None}, f_back=None)
         monkeypatch.setattr(structlog._frames.sys, "_getframe", lambda: f1)
-        assert ((f1, "?") == f, n)
+        f, n = _find_first_app_frame_and_name()
+        assert ((f1, "?") == (f, n))
+
+    def test_tolerates_name_explicitly_None_manyframe(self, monkeypatch):
+        """
+        Use ``?`` if `f_globals` has a `None` valued `__name__` key,
+        multiple frames up.
+        """
+        f1 = stub(f_globals={'__name__': None}, f_back=None)
+        f2 = stub(f_globals={'__name__': 'structlog.blubb'}, f_back=f1)
+        monkeypatch.setattr(structlog._frames.sys, "_getframe", lambda: f2)
+        f, n = _find_first_app_frame_and_name()
+        assert ((f1, "?") == (f, n))
 
 
 @pytest.fixture