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