Cleanup not used parts of serialization.reflect module. Add tests for the rest and fix py 3 support.

Author: kowalski

serialization/reflect.py

@@ -22,6 +22,7 @@
 
 from __future__ import absolute_import
 
+from six.moves import builtins
 from functools import wraps
 import inspect
 import sys
@@ -69,17 +70,6 @@ def wrapper(*orig_args, **orig_kwargs):
     return wrapper
 
 
-@unicode_args
-def named_function(name):
-    """Gets a fully named module-global object."""
-    name_parts = name.split('.')
-    module = named_object('.'.join(name_parts[:-1]))
-    func = getattr(module, name_parts[-1])
-    if hasattr(func, 'original_func'):
-        func = func.original_func
-    return func
-
-
 @unicode_args
 def named_module(name):
     """Returns a module given its name."""
@@ -112,52 +102,6 @@ def class_locals(depth, tag=None):
     return locals
 
 
-def class_canonical_name(depth):
-    frame = sys._getframe(depth)
-    module = frame.f_locals['__module__']
-    class_name = frame.f_code.co_name
-    return '.'.join([module, class_name])
-
-
-def inside_class_definition(depth):
-    frame = sys._getframe(depth)
-    locals = frame.f_locals
-    # Try to make sure we were called from a class def. In 2.2.0 we can't
-    # check for __module__ since it doesn't seem to be added to the locals
-    # until later on.  (Copied From zope.interfaces.declartion._implements)
-    if ((locals is frame.f_globals)
-        or (('__module__' not in locals)
-            and sys.version_info[:3] > (2, 2, 0))):
-        return False
-    return True
-
-
-def formatted_function_name(function):
-    if hasattr(function, 'original_func'):
-        function = function.original_func
-    argspec = inspect.getargspec(function)
-    defaults = argspec.defaults and list(argspec.defaults) or list()
-
-    if argspec.args and argspec.args[0] == 'self':
-        argspec.args.pop(0)
-    if argspec.args and argspec.args[0] == 'state':
-        argspec.args.pop(0)
-
-    args = argspec.args or list()
-    display_args = [x if len(defaults) < -index
-                    else "%s=%s" % (x, defaults[index])
-                    for x, index in zip(args, range(-len(args), 0, 1))]
-    if argspec.varargs:
-        display_args += ['*%s' % (argspec.varargs)]
-    if argspec.keywords:
-        display_args += ['**%s' % (argspec.keywords)]
-
-    text = "%s(" % (function.__name__, )
-    text += ', '.join(display_args)
-    text += ')'
-    return text
-
-
 ### Private Methods ###
 
 
@@ -176,5 +120,4 @@ def _canonical_method(obj):
 
 
 def _canonical_builtin(obj):
-    # TODO: py2 only
-    return "__builtin__." + obj.__name__
+    return builtins.__name__ + '.' + obj.__name__

tests/test_reflect.py

@@ -0,0 +1,112 @@
+# F3AT - Flumotion Asynchronous Autonomous Agent Toolkit
+# Copyright (C) 2010,2011 Flumotion Services, S.A.
+# All rights reserved.
+
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+# See 'LICENSE.GPL' in the source distribution for more information.
+
+# Headers in this file shall remain intact.
+# -*- coding: utf-8 -*-
+# -*- Mode: Python -*-
+# vi:si:et:sw=4:sts=4:ts=4
+
+import pytest
+from serialization import reflect
+from six.moves import builtins
+from zope.interface import Interface
+
+
+class DummyInterface(Interface):
+    pass
+
+
+class Dummy(object):
+
+    def spam(self):
+        pass
+
+
+def bacon():
+    pass
+
+
+class Meta(type):
+    pass
+
+
+class MetaDummy(object):
+    __metaclass__ = Meta
+
+
+class TestIntrospection(object):
+
+    @pytest.fixture(scope='session')
+    def builtin_module(self):
+        return builtins.__name__
+
+    def test_interface(self):
+        assert (
+            'tests.test_reflect.DummyInterface' ==
+            reflect.canonical_name(DummyInterface))
+
+    def test_class(self, builtin_module):
+        assert 'tests.test_reflect.Dummy' == reflect.canonical_name(Dummy)
+        assert 'tests.test_reflect.Dummy' == reflect.canonical_name(Dummy())
+        assert builtin_module + '.int' == reflect.canonical_name(int)
+        assert builtin_module + '.str' == reflect.canonical_name('some string')
+
+    def test_class_with_meta(self):
+        assert (
+            'tests.test_reflect.MetaDummy' ==
+            reflect.canonical_name(MetaDummy))
+
+    def test_method(self, builtin_module):
+        assert (
+            'tests.test_reflect.Dummy.spam' ==
+            reflect.canonical_name(Dummy.spam))
+        assert (
+            'tests.test_reflect.Dummy.spam' ==
+            reflect.canonical_name(Dummy().spam))
+        assert (
+            builtin_module + '.split' ==
+            reflect.canonical_name('test'.split))
+
+    def test_function(self, builtin_module):
+        assert 'tests.test_reflect.bacon' == reflect.canonical_name(bacon)
+        assert builtin_module + '.getattr' == reflect.canonical_name(getattr)
+
+    def test_none(self):
+        assert None == reflect.canonical_name(None)
+
+    def test_class_locals_not_from_class(self):
+        with pytest.raises(TypeError):
+            reflect.class_locals(depth=2)
+
+
+def simple(a, b):
+    pass
+
+
+def defaults(a, b=3):
+    pass
+
+
+def varargs(a, b=None, *args):
+    pass
+
+
+def kwargs(a=None, b=3, *args, **kwargs):
+    pass