Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-30533:Add function inspect.getmembers_static that does not call properties or dynamic properties. #20911

Merged
merged 5 commits into from
Nov 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions Lib/inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -441,9 +441,7 @@ def isabstract(object):
return True
return False

def getmembers(object, predicate=None):
"""Return all members of an object as (name, value) pairs sorted by name.
Optionally, only return members that satisfy a given predicate."""
def _getmembers(object, predicate, getter):
if isclass(object):
mro = (object,) + getmro(object)
else:
Expand All @@ -466,7 +464,7 @@ def getmembers(object, predicate=None):
# like calling their __get__ (see bug #1785), so fall back to
# looking in the __dict__.
try:
value = getattr(object, key)
value = getter(object, key)
# handle the duplicate key
if key in processed:
raise AttributeError
Expand All @@ -485,6 +483,25 @@ def getmembers(object, predicate=None):
results.sort(key=lambda pair: pair[0])
return results

def getmembers(object, predicate=None):
"""Return all members of an object as (name, value) pairs sorted by name.
Optionally, only return members that satisfy a given predicate."""
return _getmembers(object, predicate, getattr)

def getmembers_static(object, predicate=None):
"""Return all members of an object as (name, value) pairs sorted by name
without triggering dynamic lookup via the descriptor protocol,
__getattr__ or __getattribute__. Optionally, only return members that
satisfy a given predicate.

Note: this function may not be able to retrieve all members
that getmembers can fetch (like dynamically created attributes)
and may find members that getmembers can't (like descriptors
that raise AttributeError). It can also return descriptor objects
instead of instance members in some cases.
"""
return _getmembers(object, predicate, getattr_static)

Attribute = namedtuple('Attribute', 'name kind defining_class object')

def classify_class_attrs(cls):
Expand Down
17 changes: 17 additions & 0 deletions Lib/test/test_inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -1275,6 +1275,23 @@ def eggs(self):
self.assertIn(('eggs', 'scrambled'), inspect.getmembers(A))
self.assertIn(('eggs', 'spam'), inspect.getmembers(A()))

def test_getmembers_static(self):
class A:
@property
def name(self):
raise NotImplementedError
@types.DynamicClassAttribute
def eggs(self):
raise NotImplementedError

a = A()
instance_members = inspect.getmembers_static(a)
class_members = inspect.getmembers_static(A)
self.assertIn(('name', inspect.getattr_static(a, 'name')), instance_members)
self.assertIn(('eggs', inspect.getattr_static(a, 'eggs')), instance_members)
self.assertIn(('name', inspect.getattr_static(A, 'name')), class_members)
self.assertIn(('eggs', inspect.getattr_static(A, 'eggs')), class_members)

def test_getmembers_with_buggy_dir(self):
class M(type):
def __dir__(cls):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add :func:`inspect.getmembers_static` , it return all members without
triggering dynamic lookup via the descriptor protocol. Patch by Weipeng Hong.