Show More
@@ -1,85 +1,89 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """A fancy version of Python's builtin :func:`dir` function. |
|
3 | 3 | """ |
|
4 | 4 | |
|
5 | 5 | #----------------------------------------------------------------------------- |
|
6 | 6 | # Copyright (C) 2008-2011 The IPython Development Team |
|
7 | 7 | # |
|
8 | 8 | # Distributed under the terms of the BSD License. The full license is in |
|
9 | 9 | # the file COPYING, distributed as part of this software. |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | # Imports |
|
14 | 14 | #----------------------------------------------------------------------------- |
|
15 | 15 | from .py3compat import string_types |
|
16 | 16 | |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | # Code |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | 21 | |
|
22 | 22 | def safe_hasattr(obj, attr): |
|
23 | 23 | """In recent versions of Python, hasattr() only catches AttributeError. |
|
24 | 24 | This catches all errors. |
|
25 | 25 | """ |
|
26 | 26 | try: |
|
27 | 27 | getattr(obj, attr) |
|
28 | 28 | return True |
|
29 | 29 | except: |
|
30 | 30 | return False |
|
31 | 31 | |
|
32 | 32 | |
|
33 | 33 | def get_class_members(cls): |
|
34 | 34 | ret = dir(cls) |
|
35 | 35 | if safe_hasattr(cls, '__bases__'): |
|
36 | 36 | try: |
|
37 | 37 | bases = cls.__bases__ |
|
38 | 38 | except AttributeError: |
|
39 | 39 | # `obj` lied to hasattr (e.g. Pyro), ignore |
|
40 | 40 | pass |
|
41 | 41 | else: |
|
42 | 42 | for base in bases: |
|
43 | 43 | ret.extend(get_class_members(base)) |
|
44 | 44 | return ret |
|
45 | 45 | |
|
46 | 46 | |
|
47 | 47 | def dir2(obj): |
|
48 | 48 | """dir2(obj) -> list of strings |
|
49 | 49 | |
|
50 | 50 | Extended version of the Python builtin dir(), which does a few extra |
|
51 | 51 | checks, and supports common objects with unusual internals that confuse |
|
52 | 52 | dir(), such as Traits and PyCrust. |
|
53 | 53 | |
|
54 | 54 | This version is guaranteed to return only a list of true strings, whereas |
|
55 | 55 | dir() returns anything that objects inject into themselves, even if they |
|
56 | 56 | are later not really valid for attribute access (many extension libraries |
|
57 | 57 | have such bugs). |
|
58 | 58 | """ |
|
59 | 59 | |
|
60 | 60 | # Start building the attribute list via dir(), and then complete it |
|
61 | 61 | # with a few extra special-purpose calls. |
|
62 | 62 | |
|
63 | words = set(dir(obj)) | |
|
63 | try: | |
|
64 | words = set(dir(obj)) | |
|
65 | except Exception: | |
|
66 | # TypeError: dir(obj) does not return a list | |
|
67 | words = set() | |
|
64 | 68 | |
|
65 | 69 | if safe_hasattr(obj, '__class__'): |
|
66 | 70 | #words.add('__class__') |
|
67 | 71 | words |= set(get_class_members(obj.__class__)) |
|
68 | 72 | |
|
69 | 73 | |
|
70 | 74 | # for objects with Enthought's traits, add trait_names() list |
|
71 | 75 | # for PyCrust-style, add _getAttributeNames() magic method list |
|
72 | 76 | for attr in ('trait_names', '_getAttributeNames'): |
|
73 | 77 | try: |
|
74 | 78 | func = getattr(obj, attr) |
|
75 | 79 | if callable(func): |
|
76 | 80 | words |= set(func()) |
|
77 | 81 | except: |
|
78 | 82 | # TypeError: obj is class not instance |
|
79 | 83 | pass |
|
80 | 84 | |
|
81 | 85 | # filter out non-string attributes which may be stuffed by dir() calls |
|
82 | 86 | # and poor coding in third-party modules |
|
83 | 87 | |
|
84 | 88 | words = [w for w in words if isinstance(w, string_types)] |
|
85 | 89 | return sorted(words) |
General Comments 0
You need to be logged in to leave comments.
Login now