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