No public description

PiperOrigin-RevId: 821837262

Author: devoid

google/colab/_inspector.py

@@ -23,6 +23,7 @@
 import math
 import re
 import types
+import warnings
 
 from IPython.core import oinspect
 from IPython.utils import dir2
@@ -475,6 +476,17 @@ def _getdef(self, obj, oname=''):
     except:  # pylint: disable=bare-except
       logging.exception('Exception raised in ColabInspector._getdef')
   def info(self, obj, oname='', formatter=None, info=None, detail_level=0):
+    """Compute a dict with detailed information about an object."""
+    if formatter is not None:
+      warnings.warn(
+          'The `formatter` keyword argument to `Inspector.info`'
+          'is deprecated as of IPython 5.0 and will have no effects.',
+          DeprecationWarning,
+          stacklevel=2,
+      )
+    return self._info(obj, oname=oname, info=info, detail_level=detail_level)
+
+  def _info(self, obj, oname='', info=None, detail_level=0):
     """Compute a dict with detailed information about an object.
 
     This overrides the superclass method for two main purposes:
@@ -484,7 +496,6 @@ def info(self, obj, oname='', formatter=None, info=None, detail_level=0):
     Args:
       obj: object to inspect.
       oname: (optional) string reference to this object
-      formatter: (optional) custom docstring formatter
       info: (optional) previously computed information about obj
       detail_level: (optional) 0 or 1; 1 means "include more detail"
 
@@ -572,8 +583,7 @@ def info(self, obj, oname='', formatter=None, info=None, detail_level=0):
       if source is not None:
         out['source'] = source
     if 'source' not in out:
-      formatter = formatter or (lambda x: x)
-      docstring = formatter(getdoc(obj) or '<no docstring>')
+      docstring = getdoc(obj) or '<no docstring>'
       if docstring:
         out['docstring'] = docstring
 
@@ -619,7 +629,7 @@ def info(self, obj, oname='', formatter=None, info=None, detail_level=0):
       if definition:
         out['definition'] = definition
 
-      if not oinspect.is_simple_callable(obj):
+        # if not oinspect.is_simple_callable(obj):
         call_docstring = getdoc(obj.__call__)
         if call_docstring and call_docstring != _BASE_CALL_DOC:
           out['call_docstring'] = call_docstring

google/colab/_kernel.py

@@ -12,6 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Colab-specific kernel customizations."""
+import logging
+
+logging.basicConfig(level=logging.DEBUG)
 
 from google.colab import _shell
 from google.colab import _shell_customizations
@@ -29,9 +32,25 @@ def _shell_class_default(self):
   def do_inspect(self, code, cursor_pos, detail_level=0, *args, **kwargs):
     name = tokenutil.token_at_cursor(code, cursor_pos)
     info = self.shell.object_inspect(name)
+    logging.warning('do_inspect: %s', name)
 
     data = {}
     if info['found']:
+      logging.warning('do_inspect found: %s', name)
+      info_text = self.shell.object_inspect_text(
+          name, detail_level=detail_level
+      )
+      # Only include info_text if less than 1 MiB. We have seen frontend lockup
+      # issues when this is very large. See b/401357469 for more details.
+      # 1 MiB is chosen as an arbitary starting point.
+      if len(info_text) < 2**20:
+        logging.warning('do_inspect adding text/plain: %s', info_text)
+        data['text/plain'] = info_text
+      else:
+        logging.warning(
+            'do_inspect text/plain is too large: %s', len(info_text)
+        )
+
       # Provide the structured inspection information to allow the frontend to
       # format as desired.
       argspec = info.get('argspec')
@@ -51,7 +70,7 @@ def do_inspect(self, code, cursor_pos, detail_level=0, *args, **kwargs):
         'metadata': {},
         'found': info['found'],
     }
-
+    logging.warning('do_inspect: data mimes: %s', ', '.join(data.keys()))
     return reply_content
 
   def complete_request(self, stream, ident, parent):

google/colab/_shell.py

@@ -14,6 +14,7 @@
 """Colab-specific shell customizations."""
 
 import datetime
+import logging
 import os
 import pathlib
 import sys
@@ -238,6 +239,44 @@ def _getattr_property(obj, attrname):
     # Nothing helped, fall back.
     return getattr(obj, attrname)
 
+  def object_inspect_text(self, oname, detail_level=0):
+    """Get object info as formatted text."""
+    info = self._ofind(oname)
+    if info['found']:
+      logging.warning('object_inspect_text: found')
+      try:
+        info = self._object_find(oname)
+        # We need to avoid arbitrary python objects remaining in info (and
+        # potentially being serialized below); `obj` itself needs to be
+        # removed, but retained for use below, and `parent` isn't used at all.
+        obj = info.pop('obj', '')
+        info.pop('parent', '')
+        # Follow the InteractiveShell base class implementation and call
+        # directly into the inspector's _get_info method.
+        # pylint: disable=protected-access
+        logging.warning(
+            'object_inspect_text: calling inspector._get_info on: %s', obj
+        )
+        result = self.inspector._get_info(
+            obj,
+            oname,
+            info=info,
+            detail_level=detail_level,
+        )
+        logging.warning('object_inspect_text: result: %s', result)
+      except Exception as e:  # pylint: disable=broad-except
+        self.kernel.log.info(
+            'Exception caught during object text inspection: '
+            '{!r}\nTraceback:\n{}'.format(
+                e, ''.join(traceback.format_tb(sys.exc_info()[2]))
+            )
+        )
+        return ''
+    else:
+      return ''
+    logging.warning('object_inspect_text result: %s', result)
+    return result['text/plain']
+
   def object_inspect(self, oname, detail_level=0):
     info = self._ofind(oname)
 
@@ -259,7 +298,7 @@ def object_inspect(self, oname, detail_level=0):
                 e, ''.join(traceback.format_tb(sys.exc_info()[2]))
             )
         )
-        result = oinspect.InfoDict()
+        result = oinspect.object_info()
     else:
       result = super(Shell, self).object_inspect(
           oname, detail_level=detail_level