Context Navigation

Back to Ticket #11791

Ticket #11791: trac11791_dynamic_metaclass_introspection.patch

File trac11791_dynamic_metaclass_introspection.patch, 11.6 KB (added by SimonKing, 8 years ago)
Introspection for classes with dynamic metaclass

sage/misc/sageinspect.py

# HG changeset patch
# User Simon King <simon.king@uni-jena.de>
# Date 1315840400 -7200
# Node ID 7c549232263753f43e626194e2e90de5a794d1a3
# Parent  a1187778c16cbf1981c9e9e53d4c661d5ec4c036
#11791: Introspection for interactive class definitions with dynamic metaclass, rel #9107

diff --git a/sage/misc/sageinspect.py b/sage/misc/sageinspect.py

-                      a
 - William Stein (extensive modifications)
 - Nick Alexander (extensions)
 - Nick Alexander (testing)
+- Simon King (some extension for Cython, generalisation of SageArgSpecVisitor)
+- Simon King (some extension for Cython, generalisation
+  of SageArgSpecVisitor, improved handling of nested
+  classes)
 EXAMPLES::
 …
         sage: sage_getfile(Sq)[-42:]
         'sage/algebras/steenrod/steenrod_algebra.py'
     The following tests against some bugs fixed in trac ticket #9976::
+    The following tests against some bugs fixed in :trac:`9976`::
         sage: obj = sage.combinat.partition_algebra.SetPartitionsAk
         sage: obj = sage.combinat.partition_algebra.SetPartitionsAk
         sage: sage_getfile(obj)
         '...sage/combinat/partition_algebra.py'
     And here is another bug, fixed in trac ticket #11298::
+    And here is another bug, fixed in :trac:`11298`::
         sage: P.<x,y> = QQ[]
         sage: sage_getfile(P)
         '...sage/rings/polynomial/multi_polynomial_libsingular.pyx'
+    The following has been enabled in :trac:`11791`::
+        sage: cython_code = [
+        ... 'from sage.structure.dynamic_class import dynamic_class',
+        ... 'from sage.misc.classcall_metaclass import ClasscallMetaclass',
+        ... 'from sage.all import cached_function',
+        ... 'MyMetaclass = dynamic_class("MyMetaclass",(ClasscallMetaclass,))',
+        ... 'class Bar2:',
+        ... '    __metaclass__ = MyMetaclass',
+        ... '    @cached_function',
+        ... '    def __classcall__(cls, R):',
+        ... '        return type.__call__(cls, R)',
+        ... '    def __init__(self,R):',
+        ... '        self.R = R',
+        ... '    def __repr__(self):',
+        ... '        return "[%s]"%self.R',
+        ... '    def __hash__(self):',
+        ... '        print "computing the hash"',
+        ... '        return int(12345)']
+        sage: cython('\n'.join(cython_code))
+        sage: print ''.join(open(sage_getfile(Bar2)).readlines())
+        <BLANKLINE>
+        include "interrupt.pxi"  # ctrl-c interrupt block support
+        include "stdsage.pxi"  # ctrl-c interrupt block support
+        <BLANKLINE>
+        include "cdefs.pxi"
+        from sage.structure.dynamic_class import dynamic_class
+        from sage.misc.classcall_metaclass import ClasscallMetaclass
+        from sage.all import cached_function
+        MyMetaclass = dynamic_class("MyMetaclass",(ClasscallMetaclass,))
+        class Bar2:
+            __metaclass__ = MyMetaclass
+            @cached_function
+            def __classcall__(cls, R):
+                return type.__call__(cls, R)
+            def __init__(self,R):
+                self.R = R
+            def __repr__(self):
+                return "[%s]"%self.R
+            def __hash__(self):
+                print "computing the hash"
+                return int(12345)
+    The following was fixed in :trac:`9107` and :trac:`11791`::
+        sage: cython_code = [
+        ... "from sage.structure.unique_representation import UniqueRepresentation",
+        ... "class A1(UniqueRepresentation):",
+        ... "    class B1(UniqueRepresentation):",
+        ... "        class C1: pass",
+        ... "    class B2:",
+        ... "        class C2: pass"]
+        sage: import os
+        sage: cython(os.linesep.join(cython_code))
+        sage: from sage.misc.sageinspect import sage_getsource
+        sage: print sage_getsource(A1.B1)
+            class B1(UniqueRepresentation):
+                class C1: pass
     AUTHORS:
     - Nick Alexander
 …
     pos = _extract_embedded_position(d)
     if pos is not None:
         (_, filename, _) = pos
