##// END OF EJS Templates
add list of subclasses when using pinfo - etc
Chris Mentzel -
Show More
@@ -1,1014 +1,1018 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Tools for inspecting Python objects.
2 """Tools for inspecting Python objects.
3
3
4 Uses syntax highlighting for presenting the various information elements.
4 Uses syntax highlighting for presenting the various information elements.
5
5
6 Similar in spirit to the inspect module, but all calls take a name argument to
6 Similar in spirit to the inspect module, but all calls take a name argument to
7 reference the name under which an object is being read.
7 reference the name under which an object is being read.
8 """
8 """
9
9
10 # Copyright (c) IPython Development Team.
10 # Copyright (c) IPython Development Team.
11 # Distributed under the terms of the Modified BSD License.
11 # Distributed under the terms of the Modified BSD License.
12
12
13 __all__ = ['Inspector','InspectColors']
13 __all__ = ['Inspector','InspectColors']
14
14
15 # stdlib modules
15 # stdlib modules
16 import ast
16 import ast
17 import inspect
17 import inspect
18 from inspect import signature
18 from inspect import signature
19 import linecache
19 import linecache
20 import warnings
20 import warnings
21 import os
21 import os
22 from textwrap import dedent
22 from textwrap import dedent
23 import types
23 import types
24 import io as stdlib_io
24 import io as stdlib_io
25 from itertools import zip_longest
25 from itertools import zip_longest
26
26
27 # IPython's own
27 # IPython's own
28 from IPython.core import page
28 from IPython.core import page
29 from IPython.lib.pretty import pretty
29 from IPython.lib.pretty import pretty
30 from IPython.testing.skipdoctest import skip_doctest
30 from IPython.testing.skipdoctest import skip_doctest
31 from IPython.utils import PyColorize
31 from IPython.utils import PyColorize
32 from IPython.utils import openpy
32 from IPython.utils import openpy
33 from IPython.utils import py3compat
33 from IPython.utils import py3compat
34 from IPython.utils.dir2 import safe_hasattr
34 from IPython.utils.dir2 import safe_hasattr
35 from IPython.utils.path import compress_user
35 from IPython.utils.path import compress_user
36 from IPython.utils.text import indent
36 from IPython.utils.text import indent
37 from IPython.utils.wildcard import list_namespace
37 from IPython.utils.wildcard import list_namespace
38 from IPython.utils.coloransi import TermColors, ColorScheme, ColorSchemeTable
38 from IPython.utils.coloransi import TermColors, ColorScheme, ColorSchemeTable
39 from IPython.utils.py3compat import cast_unicode
39 from IPython.utils.py3compat import cast_unicode
40 from IPython.utils.colorable import Colorable
40 from IPython.utils.colorable import Colorable
41 from IPython.utils.decorators import undoc
41 from IPython.utils.decorators import undoc
42
42
43 from pygments import highlight
43 from pygments import highlight
44 from pygments.lexers import PythonLexer
44 from pygments.lexers import PythonLexer
45 from pygments.formatters import HtmlFormatter
45 from pygments.formatters import HtmlFormatter
46
46
47 def pylight(code):
47 def pylight(code):
48 return highlight(code, PythonLexer(), HtmlFormatter(noclasses=True))
48 return highlight(code, PythonLexer(), HtmlFormatter(noclasses=True))
49
49
50 # builtin docstrings to ignore
50 # builtin docstrings to ignore
51 _func_call_docstring = types.FunctionType.__call__.__doc__
51 _func_call_docstring = types.FunctionType.__call__.__doc__
52 _object_init_docstring = object.__init__.__doc__
52 _object_init_docstring = object.__init__.__doc__
53 _builtin_type_docstrings = {
53 _builtin_type_docstrings = {
54 inspect.getdoc(t) for t in (types.ModuleType, types.MethodType,
54 inspect.getdoc(t) for t in (types.ModuleType, types.MethodType,
55 types.FunctionType, property)
55 types.FunctionType, property)
56 }
56 }
57
57
58 _builtin_func_type = type(all)
58 _builtin_func_type = type(all)
59 _builtin_meth_type = type(str.upper) # Bound methods have the same type as builtin functions
59 _builtin_meth_type = type(str.upper) # Bound methods have the same type as builtin functions
60 #****************************************************************************
60 #****************************************************************************
61 # Builtin color schemes
61 # Builtin color schemes
62
62
63 Colors = TermColors # just a shorthand
63 Colors = TermColors # just a shorthand
64
64
65 InspectColors = PyColorize.ANSICodeColors
65 InspectColors = PyColorize.ANSICodeColors
66
66
67 #****************************************************************************
67 #****************************************************************************
68 # Auxiliary functions and objects
68 # Auxiliary functions and objects
69
69
70 # See the messaging spec for the definition of all these fields. This list
70 # See the messaging spec for the definition of all these fields. This list
71 # effectively defines the order of display
71 # effectively defines the order of display
72 info_fields = ['type_name', 'base_class', 'string_form', 'namespace',
72 info_fields = ['type_name', 'base_class', 'string_form', 'namespace',
73 'length', 'file', 'definition', 'docstring', 'source',
73 'length', 'file', 'definition', 'docstring', 'source',
74 'init_definition', 'class_docstring', 'init_docstring',
74 'init_definition', 'class_docstring', 'init_docstring',
75 'call_def', 'call_docstring',
75 'call_def', 'call_docstring',
76 # These won't be printed but will be used to determine how to
76 # These won't be printed but will be used to determine how to
77 # format the object
77 # format the object
78 'ismagic', 'isalias', 'isclass', 'argspec', 'found', 'name'
78 'ismagic', 'isalias', 'isclass', 'argspec', 'found', 'name'
79 ]
79 ]
80
80
81
81
82 def object_info(**kw):
82 def object_info(**kw):
83 """Make an object info dict with all fields present."""
83 """Make an object info dict with all fields present."""
84 infodict = dict(zip_longest(info_fields, [None]))
84 infodict = dict(zip_longest(info_fields, [None]))
85 infodict.update(kw)
85 infodict.update(kw)
86 return infodict
86 return infodict
87
87
88
88
89 def get_encoding(obj):
89 def get_encoding(obj):
90 """Get encoding for python source file defining obj
90 """Get encoding for python source file defining obj
91
91
92 Returns None if obj is not defined in a sourcefile.
92 Returns None if obj is not defined in a sourcefile.
93 """
93 """
94 ofile = find_file(obj)
94 ofile = find_file(obj)
95 # run contents of file through pager starting at line where the object
95 # run contents of file through pager starting at line where the object
96 # is defined, as long as the file isn't binary and is actually on the
96 # is defined, as long as the file isn't binary and is actually on the
97 # filesystem.
97 # filesystem.
98 if ofile is None:
98 if ofile is None:
99 return None
99 return None
100 elif ofile.endswith(('.so', '.dll', '.pyd')):
100 elif ofile.endswith(('.so', '.dll', '.pyd')):
101 return None
101 return None
102 elif not os.path.isfile(ofile):
102 elif not os.path.isfile(ofile):
103 return None
103 return None
104 else:
104 else:
105 # Print only text files, not extension binaries. Note that
105 # Print only text files, not extension binaries. Note that
106 # getsourcelines returns lineno with 1-offset and page() uses
106 # getsourcelines returns lineno with 1-offset and page() uses
107 # 0-offset, so we must adjust.
107 # 0-offset, so we must adjust.
108 with stdlib_io.open(ofile, 'rb') as buffer: # Tweaked to use io.open for Python 2
108 with stdlib_io.open(ofile, 'rb') as buffer: # Tweaked to use io.open for Python 2
109 encoding, lines = openpy.detect_encoding(buffer.readline)
109 encoding, lines = openpy.detect_encoding(buffer.readline)
110 return encoding
110 return encoding
111
111
112 def getdoc(obj):
112 def getdoc(obj):
113 """Stable wrapper around inspect.getdoc.
113 """Stable wrapper around inspect.getdoc.
114
114
115 This can't crash because of attribute problems.
115 This can't crash because of attribute problems.
116
116
117 It also attempts to call a getdoc() method on the given object. This
117 It also attempts to call a getdoc() method on the given object. This
118 allows objects which provide their docstrings via non-standard mechanisms
118 allows objects which provide their docstrings via non-standard mechanisms
119 (like Pyro proxies) to still be inspected by ipython's ? system.
119 (like Pyro proxies) to still be inspected by ipython's ? system.
120 """
120 """
121 # Allow objects to offer customized documentation via a getdoc method:
121 # Allow objects to offer customized documentation via a getdoc method:
122 try:
122 try:
123 ds = obj.getdoc()
123 ds = obj.getdoc()
124 except Exception:
124 except Exception:
125 pass
125 pass
126 else:
126 else:
127 if isinstance(ds, str):
127 if isinstance(ds, str):
128 return inspect.cleandoc(ds)
128 return inspect.cleandoc(ds)
129 docstr = inspect.getdoc(obj)
129 docstr = inspect.getdoc(obj)
130 encoding = get_encoding(obj)
130 encoding = get_encoding(obj)
131 return py3compat.cast_unicode(docstr, encoding=encoding)
131 return py3compat.cast_unicode(docstr, encoding=encoding)
132
132
133
133
134 def getsource(obj, oname=''):
134 def getsource(obj, oname=''):
135 """Wrapper around inspect.getsource.
135 """Wrapper around inspect.getsource.
136
136
137 This can be modified by other projects to provide customized source
137 This can be modified by other projects to provide customized source
138 extraction.
138 extraction.
139
139
140 Parameters
140 Parameters
141 ----------
141 ----------
142 obj : object
142 obj : object
143 an object whose source code we will attempt to extract
143 an object whose source code we will attempt to extract
144 oname : str
144 oname : str
145 (optional) a name under which the object is known
145 (optional) a name under which the object is known
146
146
147 Returns
147 Returns
148 -------
148 -------
149 src : unicode or None
149 src : unicode or None
150
150
151 """
151 """
152
152
153 if isinstance(obj, property):
153 if isinstance(obj, property):
154 sources = []
154 sources = []
155 for attrname in ['fget', 'fset', 'fdel']:
155 for attrname in ['fget', 'fset', 'fdel']:
156 fn = getattr(obj, attrname)
156 fn = getattr(obj, attrname)
157 if fn is not None:
157 if fn is not None:
158 encoding = get_encoding(fn)
158 encoding = get_encoding(fn)
159 oname_prefix = ('%s.' % oname) if oname else ''
159 oname_prefix = ('%s.' % oname) if oname else ''
160 sources.append(cast_unicode(
160 sources.append(cast_unicode(
161 ''.join(('# ', oname_prefix, attrname)),
161 ''.join(('# ', oname_prefix, attrname)),
162 encoding=encoding))
162 encoding=encoding))
163 if inspect.isfunction(fn):
163 if inspect.isfunction(fn):
164 sources.append(dedent(getsource(fn)))
164 sources.append(dedent(getsource(fn)))
165 else:
165 else:
166 # Default str/repr only prints function name,
166 # Default str/repr only prints function name,
167 # pretty.pretty prints module name too.
167 # pretty.pretty prints module name too.
168 sources.append(cast_unicode(
168 sources.append(cast_unicode(
169 '%s%s = %s\n' % (
169 '%s%s = %s\n' % (
170 oname_prefix, attrname, pretty(fn)),
170 oname_prefix, attrname, pretty(fn)),
171 encoding=encoding))
171 encoding=encoding))
172 if sources:
172 if sources:
173 return '\n'.join(sources)
173 return '\n'.join(sources)
174 else:
174 else:
175 return None
175 return None
176
176
177 else:
177 else:
178 # Get source for non-property objects.
178 # Get source for non-property objects.
179
179
180 obj = _get_wrapped(obj)
180 obj = _get_wrapped(obj)
181
181
182 try:
182 try:
183 src = inspect.getsource(obj)
183 src = inspect.getsource(obj)
184 except TypeError:
184 except TypeError:
185 # The object itself provided no meaningful source, try looking for
185 # The object itself provided no meaningful source, try looking for
186 # its class definition instead.
186 # its class definition instead.
187 if hasattr(obj, '__class__'):
187 if hasattr(obj, '__class__'):
188 try:
188 try:
189 src = inspect.getsource(obj.__class__)
189 src = inspect.getsource(obj.__class__)
190 except TypeError:
190 except TypeError:
191 return None
191 return None
192
192
193 encoding = get_encoding(obj)
193 encoding = get_encoding(obj)
194 return cast_unicode(src, encoding=encoding)
194 return cast_unicode(src, encoding=encoding)
195
195
196
196
197 def is_simple_callable(obj):
197 def is_simple_callable(obj):
198 """True if obj is a function ()"""
198 """True if obj is a function ()"""
199 return (inspect.isfunction(obj) or inspect.ismethod(obj) or \
199 return (inspect.isfunction(obj) or inspect.ismethod(obj) or \
200 isinstance(obj, _builtin_func_type) or isinstance(obj, _builtin_meth_type))
200 isinstance(obj, _builtin_func_type) or isinstance(obj, _builtin_meth_type))
201
201
202
202
203 def getargspec(obj):
203 def getargspec(obj):
204 """Wrapper around :func:`inspect.getfullargspec` on Python 3, and
204 """Wrapper around :func:`inspect.getfullargspec` on Python 3, and
205 :func:inspect.getargspec` on Python 2.
205 :func:inspect.getargspec` on Python 2.
206
206
207 In addition to functions and methods, this can also handle objects with a
207 In addition to functions and methods, this can also handle objects with a
208 ``__call__`` attribute.
208 ``__call__`` attribute.
209 """
209 """
210 if safe_hasattr(obj, '__call__') and not is_simple_callable(obj):
210 if safe_hasattr(obj, '__call__') and not is_simple_callable(obj):
211 obj = obj.__call__
211 obj = obj.__call__
212
212
213 return inspect.getfullargspec(obj)
213 return inspect.getfullargspec(obj)
214
214
215
215
216 def format_argspec(argspec):
216 def format_argspec(argspec):
217 """Format argspect, convenience wrapper around inspect's.
217 """Format argspect, convenience wrapper around inspect's.
218
218
219 This takes a dict instead of ordered arguments and calls
219 This takes a dict instead of ordered arguments and calls
220 inspect.format_argspec with the arguments in the necessary order.
220 inspect.format_argspec with the arguments in the necessary order.
221 """
221 """
222 return inspect.formatargspec(argspec['args'], argspec['varargs'],
222 return inspect.formatargspec(argspec['args'], argspec['varargs'],
223 argspec['varkw'], argspec['defaults'])
223 argspec['varkw'], argspec['defaults'])
224
224
225 @undoc
225 @undoc
226 def call_tip(oinfo, format_call=True):
226 def call_tip(oinfo, format_call=True):
227 """DEPRECATED. Extract call tip data from an oinfo dict.
227 """DEPRECATED. Extract call tip data from an oinfo dict.
228 """
228 """
229 warnings.warn('`call_tip` function is deprecated as of IPython 6.0'
229 warnings.warn('`call_tip` function is deprecated as of IPython 6.0'
230 'and will be removed in future versions.', DeprecationWarning, stacklevel=2)
230 'and will be removed in future versions.', DeprecationWarning, stacklevel=2)
231 # Get call definition
231 # Get call definition
232 argspec = oinfo.get('argspec')
232 argspec = oinfo.get('argspec')
233 if argspec is None:
233 if argspec is None:
234 call_line = None
234 call_line = None
235 else:
235 else:
236 # Callable objects will have 'self' as their first argument, prune
236 # Callable objects will have 'self' as their first argument, prune
237 # it out if it's there for clarity (since users do *not* pass an
237 # it out if it's there for clarity (since users do *not* pass an
238 # extra first argument explicitly).
238 # extra first argument explicitly).
239 try:
239 try:
240 has_self = argspec['args'][0] == 'self'
240 has_self = argspec['args'][0] == 'self'
241 except (KeyError, IndexError):
241 except (KeyError, IndexError):
242 pass
242 pass
243 else:
243 else:
244 if has_self:
244 if has_self:
245 argspec['args'] = argspec['args'][1:]
245 argspec['args'] = argspec['args'][1:]
246
246
247 call_line = oinfo['name']+format_argspec(argspec)
247 call_line = oinfo['name']+format_argspec(argspec)
248
248
249 # Now get docstring.
249 # Now get docstring.
250 # The priority is: call docstring, constructor docstring, main one.
250 # The priority is: call docstring, constructor docstring, main one.
251 doc = oinfo.get('call_docstring')
251 doc = oinfo.get('call_docstring')
252 if doc is None:
252 if doc is None:
253 doc = oinfo.get('init_docstring')
253 doc = oinfo.get('init_docstring')
254 if doc is None:
254 if doc is None:
255 doc = oinfo.get('docstring','')
255 doc = oinfo.get('docstring','')
256
256
257 return call_line, doc
257 return call_line, doc
258
258
259
259
260 def _get_wrapped(obj):
260 def _get_wrapped(obj):
261 """Get the original object if wrapped in one or more @decorators
261 """Get the original object if wrapped in one or more @decorators
262
262
263 Some objects automatically construct similar objects on any unrecognised
263 Some objects automatically construct similar objects on any unrecognised
264 attribute access (e.g. unittest.mock.call). To protect against infinite loops,
264 attribute access (e.g. unittest.mock.call). To protect against infinite loops,
265 this will arbitrarily cut off after 100 levels of obj.__wrapped__
265 this will arbitrarily cut off after 100 levels of obj.__wrapped__
266 attribute access. --TK, Jan 2016
266 attribute access. --TK, Jan 2016
267 """
267 """
268 orig_obj = obj
268 orig_obj = obj
269 i = 0
269 i = 0
270 while safe_hasattr(obj, '__wrapped__'):
270 while safe_hasattr(obj, '__wrapped__'):
271 obj = obj.__wrapped__
271 obj = obj.__wrapped__
272 i += 1
272 i += 1
273 if i > 100:
273 if i > 100:
274 # __wrapped__ is probably a lie, so return the thing we started with
274 # __wrapped__ is probably a lie, so return the thing we started with
275 return orig_obj
275 return orig_obj
276 return obj
276 return obj
277
277
278 def find_file(obj):
278 def find_file(obj):
279 """Find the absolute path to the file where an object was defined.
279 """Find the absolute path to the file where an object was defined.
280
280
281 This is essentially a robust wrapper around `inspect.getabsfile`.
281 This is essentially a robust wrapper around `inspect.getabsfile`.
282
282
283 Returns None if no file can be found.
283 Returns None if no file can be found.
284
284
285 Parameters
285 Parameters
286 ----------
286 ----------
287 obj : any Python object
287 obj : any Python object
288
288
289 Returns
289 Returns
290 -------
290 -------
291 fname : str
291 fname : str
292 The absolute path to the file where the object was defined.
292 The absolute path to the file where the object was defined.
293 """
293 """
294 obj = _get_wrapped(obj)
294 obj = _get_wrapped(obj)
295
295
296 fname = None
296 fname = None
297 try:
297 try:
298 fname = inspect.getabsfile(obj)
298 fname = inspect.getabsfile(obj)
299 except TypeError:
299 except TypeError:
300 # For an instance, the file that matters is where its class was
300 # For an instance, the file that matters is where its class was
301 # declared.
301 # declared.
302 if hasattr(obj, '__class__'):
302 if hasattr(obj, '__class__'):
303 try:
303 try:
304 fname = inspect.getabsfile(obj.__class__)
304 fname = inspect.getabsfile(obj.__class__)
305 except TypeError:
305 except TypeError:
306 # Can happen for builtins
306 # Can happen for builtins
307 pass
307 pass
308 except:
308 except:
309 pass
309 pass
310 return cast_unicode(fname)
310 return cast_unicode(fname)
311
311
312
312
313 def find_source_lines(obj):
313 def find_source_lines(obj):
314 """Find the line number in a file where an object was defined.
314 """Find the line number in a file where an object was defined.
315
315
316 This is essentially a robust wrapper around `inspect.getsourcelines`.
316 This is essentially a robust wrapper around `inspect.getsourcelines`.
317
317
318 Returns None if no file can be found.
318 Returns None if no file can be found.
319
319
320 Parameters
320 Parameters
321 ----------
321 ----------
322 obj : any Python object
322 obj : any Python object
323
323
324 Returns
324 Returns
325 -------
325 -------
326 lineno : int
326 lineno : int
327 The line number where the object definition starts.
327 The line number where the object definition starts.
328 """
328 """
329 obj = _get_wrapped(obj)
329 obj = _get_wrapped(obj)
330
330
331 try:
331 try:
332 try:
332 try:
333 lineno = inspect.getsourcelines(obj)[1]
333 lineno = inspect.getsourcelines(obj)[1]
334 except TypeError:
334 except TypeError:
335 # For instances, try the class object like getsource() does
335 # For instances, try the class object like getsource() does
336 if hasattr(obj, '__class__'):
336 if hasattr(obj, '__class__'):
337 lineno = inspect.getsourcelines(obj.__class__)[1]
337 lineno = inspect.getsourcelines(obj.__class__)[1]
338 else:
338 else:
339 lineno = None
339 lineno = None
340 except:
340 except:
341 return None
341 return None
342
342
343 return lineno
343 return lineno
344
344
345 class Inspector(Colorable):
345 class Inspector(Colorable):
346
346
347 def __init__(self, color_table=InspectColors,
347 def __init__(self, color_table=InspectColors,
348 code_color_table=PyColorize.ANSICodeColors,
348 code_color_table=PyColorize.ANSICodeColors,
349 scheme=None,
349 scheme=None,
350 str_detail_level=0,
350 str_detail_level=0,
351 parent=None, config=None):
351 parent=None, config=None):
352 super(Inspector, self).__init__(parent=parent, config=config)
352 super(Inspector, self).__init__(parent=parent, config=config)
353 self.color_table = color_table
353 self.color_table = color_table
354 self.parser = PyColorize.Parser(out='str', parent=self, style=scheme)
354 self.parser = PyColorize.Parser(out='str', parent=self, style=scheme)
355 self.format = self.parser.format
355 self.format = self.parser.format
356 self.str_detail_level = str_detail_level
356 self.str_detail_level = str_detail_level
357 self.set_active_scheme(scheme)
357 self.set_active_scheme(scheme)
358
358
359 def _getdef(self,obj,oname=''):
359 def _getdef(self,obj,oname=''):
360 """Return the call signature for any callable object.
360 """Return the call signature for any callable object.
361
361
362 If any exception is generated, None is returned instead and the
362 If any exception is generated, None is returned instead and the
363 exception is suppressed."""
363 exception is suppressed."""
364 try:
364 try:
365 hdef = oname + str(signature(obj))
365 hdef = oname + str(signature(obj))
366 return cast_unicode(hdef)
366 return cast_unicode(hdef)
367 except:
367 except:
368 return None
368 return None
369
369
370 def __head(self,h):
370 def __head(self,h):
371 """Return a header string with proper colors."""
371 """Return a header string with proper colors."""
372 return '%s%s%s' % (self.color_table.active_colors.header,h,
372 return '%s%s%s' % (self.color_table.active_colors.header,h,
373 self.color_table.active_colors.normal)
373 self.color_table.active_colors.normal)
374
374
375 def set_active_scheme(self, scheme):
375 def set_active_scheme(self, scheme):
376 if scheme is not None:
376 if scheme is not None:
377 self.color_table.set_active_scheme(scheme)
377 self.color_table.set_active_scheme(scheme)
378 self.parser.color_table.set_active_scheme(scheme)
378 self.parser.color_table.set_active_scheme(scheme)
379
379
380 def noinfo(self, msg, oname):
380 def noinfo(self, msg, oname):
381 """Generic message when no information is found."""
381 """Generic message when no information is found."""
382 print('No %s found' % msg, end=' ')
382 print('No %s found' % msg, end=' ')
383 if oname:
383 if oname:
384 print('for %s' % oname)
384 print('for %s' % oname)
385 else:
385 else:
386 print()
386 print()
387
387
388 def pdef(self, obj, oname=''):
388 def pdef(self, obj, oname=''):
389 """Print the call signature for any callable object.
389 """Print the call signature for any callable object.
390
390
391 If the object is a class, print the constructor information."""
391 If the object is a class, print the constructor information."""
392
392
393 if not callable(obj):
393 if not callable(obj):
394 print('Object is not callable.')
394 print('Object is not callable.')
395 return
395 return
396
396
397 header = ''
397 header = ''
398
398
399 if inspect.isclass(obj):
399 if inspect.isclass(obj):
400 header = self.__head('Class constructor information:\n')
400 header = self.__head('Class constructor information:\n')
401
401
402
402
403 output = self._getdef(obj,oname)
403 output = self._getdef(obj,oname)
404 if output is None:
404 if output is None:
405 self.noinfo('definition header',oname)
405 self.noinfo('definition header',oname)
406 else:
406 else:
407 print(header,self.format(output), end=' ')
407 print(header,self.format(output), end=' ')
408
408
409 # In Python 3, all classes are new-style, so they all have __init__.
409 # In Python 3, all classes are new-style, so they all have __init__.
410 @skip_doctest
410 @skip_doctest
411 def pdoc(self, obj, oname='', formatter=None):
411 def pdoc(self, obj, oname='', formatter=None):
412 """Print the docstring for any object.
412 """Print the docstring for any object.
413
413
414 Optional:
414 Optional:
415 -formatter: a function to run the docstring through for specially
415 -formatter: a function to run the docstring through for specially
416 formatted docstrings.
416 formatted docstrings.
417
417
418 Examples
418 Examples
419 --------
419 --------
420
420
421 In [1]: class NoInit:
421 In [1]: class NoInit:
422 ...: pass
422 ...: pass
423
423
424 In [2]: class NoDoc:
424 In [2]: class NoDoc:
425 ...: def __init__(self):
425 ...: def __init__(self):
426 ...: pass
426 ...: pass
427
427
428 In [3]: %pdoc NoDoc
428 In [3]: %pdoc NoDoc
429 No documentation found for NoDoc
429 No documentation found for NoDoc
430
430
431 In [4]: %pdoc NoInit
431 In [4]: %pdoc NoInit
432 No documentation found for NoInit
432 No documentation found for NoInit
433
433
434 In [5]: obj = NoInit()
434 In [5]: obj = NoInit()
435
435
436 In [6]: %pdoc obj
436 In [6]: %pdoc obj
437 No documentation found for obj
437 No documentation found for obj
438
438
439 In [5]: obj2 = NoDoc()
439 In [5]: obj2 = NoDoc()
440
440
441 In [6]: %pdoc obj2
441 In [6]: %pdoc obj2
442 No documentation found for obj2
442 No documentation found for obj2
443 """
443 """
444
444
445 head = self.__head # For convenience
445 head = self.__head # For convenience
446 lines = []
446 lines = []
447 ds = getdoc(obj)
447 ds = getdoc(obj)
448 if formatter:
448 if formatter:
449 ds = formatter(ds).get('plain/text', ds)
449 ds = formatter(ds).get('plain/text', ds)
450 if ds:
450 if ds:
451 lines.append(head("Class docstring:"))
451 lines.append(head("Class docstring:"))
452 lines.append(indent(ds))
452 lines.append(indent(ds))
453 if inspect.isclass(obj) and hasattr(obj, '__init__'):
453 if inspect.isclass(obj) and hasattr(obj, '__init__'):
454 init_ds = getdoc(obj.__init__)
454 init_ds = getdoc(obj.__init__)
455 if init_ds is not None:
455 if init_ds is not None:
456 lines.append(head("Init docstring:"))
456 lines.append(head("Init docstring:"))
457 lines.append(indent(init_ds))
457 lines.append(indent(init_ds))
458 elif hasattr(obj,'__call__'):
458 elif hasattr(obj,'__call__'):
459 call_ds = getdoc(obj.__call__)
459 call_ds = getdoc(obj.__call__)
460 if call_ds:
460 if call_ds:
461 lines.append(head("Call docstring:"))
461 lines.append(head("Call docstring:"))
462 lines.append(indent(call_ds))
462 lines.append(indent(call_ds))
463
463
464 if not lines:
464 if not lines:
465 self.noinfo('documentation',oname)
465 self.noinfo('documentation',oname)
466 else:
466 else:
467 page.page('\n'.join(lines))
467 page.page('\n'.join(lines))
468
468
469 def psource(self, obj, oname=''):
469 def psource(self, obj, oname=''):
470 """Print the source code for an object."""
470 """Print the source code for an object."""
471
471
472 # Flush the source cache because inspect can return out-of-date source
472 # Flush the source cache because inspect can return out-of-date source
473 linecache.checkcache()
473 linecache.checkcache()
474 try:
474 try:
475 src = getsource(obj, oname=oname)
475 src = getsource(obj, oname=oname)
476 except Exception:
476 except Exception:
477 src = None
477 src = None
478
478
479 if src is None:
479 if src is None:
480 self.noinfo('source', oname)
480 self.noinfo('source', oname)
481 else:
481 else:
482 page.page(self.format(src))
482 page.page(self.format(src))
483
483
484 def pfile(self, obj, oname=''):
484 def pfile(self, obj, oname=''):
485 """Show the whole file where an object was defined."""
485 """Show the whole file where an object was defined."""
486
486
487 lineno = find_source_lines(obj)
487 lineno = find_source_lines(obj)
488 if lineno is None:
488 if lineno is None:
489 self.noinfo('file', oname)
489 self.noinfo('file', oname)
490 return
490 return
491
491
492 ofile = find_file(obj)
492 ofile = find_file(obj)
493 # run contents of file through pager starting at line where the object
493 # run contents of file through pager starting at line where the object
494 # is defined, as long as the file isn't binary and is actually on the
494 # is defined, as long as the file isn't binary and is actually on the
495 # filesystem.
495 # filesystem.
496 if ofile.endswith(('.so', '.dll', '.pyd')):
496 if ofile.endswith(('.so', '.dll', '.pyd')):
497 print('File %r is binary, not printing.' % ofile)
497 print('File %r is binary, not printing.' % ofile)
498 elif not os.path.isfile(ofile):
498 elif not os.path.isfile(ofile):
499 print('File %r does not exist, not printing.' % ofile)
499 print('File %r does not exist, not printing.' % ofile)
500 else:
500 else:
501 # Print only text files, not extension binaries. Note that
501 # Print only text files, not extension binaries. Note that
502 # getsourcelines returns lineno with 1-offset and page() uses
502 # getsourcelines returns lineno with 1-offset and page() uses
503 # 0-offset, so we must adjust.
503 # 0-offset, so we must adjust.
504 page.page(self.format(openpy.read_py_file(ofile, skip_encoding_cookie=False)), lineno - 1)
504 page.page(self.format(openpy.read_py_file(ofile, skip_encoding_cookie=False)), lineno - 1)
505
505
506 def _format_fields(self, fields, title_width=0):
506 def _format_fields(self, fields, title_width=0):
507 """Formats a list of fields for display.
507 """Formats a list of fields for display.
508
508
509 Parameters
509 Parameters
510 ----------
510 ----------
511 fields : list
511 fields : list
512 A list of 2-tuples: (field_title, field_content)
512 A list of 2-tuples: (field_title, field_content)
513 title_width : int
513 title_width : int
514 How many characters to pad titles to. Default to longest title.
514 How many characters to pad titles to. Default to longest title.
515 """
515 """
516 out = []
516 out = []
517 header = self.__head
517 header = self.__head
518 if title_width == 0:
518 if title_width == 0:
519 title_width = max(len(title) + 2 for title, _ in fields)
519 title_width = max(len(title) + 2 for title, _ in fields)
520 for title, content in fields:
520 for title, content in fields:
521 if len(content.splitlines()) > 1:
521 if len(content.splitlines()) > 1:
522 title = header(title + ':') + '\n'
522 title = header(title + ':') + '\n'
523 else:
523 else:
524 title = header((title + ':').ljust(title_width))
524 title = header((title + ':').ljust(title_width))
525 out.append(cast_unicode(title) + cast_unicode(content))
525 out.append(cast_unicode(title) + cast_unicode(content))
526 return "\n".join(out)
526 return "\n".join(out)
527
527
528 def _mime_format(self, text, formatter=None):
528 def _mime_format(self, text, formatter=None):
529 """Return a mime bundle representation of the input text.
529 """Return a mime bundle representation of the input text.
530
530
531 - if `formatter` is None, the returned mime bundle has
531 - if `formatter` is None, the returned mime bundle has
532 a `text/plain` field, with the input text.
532 a `text/plain` field, with the input text.
533 a `text/html` field with a `<pre>` tag containing the input text.
533 a `text/html` field with a `<pre>` tag containing the input text.
534
534
535 - if `formatter` is not None, it must be a callable transforming the
535 - if `formatter` is not None, it must be a callable transforming the
536 input text into a mime bundle. Default values for `text/plain` and
536 input text into a mime bundle. Default values for `text/plain` and
537 `text/html` representations are the ones described above.
537 `text/html` representations are the ones described above.
538
538
539 Note:
539 Note:
540
540
541 Formatters returning strings are supported but this behavior is deprecated.
541 Formatters returning strings are supported but this behavior is deprecated.
542
542
543 """
543 """
544 text = cast_unicode(text)
544 text = cast_unicode(text)
545 defaults = {
545 defaults = {
546 'text/plain': text,
546 'text/plain': text,
547 'text/html': '<pre>' + text + '</pre>'
547 'text/html': '<pre>' + text + '</pre>'
548 }
548 }
549
549
550 if formatter is None:
550 if formatter is None:
551 return defaults
551 return defaults
552 else:
552 else:
553 formatted = formatter(text)
553 formatted = formatter(text)
554
554
555 if not isinstance(formatted, dict):
555 if not isinstance(formatted, dict):
556 # Handle the deprecated behavior of a formatter returning
556 # Handle the deprecated behavior of a formatter returning
557 # a string instead of a mime bundle.
557 # a string instead of a mime bundle.
558 return {
558 return {
559 'text/plain': formatted,
559 'text/plain': formatted,
560 'text/html': '<pre>' + formatted + '</pre>'
560 'text/html': '<pre>' + formatted + '</pre>'
561 }
561 }
562
562
563 else:
563 else:
564 return dict(defaults, **formatted)
564 return dict(defaults, **formatted)
565
565
566
566
567 def format_mime(self, bundle):
567 def format_mime(self, bundle):
568
568
569 text_plain = bundle['text/plain']
569 text_plain = bundle['text/plain']
570
570
571 text = ''
571 text = ''
572 heads, bodies = list(zip(*text_plain))
572 heads, bodies = list(zip(*text_plain))
573 _len = max(len(h) for h in heads)
573 _len = max(len(h) for h in heads)
574
574
575 for head, body in zip(heads, bodies):
575 for head, body in zip(heads, bodies):
576 body = body.strip('\n')
576 body = body.strip('\n')
577 delim = '\n' if '\n' in body else ' '
577 delim = '\n' if '\n' in body else ' '
578 text += self.__head(head+':') + (_len - len(head))*' ' +delim + body +'\n'
578 text += self.__head(head+':') + (_len - len(head))*' ' +delim + body +'\n'
579
579
580 bundle['text/plain'] = text
580 bundle['text/plain'] = text
581 return bundle
581 return bundle
582
582
583 def _get_info(self, obj, oname='', formatter=None, info=None, detail_level=0):
583 def _get_info(self, obj, oname='', formatter=None, info=None, detail_level=0):
584 """Retrieve an info dict and format it.
584 """Retrieve an info dict and format it.
585
585
586 Parameters
586 Parameters
587 ==========
587 ==========
588
588
589 obj: any
589 obj: any
590 Object to inspect and return info from
590 Object to inspect and return info from
591 oname: str (default: ''):
591 oname: str (default: ''):
592 Name of the variable pointing to `obj`.
592 Name of the variable pointing to `obj`.
593 formatter: callable
593 formatter: callable
594 info:
594 info:
595 already computed information
595 already computed information
596 detail_level: integer
596 detail_level: integer
597 Granularity of detail level, if set to 1, give more information.
597 Granularity of detail level, if set to 1, give more information.
598 """
598 """
599
599
600 info = self._info(obj, oname=oname, info=info, detail_level=detail_level)
600 info = self._info(obj, oname=oname, info=info, detail_level=detail_level)
601
601
602 _mime = {
602 _mime = {
603 'text/plain': [],
603 'text/plain': [],
604 'text/html': '',
604 'text/html': '',
605 }
605 }
606
606
607 def append_field(bundle, title, key, formatter=None):
607 def append_field(bundle, title, key, formatter=None):
608 field = info[key]
608 field = info[key]
609 if field is not None:
609 if field is not None:
610 formatted_field = self._mime_format(field, formatter)
610 formatted_field = self._mime_format(field, formatter)
611 bundle['text/plain'].append((title, formatted_field['text/plain']))
611 bundle['text/plain'].append((title, formatted_field['text/plain']))
612 bundle['text/html'] += '<h1>' + title + '</h1>\n' + formatted_field['text/html'] + '\n'
612 bundle['text/html'] += '<h1>' + title + '</h1>\n' + formatted_field['text/html'] + '\n'
613
613
614 def code_formatter(text):
614 def code_formatter(text):
615 return {
615 return {
616 'text/plain': self.format(text),
616 'text/plain': self.format(text),
617 'text/html': pylight(text)
617 'text/html': pylight(text)
618 }
618 }
619
619
620 if info['isalias']:
620 if info['isalias']:
621 append_field(_mime, 'Repr', 'string_form')
621 append_field(_mime, 'Repr', 'string_form')
622
622
623 elif info['ismagic']:
623 elif info['ismagic']:
624 if detail_level > 0:
624 if detail_level > 0:
625 append_field(_mime, 'Source', 'source', code_formatter)
625 append_field(_mime, 'Source', 'source', code_formatter)
626 else:
626 else:
627 append_field(_mime, 'Docstring', 'docstring', formatter)
627 append_field(_mime, 'Docstring', 'docstring', formatter)
628 append_field(_mime, 'File', 'file')
628 append_field(_mime, 'File', 'file')
629
629
630 elif info['isclass'] or is_simple_callable(obj):
630 elif info['isclass'] or is_simple_callable(obj):
631 # Functions, methods, classes
631 # Functions, methods, classes
632 append_field(_mime, 'Signature', 'definition', code_formatter)
632 append_field(_mime, 'Signature', 'definition', code_formatter)
633 append_field(_mime, 'Init signature', 'init_definition', code_formatter)
633 append_field(_mime, 'Init signature', 'init_definition', code_formatter)
634 append_field(_mime, 'Docstring', 'docstring', formatter)
634 append_field(_mime, 'Docstring', 'docstring', formatter)
635 if detail_level > 0 and info['source']:
635 if detail_level > 0 and info['source']:
636 append_field(_mime, 'Source', 'source', code_formatter)
636 append_field(_mime, 'Source', 'source', code_formatter)
637 else:
637 else:
638 append_field(_mime, 'Init docstring', 'init_docstring', formatter)
638 append_field(_mime, 'Init docstring', 'init_docstring', formatter)
639
639
640 append_field(_mime, 'File', 'file')
640 append_field(_mime, 'File', 'file')
641 append_field(_mime, 'Type', 'type_name')
641 append_field(_mime, 'Type', 'type_name')
642 append_field(_mime, 'Subclasses', 'subclasses')
642
643
643 else:
644 else:
644 # General Python objects
645 # General Python objects
645 append_field(_mime, 'Signature', 'definition', code_formatter)
646 append_field(_mime, 'Signature', 'definition', code_formatter)
646 append_field(_mime, 'Call signature', 'call_def', code_formatter)
647 append_field(_mime, 'Call signature', 'call_def', code_formatter)
647 append_field(_mime, 'Type', 'type_name')
648 append_field(_mime, 'Type', 'type_name')
648 append_field(_mime, 'String form', 'string_form')
649 append_field(_mime, 'String form', 'string_form')
649
650
650 # Namespace
651 # Namespace
651 if info['namespace'] != 'Interactive':
652 if info['namespace'] != 'Interactive':
652 append_field(_mime, 'Namespace', 'namespace')
653 append_field(_mime, 'Namespace', 'namespace')
653
654
654 append_field(_mime, 'Length', 'length')
655 append_field(_mime, 'Length', 'length')
655 append_field(_mime, 'File', 'file')
656 append_field(_mime, 'File', 'file')
656
657
657 # Source or docstring, depending on detail level and whether
658 # Source or docstring, depending on detail level and whether
658 # source found.
659 # source found.
659 if detail_level > 0 and info['source']:
660 if detail_level > 0 and info['source']:
660 append_field(_mime, 'Source', 'source', code_formatter)
661 append_field(_mime, 'Source', 'source', code_formatter)
661 else:
662 else:
662 append_field(_mime, 'Docstring', 'docstring', formatter)
663 append_field(_mime, 'Docstring', 'docstring', formatter)
663
664
664 append_field(_mime, 'Class docstring', 'class_docstring', formatter)
665 append_field(_mime, 'Class docstring', 'class_docstring', formatter)
665 append_field(_mime, 'Init docstring', 'init_docstring', formatter)
666 append_field(_mime, 'Init docstring', 'init_docstring', formatter)
666 append_field(_mime, 'Call docstring', 'call_docstring', formatter)
667 append_field(_mime, 'Call docstring', 'call_docstring', formatter)
667
668
668
669
669 return self.format_mime(_mime)
670 return self.format_mime(_mime)
670
671
671 def pinfo(self, obj, oname='', formatter=None, info=None, detail_level=0, enable_html_pager=True):
672 def pinfo(self, obj, oname='', formatter=None, info=None, detail_level=0, enable_html_pager=True):
672 """Show detailed information about an object.
673 """Show detailed information about an object.
673
674
674 Optional arguments:
675 Optional arguments:
675
676
676 - oname: name of the variable pointing to the object.
677 - oname: name of the variable pointing to the object.
677
678
678 - formatter: callable (optional)
679 - formatter: callable (optional)
679 A special formatter for docstrings.
680 A special formatter for docstrings.
680
681
681 The formatter is a callable that takes a string as an input
682 The formatter is a callable that takes a string as an input
682 and returns either a formatted string or a mime type bundle
683 and returns either a formatted string or a mime type bundle
683 in the form of a dictionary.
684 in the form of a dictionary.
684
685
685 Although the support of custom formatter returning a string
686 Although the support of custom formatter returning a string
686 instead of a mime type bundle is deprecated.
687 instead of a mime type bundle is deprecated.
687
688
688 - info: a structure with some information fields which may have been
689 - info: a structure with some information fields which may have been
689 precomputed already.
690 precomputed already.
690
691
691 - detail_level: if set to 1, more information is given.
692 - detail_level: if set to 1, more information is given.
692 """
693 """
693 info = self._get_info(obj, oname, formatter, info, detail_level)
694 info = self._get_info(obj, oname, formatter, info, detail_level)
694 if not enable_html_pager:
695 if not enable_html_pager:
695 del info['text/html']
696 del info['text/html']
696 page.page(info)
697 page.page(info)
697
698
698 def info(self, obj, oname='', formatter=None, info=None, detail_level=0):
699 def info(self, obj, oname='', formatter=None, info=None, detail_level=0):
699 """DEPRECATED. Compute a dict with detailed information about an object.
700 """DEPRECATED. Compute a dict with detailed information about an object.
700 """
701 """
701 if formatter is not None:
702 if formatter is not None:
702 warnings.warn('The `formatter` keyword argument to `Inspector.info`'
703 warnings.warn('The `formatter` keyword argument to `Inspector.info`'
703 'is deprecated as of IPython 5.0 and will have no effects.',
704 'is deprecated as of IPython 5.0 and will have no effects.',
704 DeprecationWarning, stacklevel=2)
705 DeprecationWarning, stacklevel=2)
705 return self._info(obj, oname=oname, info=info, detail_level=detail_level)
706 return self._info(obj, oname=oname, info=info, detail_level=detail_level)
706
707
707 def _info(self, obj, oname='', info=None, detail_level=0) -> dict:
708 def _info(self, obj, oname='', info=None, detail_level=0) -> dict:
708 """Compute a dict with detailed information about an object.
709 """Compute a dict with detailed information about an object.
709
710
710 Parameters
711 Parameters
711 ==========
712 ==========
712
713
713 obj: any
714 obj: any
714 An object to find information about
715 An object to find information about
715 oname: str (default: ''):
716 oname: str (default: ''):
716 Name of the variable pointing to `obj`.
717 Name of the variable pointing to `obj`.
717 info: (default: None)
718 info: (default: None)
718 A struct (dict like with attr access) with some information fields
719 A struct (dict like with attr access) with some information fields
719 which may have been precomputed already.
720 which may have been precomputed already.
720 detail_level: int (default:0)
721 detail_level: int (default:0)
721 If set to 1, more information is given.
722 If set to 1, more information is given.
722
723
723 Returns
724 Returns
724 =======
725 =======
725
726
726 An object info dict with known fields from `info_fields`.
727 An object info dict with known fields from `info_fields`.
727 """
728 """
728
729
729 if info is None:
730 if info is None:
730 ismagic = False
731 ismagic = False
731 isalias = False
732 isalias = False
732 ospace = ''
733 ospace = ''
733 else:
734 else:
734 ismagic = info.ismagic
735 ismagic = info.ismagic
735 isalias = info.isalias
736 isalias = info.isalias
736 ospace = info.namespace
737 ospace = info.namespace
737
738
738 # Get docstring, special-casing aliases:
739 # Get docstring, special-casing aliases:
739 if isalias:
740 if isalias:
740 if not callable(obj):
741 if not callable(obj):
741 try:
742 try:
742 ds = "Alias to the system command:\n %s" % obj[1]
743 ds = "Alias to the system command:\n %s" % obj[1]
743 except:
744 except:
744 ds = "Alias: " + str(obj)
745 ds = "Alias: " + str(obj)
745 else:
746 else:
746 ds = "Alias to " + str(obj)
747 ds = "Alias to " + str(obj)
747 if obj.__doc__:
748 if obj.__doc__:
748 ds += "\nDocstring:\n" + obj.__doc__
749 ds += "\nDocstring:\n" + obj.__doc__
749 else:
750 else:
750 ds = getdoc(obj)
751 ds = getdoc(obj)
751 if ds is None:
752 if ds is None:
752 ds = '<no docstring>'
753 ds = '<no docstring>'
753
754
754 # store output in a dict, we initialize it here and fill it as we go
755 # store output in a dict, we initialize it here and fill it as we go
755 out = dict(name=oname, found=True, isalias=isalias, ismagic=ismagic)
756 out = dict(name=oname, found=True, isalias=isalias, ismagic=ismagic)
756
757
757 string_max = 200 # max size of strings to show (snipped if longer)
758 string_max = 200 # max size of strings to show (snipped if longer)
758 shalf = int((string_max - 5) / 2)
759 shalf = int((string_max - 5) / 2)
759
760
760 if ismagic:
761 if ismagic:
761 out['type_name'] = 'Magic function'
762 out['type_name'] = 'Magic function'
762 elif isalias:
763 elif isalias:
763 out['type_name'] = 'System alias'
764 out['type_name'] = 'System alias'
764 else:
765 else:
765 out['type_name'] = type(obj).__name__
766 out['type_name'] = type(obj).__name__
766
767
767 try:
768 try:
768 bclass = obj.__class__
769 bclass = obj.__class__
769 out['base_class'] = str(bclass)
770 out['base_class'] = str(bclass)
770 except:
771 except:
771 pass
772 pass
772
773
773 # String form, but snip if too long in ? form (full in ??)
774 # String form, but snip if too long in ? form (full in ??)
774 if detail_level >= self.str_detail_level:
775 if detail_level >= self.str_detail_level:
775 try:
776 try:
776 ostr = str(obj)
777 ostr = str(obj)
777 str_head = 'string_form'
778 str_head = 'string_form'
778 if not detail_level and len(ostr)>string_max:
779 if not detail_level and len(ostr)>string_max:
779 ostr = ostr[:shalf] + ' <...> ' + ostr[-shalf:]
780 ostr = ostr[:shalf] + ' <...> ' + ostr[-shalf:]
780 ostr = ("\n" + " " * len(str_head.expandtabs())).\
781 ostr = ("\n" + " " * len(str_head.expandtabs())).\
781 join(q.strip() for q in ostr.split("\n"))
782 join(q.strip() for q in ostr.split("\n"))
782 out[str_head] = ostr
783 out[str_head] = ostr
783 except:
784 except:
784 pass
785 pass
785
786
786 if ospace:
787 if ospace:
787 out['namespace'] = ospace
788 out['namespace'] = ospace
788
789
789 # Length (for strings and lists)
790 # Length (for strings and lists)
790 try:
791 try:
791 out['length'] = str(len(obj))
792 out['length'] = str(len(obj))
792 except Exception:
793 except Exception:
793 pass
794 pass
794
795
795 # Filename where object was defined
796 # Filename where object was defined
796 binary_file = False
797 binary_file = False
797 fname = find_file(obj)
798 fname = find_file(obj)
798 if fname is None:
799 if fname is None:
799 # if anything goes wrong, we don't want to show source, so it's as
800 # if anything goes wrong, we don't want to show source, so it's as
800 # if the file was binary
801 # if the file was binary
801 binary_file = True
802 binary_file = True
802 else:
803 else:
803 if fname.endswith(('.so', '.dll', '.pyd')):
804 if fname.endswith(('.so', '.dll', '.pyd')):
804 binary_file = True
805 binary_file = True
805 elif fname.endswith('<string>'):
806 elif fname.endswith('<string>'):
806 fname = 'Dynamically generated function. No source code available.'
807 fname = 'Dynamically generated function. No source code available.'
807 out['file'] = compress_user(fname)
808 out['file'] = compress_user(fname)
808
809
809 # Original source code for a callable, class or property.
810 # Original source code for a callable, class or property.
810 if detail_level:
811 if detail_level:
811 # Flush the source cache because inspect can return out-of-date
812 # Flush the source cache because inspect can return out-of-date
812 # source
813 # source
813 linecache.checkcache()
814 linecache.checkcache()
814 try:
815 try:
815 if isinstance(obj, property) or not binary_file:
816 if isinstance(obj, property) or not binary_file:
816 src = getsource(obj, oname)
817 src = getsource(obj, oname)
817 if src is not None:
818 if src is not None:
818 src = src.rstrip()
819 src = src.rstrip()
819 out['source'] = src
820 out['source'] = src
820
821
821 except Exception:
822 except Exception:
822 pass
823 pass
823
824
824 # Add docstring only if no source is to be shown (avoid repetitions).
825 # Add docstring only if no source is to be shown (avoid repetitions).
825 if ds and not self._source_contains_docstring(out.get('source'), ds):
826 if ds and not self._source_contains_docstring(out.get('source'), ds):
826 out['docstring'] = ds
827 out['docstring'] = ds
827
828
828 # Constructor docstring for classes
829 # Constructor docstring for classes
829 if inspect.isclass(obj):
830 if inspect.isclass(obj):
830 out['isclass'] = True
831 out['isclass'] = True
831
832
832 # get the init signature:
833 # get the init signature:
833 try:
834 try:
834 init_def = self._getdef(obj, oname)
835 init_def = self._getdef(obj, oname)
835 except AttributeError:
836 except AttributeError:
836 init_def = None
837 init_def = None
837
838
838 # get the __init__ docstring
839 # get the __init__ docstring
839 try:
840 try:
840 obj_init = obj.__init__
841 obj_init = obj.__init__
841 except AttributeError:
842 except AttributeError:
842 init_ds = None
843 init_ds = None
843 else:
844 else:
844 if init_def is None:
845 if init_def is None:
845 # Get signature from init if top-level sig failed.
846 # Get signature from init if top-level sig failed.
846 # Can happen for built-in types (list, etc.).
847 # Can happen for built-in types (list, etc.).
847 try:
848 try:
848 init_def = self._getdef(obj_init, oname)
849 init_def = self._getdef(obj_init, oname)
849 except AttributeError:
850 except AttributeError:
850 pass
851 pass
851 init_ds = getdoc(obj_init)
852 init_ds = getdoc(obj_init)
852 # Skip Python's auto-generated docstrings
853 # Skip Python's auto-generated docstrings
853 if init_ds == _object_init_docstring:
854 if init_ds == _object_init_docstring:
854 init_ds = None
855 init_ds = None
855
856
856 if init_def:
857 if init_def:
857 out['init_definition'] = init_def
858 out['init_definition'] = init_def
858
859
859 if init_ds:
860 if init_ds:
860 out['init_docstring'] = init_ds
861 out['init_docstring'] = init_ds
861
862
863 names = [sub.__name__ for sub in obj.__subclasses__()]
864 all_names = ', '.join(names)
865 out['subclasses'] = all_names
862 # and class docstring for instances:
866 # and class docstring for instances:
863 else:
867 else:
864 # reconstruct the function definition and print it:
868 # reconstruct the function definition and print it:
865 defln = self._getdef(obj, oname)
869 defln = self._getdef(obj, oname)
866 if defln:
870 if defln:
867 out['definition'] = defln
871 out['definition'] = defln
868
872
869 # First, check whether the instance docstring is identical to the
873 # First, check whether the instance docstring is identical to the
870 # class one, and print it separately if they don't coincide. In
874 # class one, and print it separately if they don't coincide. In
871 # most cases they will, but it's nice to print all the info for
875 # most cases they will, but it's nice to print all the info for
872 # objects which use instance-customized docstrings.
876 # objects which use instance-customized docstrings.
873 if ds:
877 if ds:
874 try:
878 try:
875 cls = getattr(obj,'__class__')
879 cls = getattr(obj,'__class__')
876 except:
880 except:
877 class_ds = None
881 class_ds = None
878 else:
882 else:
879 class_ds = getdoc(cls)
883 class_ds = getdoc(cls)
880 # Skip Python's auto-generated docstrings
884 # Skip Python's auto-generated docstrings
881 if class_ds in _builtin_type_docstrings:
885 if class_ds in _builtin_type_docstrings:
882 class_ds = None
886 class_ds = None
883 if class_ds and ds != class_ds:
887 if class_ds and ds != class_ds:
884 out['class_docstring'] = class_ds
888 out['class_docstring'] = class_ds
885
889
886 # Next, try to show constructor docstrings
890 # Next, try to show constructor docstrings
887 try:
891 try:
888 init_ds = getdoc(obj.__init__)
892 init_ds = getdoc(obj.__init__)
889 # Skip Python's auto-generated docstrings
893 # Skip Python's auto-generated docstrings
890 if init_ds == _object_init_docstring:
894 if init_ds == _object_init_docstring:
891 init_ds = None
895 init_ds = None
892 except AttributeError:
896 except AttributeError:
893 init_ds = None
897 init_ds = None
894 if init_ds:
898 if init_ds:
895 out['init_docstring'] = init_ds
899 out['init_docstring'] = init_ds
896
900
897 # Call form docstring for callable instances
901 # Call form docstring for callable instances
898 if safe_hasattr(obj, '__call__') and not is_simple_callable(obj):
902 if safe_hasattr(obj, '__call__') and not is_simple_callable(obj):
899 call_def = self._getdef(obj.__call__, oname)
903 call_def = self._getdef(obj.__call__, oname)
900 if call_def and (call_def != out.get('definition')):
904 if call_def and (call_def != out.get('definition')):
901 # it may never be the case that call def and definition differ,
905 # it may never be the case that call def and definition differ,
902 # but don't include the same signature twice
906 # but don't include the same signature twice
903 out['call_def'] = call_def
907 out['call_def'] = call_def
904 call_ds = getdoc(obj.__call__)
908 call_ds = getdoc(obj.__call__)
905 # Skip Python's auto-generated docstrings
909 # Skip Python's auto-generated docstrings
906 if call_ds == _func_call_docstring:
910 if call_ds == _func_call_docstring:
907 call_ds = None
911 call_ds = None
908 if call_ds:
912 if call_ds:
909 out['call_docstring'] = call_ds
913 out['call_docstring'] = call_ds
910
914
911 # Compute the object's argspec as a callable. The key is to decide
915 # Compute the object's argspec as a callable. The key is to decide
912 # whether to pull it from the object itself, from its __init__ or
916 # whether to pull it from the object itself, from its __init__ or
913 # from its __call__ method.
917 # from its __call__ method.
914
918
915 if inspect.isclass(obj):
919 if inspect.isclass(obj):
916 # Old-style classes need not have an __init__
920 # Old-style classes need not have an __init__
917 callable_obj = getattr(obj, "__init__", None)
921 callable_obj = getattr(obj, "__init__", None)
918 elif callable(obj):
922 elif callable(obj):
919 callable_obj = obj
923 callable_obj = obj
920 else:
924 else:
921 callable_obj = None
925 callable_obj = None
922
926
923 if callable_obj is not None:
927 if callable_obj is not None:
924 try:
928 try:
925 argspec = getargspec(callable_obj)
929 argspec = getargspec(callable_obj)
926 except Exception:
930 except Exception:
927 # For extensions/builtins we can't retrieve the argspec
931 # For extensions/builtins we can't retrieve the argspec
928 pass
932 pass
929 else:
933 else:
930 # named tuples' _asdict() method returns an OrderedDict, but we
934 # named tuples' _asdict() method returns an OrderedDict, but we
931 # we want a normal
935 # we want a normal
932 out['argspec'] = argspec_dict = dict(argspec._asdict())
936 out['argspec'] = argspec_dict = dict(argspec._asdict())
933 # We called this varkw before argspec became a named tuple.
937 # We called this varkw before argspec became a named tuple.
934 # With getfullargspec it's also called varkw.
938 # With getfullargspec it's also called varkw.
935 if 'varkw' not in argspec_dict:
939 if 'varkw' not in argspec_dict:
936 argspec_dict['varkw'] = argspec_dict.pop('keywords')
940 argspec_dict['varkw'] = argspec_dict.pop('keywords')
937
941
938 return object_info(**out)
942 return object_info(**out)
939
943
940 @staticmethod
944 @staticmethod
941 def _source_contains_docstring(src, doc):
945 def _source_contains_docstring(src, doc):
942 """
946 """
943 Check whether the source *src* contains the docstring *doc*.
947 Check whether the source *src* contains the docstring *doc*.
944
948
945 This is is helper function to skip displaying the docstring if the
949 This is is helper function to skip displaying the docstring if the
946 source already contains it, avoiding repetition of information.
950 source already contains it, avoiding repetition of information.
947 """
951 """
948 try:
952 try:
949 def_node, = ast.parse(dedent(src)).body
953 def_node, = ast.parse(dedent(src)).body
950 return ast.get_docstring(def_node) == doc
954 return ast.get_docstring(def_node) == doc
951 except Exception:
955 except Exception:
952 # The source can become invalid or even non-existent (because it
956 # The source can become invalid or even non-existent (because it
953 # is re-fetched from the source file) so the above code fail in
957 # is re-fetched from the source file) so the above code fail in
954 # arbitrary ways.
958 # arbitrary ways.
955 return False
959 return False
956
960
957 def psearch(self,pattern,ns_table,ns_search=[],
961 def psearch(self,pattern,ns_table,ns_search=[],
958 ignore_case=False,show_all=False):
962 ignore_case=False,show_all=False):
959 """Search namespaces with wildcards for objects.
963 """Search namespaces with wildcards for objects.
960
964
961 Arguments:
965 Arguments:
962
966
963 - pattern: string containing shell-like wildcards to use in namespace
967 - pattern: string containing shell-like wildcards to use in namespace
964 searches and optionally a type specification to narrow the search to
968 searches and optionally a type specification to narrow the search to
965 objects of that type.
969 objects of that type.
966
970
967 - ns_table: dict of name->namespaces for search.
971 - ns_table: dict of name->namespaces for search.
968
972
969 Optional arguments:
973 Optional arguments:
970
974
971 - ns_search: list of namespace names to include in search.
975 - ns_search: list of namespace names to include in search.
972
976
973 - ignore_case(False): make the search case-insensitive.
977 - ignore_case(False): make the search case-insensitive.
974
978
975 - show_all(False): show all names, including those starting with
979 - show_all(False): show all names, including those starting with
976 underscores.
980 underscores.
977 """
981 """
978 #print 'ps pattern:<%r>' % pattern # dbg
982 #print 'ps pattern:<%r>' % pattern # dbg
979
983
980 # defaults
984 # defaults
981 type_pattern = 'all'
985 type_pattern = 'all'
982 filter = ''
986 filter = ''
983
987
984 cmds = pattern.split()
988 cmds = pattern.split()
985 len_cmds = len(cmds)
989 len_cmds = len(cmds)
986 if len_cmds == 1:
990 if len_cmds == 1:
987 # Only filter pattern given
991 # Only filter pattern given
988 filter = cmds[0]
992 filter = cmds[0]
989 elif len_cmds == 2:
993 elif len_cmds == 2:
990 # Both filter and type specified
994 # Both filter and type specified
991 filter,type_pattern = cmds
995 filter,type_pattern = cmds
992 else:
996 else:
993 raise ValueError('invalid argument string for psearch: <%s>' %
997 raise ValueError('invalid argument string for psearch: <%s>' %
994 pattern)
998 pattern)
995
999
996 # filter search namespaces
1000 # filter search namespaces
997 for name in ns_search:
1001 for name in ns_search:
998 if name not in ns_table:
1002 if name not in ns_table:
999 raise ValueError('invalid namespace <%s>. Valid names: %s' %
1003 raise ValueError('invalid namespace <%s>. Valid names: %s' %
1000 (name,ns_table.keys()))
1004 (name,ns_table.keys()))
1001
1005
1002 #print 'type_pattern:',type_pattern # dbg
1006 #print 'type_pattern:',type_pattern # dbg
1003 search_result, namespaces_seen = set(), set()
1007 search_result, namespaces_seen = set(), set()
1004 for ns_name in ns_search:
1008 for ns_name in ns_search:
1005 ns = ns_table[ns_name]
1009 ns = ns_table[ns_name]
1006 # Normally, locals and globals are the same, so we just check one.
1010 # Normally, locals and globals are the same, so we just check one.
1007 if id(ns) in namespaces_seen:
1011 if id(ns) in namespaces_seen:
1008 continue
1012 continue
1009 namespaces_seen.add(id(ns))
1013 namespaces_seen.add(id(ns))
1010 tmp_res = list_namespace(ns, type_pattern, filter,
1014 tmp_res = list_namespace(ns, type_pattern, filter,
1011 ignore_case=ignore_case, show_all=show_all)
1015 ignore_case=ignore_case, show_all=show_all)
1012 search_result.update(tmp_res)
1016 search_result.update(tmp_res)
1013
1017
1014 page.page('\n'.join(sorted(search_result)))
1018 page.page('\n'.join(sorted(search_result)))
General Comments 0
You need to be logged in to leave comments. Login now