+        return filename
+        # Verify that it is the correct file. Move on to a temporary file,
+        # if it turns out that it can not be found in the sage library:
+        try:
+            source_lines = open(filename).readlines()
+            return filename
+        except IOError:
+            try:
+                from sage.all import SAGE_TMP
+                raw_name = filename.split(os.sep)[-1]
+                newname = os.path.join(SAGE_TMP,'spyx','_'.join(raw_name.split('_')[:-1]),raw_name)
+                source_lines = open(newname).readlines()
+                return newname
+            except IOError:
+                pass
     # The instance case
     if isclassinstance(obj):
 …
         return sage_getfile(obj.__class__) #inspect.getabsfile(obj.__class__)
     # No go? fall back to inspect.
+    return inspect.getabsfile(obj)
+    filename = inspect.getabsfile(obj)
+    filesplit = filename.split(os.extsep)
+    if filesplit[-1]=='so': # an extension, probably we'll find the file under the name ".pyx"
+        return os.extsep.join(filesplit[:-1])+os.extsep+'pyx'
+    elif filesplit[-1]=='pyc': # This occurs with interactive defs in IPython
+        return os.extsep.join(filesplit[:-1])+os.extsep+'py'
+    return filename
 def sage_getargspec(obj):
     r"""
 …
           ...
           '        return result_ring.ideal(result)\n'], ...)
+    The following has been enabled in trac ticket #11791::
+        sage: cython_code = [
+        ... 'from sage.structure.dynamic_class import dynamic_class',
+        ... 'from sage.all import cached_function',
+        ... 'from sage.misc.classcall_metaclass import ClasscallMetaclass',
+        ... 'MyMetaclass = dynamic_class("MyMetaclass",(ClasscallMetaclass,))',
+        ... 'class Bar2:',
+        ... '    __metaclass__ = MyMetaclass',
+        ... '    @cached_function',
+        ... '    def __classcall__(cls, R):',
+        ... '        return type.__call__(cls, R)',
+        ... '    def __init__(self,R):',
+        ... '        self.R = R',
+        ... '    def __repr__(self):',
+        ... '        return "[%s]"%self.R',
+        ... '    def __hash__(self):',
+        ... '        print "computing the hash"',
+        ... '        return int(12345)']
+        sage: cython('\n'.join(cython_code))
+        sage: print ''.join(sage_getsourcelines(Bar2)[0])
+        class Bar2:
+            __metaclass__ = MyMetaclass
+            @cached_function
+            def __classcall__(cls, R):
+                return type.__call__(cls, R)
+            def __init__(self,R):
+                self.R = R
+            def __repr__(self):
+                return "[%s]"%self.R
+            def __hash__(self):
+                print "computing the hash"
+                return int(12345)
     AUTHORS:
     - William Stein
 …
     - Simon King: Get source lines for dynamic classes.
     """
+    # If there is a custom _sage_src_lines_ that belongs to obj (and not to obj.__class__),
+    # then we use it
+    if getattr(obj,'_sage_src_lines_',None) is not getattr(type(obj),'_sage_src_lines_',None):
+        # Rationale:
+        # 1. If obj._sage_src_lines_ does not exist, then both are None.
+        # 2. If obj.__class__._sage_src_lines_ exists and is the same as obj._sage_src_lines_, then
+        #    obj._sage_src_lines_() would return the source of obj.__class__
+        # In both cases, obj._sage_src_lines_() would not give the result that we want.
+        try:
+            return obj._sage_src_lines_()
+        except TypeError:
+            # In some cases (e.g., QQ['x','y']), obj._sage_src_lines_() dispatches to a function
+            # that takes no arguments.
+            pass
+    try:
+        return obj._sage_src_lines_()
+    except AttributeError:
+        pass
+    except TypeError:
+        # That happes for instances of dynamic classes
+        return sage_getsourcelines(obj.__class__)
+    # Check if we deal with instance
+    # Check if we deal with instances - functools and "usual" instances.
     if isclassinstance(obj):
         if isinstance(obj,functools.partial):
             return sage_getsourcelines(obj.func)
         else:
-            #obj=obj.__class__
             return sage_getsourcelines(obj.__class__)
+    # If we can handle it, we do.  We first try Python's inspect, and
+    # if that fails then we try _sage_getdoc_unformatted. We can not use
+    # the latter right away, since otherwise there is an import problem
+    # at sage startup, believe it or not.
+    # If the above attempts fail then we test whether we face nested classes:
+    from sage.misc.nested_class import NestedClassMetaclass
+    if (isinstance(type(obj), NestedClassMetaclass) or issubclass(type(obj), NestedClassMetaclass) or not hasattr(obj,'__class__')): # and '.' in obj.__name__:
+        return _sage_getsourcelines_name_with_dot(obj)
+    # We try to find the position of the object's definition in its source file.
+    # First, we try with the information provided by inspect.getdoc.
     d = inspect.getdoc(obj)
     pos = _extract_embedded_position(d)
     if pos is None:
+        # If that fails, we try again, with _sage_getdoc_unformatted
         d = _sage_getdoc_unformatted(obj)
         pos = _extract_embedded_position(d)
         if pos is None:
+            # We try Python's inspect, as a last resort to get the source properly
             try:
                 return inspect.getsourcelines(obj)
+            except IOError:
+                if (not hasattr(obj, '__class__')) or hasattr(obj,'__metaclass__'):
+                    # That hapens for ParentMethods
+                    # of categories
+                    if '.' in obj.__name__:
+                        return _sage_getsourcelines_name_with_dot(obj)
+                if inspect.isclass(obj):
+                    try:
+                        B = obj.__base__
+                    except AttributeError:
+                        B = None
+                    if B is not None and B is not obj:
+                        return sage_getsourcelines(B)
+                if obj.__class__ != type:
+                    return sage_getsourcelines(obj.__class__)
+                raise
+            except (IOError, TypeError):
+                pass
+    (orig, filename, lineno) = pos
+            # Every attempt has failed. We thus resort
+            # to the base, if obj is a class, or to
+            # the object's class otherwise.
+            if isinstance(obj, type):
+                try:
+                    B = obj.__base__
+                except AttributeError:
+                    B = None
+                if B is not None and B is not obj:
+                    return sage_getsourcelines(B)
+            if obj.__class__ != type:
+                return sage_getsourcelines(obj.__class__)
+            raise
+    # We know the position, but it could be that the file is not in
+    # the sage library. sage_getfile knows how to cope with that case
+    (orig, _, lineno) = pos
     try:
         source_lines = open(filename).readlines()
+        source_lines = open(sage_getfile(obj)).readlines()
     except IOError:
+        try:
+            from sage.all import SAGE_TMP
+            raw_name = filename.split('/')[-1]
+            newname = SAGE_TMP+'/spyx/'+'_'.join(raw_name.split('_')[:-1])+'/'+raw_name
+            source_lines = open(newname).readlines()
+        except IOError:
+            return None
+        return None
     # It is possible that the source lines belong to the __init__ method,
     # rather than to the class. So, we try to look back and find the class

Download in other formats:

Original Format