Move GetClassAttrsDict to inspectutils.

dbieber · copybara-github · commit c830177ce00b · 2020-02-28T09:37:59.000-08:00
PiperOrigin-RevId: 297862432
Change-Id: I8b37f6715f70085a9b967b183e27aaa031480ad1
diff --git a/fire/completion.py b/fire/completion.py
@@ -281,17 +281,6 @@ def _FishScript(name, commands, default_options=None):
   )
 
 
-def GetClassAttrsDict(component):
-  """Gets the attributes of the component class, as a dict with name keys."""
-  if not inspect.isclass(component):
-    return None
-  class_attrs_list = inspect.classify_class_attrs(component)
-  return {
-      class_attr.name: class_attr
-      for class_attr in class_attrs_list
-  }
-
-
 def MemberVisible(component, name, member, class_attrs=None, verbose=False):
   """Returns whether a member should be included in auto-completion or help.
 
@@ -328,7 +317,7 @@ def MemberVisible(component, name, member, class_attrs=None, verbose=False):
   if inspect.isclass(component):
     # If class_attrs has not been provided, compute it.
     if class_attrs is None:
-      class_attrs = GetClassAttrsDict(class_attrs)
+      class_attrs = inspectutils.GetClassAttrsDict(class_attrs)
     class_attr = class_attrs.get(name)
     if class_attr and class_attr.kind in ('method', 'property'):
       # methods and properties should be accessed on instantiated objects,
@@ -355,9 +344,9 @@ def VisibleMembers(component, class_attrs=None, verbose=False):
   Args:
     component: The component whose members to list.
     class_attrs: (optional) If component is a class, you may provide this as:
-      GetClassAttrsDict(component). If not provided, it will be computed.
-      If provided, this determines how class members will be treated for
-      visibility. In particular, methods are generally hidden for
+      inspectutils.GetClassAttrsDict(component). If not provided, it will be
+      computed. If provided, this determines how class members will be treated
+      for visibility. In particular, methods are generally hidden for
       non-instantiated classes, but if you wish them to be shown (e.g. for
       completion scripts) then pass in a different class_attr for them.
     verbose: Whether to include private members.
@@ -371,7 +360,7 @@ def VisibleMembers(component, class_attrs=None, verbose=False):
 
   # If class_attrs has not been provided, compute it.
   if class_attrs is None:
-    class_attrs = GetClassAttrsDict(component)
+    class_attrs = inspectutils.GetClassAttrsDict(component)
   return [
       (member_name, member) for member_name, member in members
       if MemberVisible(component, member_name, member, class_attrs=class_attrs,
diff --git a/fire/core.py b/fire/core.py
@@ -309,7 +309,7 @@ def _DictAsString(result, verbose=False):
   # We need to do 2 iterations over the items in the result dict
   # 1) Getting visible items and the longest key for output formatting
   # 2) Actually construct the output lines
-  class_attrs = completion.GetClassAttrsDict(result)
+  class_attrs = inspectutils.GetClassAttrsDict(result)
   result_visible = {
       key: value for key, value in result.items()
       if completion.MemberVisible(result, key, value,
diff --git a/fire/inspectutils.py b/fire/inspectutils.py
@@ -268,3 +268,14 @@ def IsNamedTuple(component):
 
   has_fields = bool(getattr(component, '_fields', None))
   return has_fields
+
+
+def GetClassAttrsDict(component):
+  """Gets the attributes of the component class, as a dict with name keys."""
+  if not inspect.isclass(component):
+    return None
+  class_attrs_list = inspect.classify_class_attrs(component)
+  return {
+      class_attr.name: class_attr
+      for class_attr in class_attrs_list
+  }
diff --git a/fire/value_types.py b/fire/value_types.py
@@ -20,7 +20,7 @@
 
 import inspect
 
-from fire import completion
+from fire import inspectutils
 import six
 
 
@@ -78,7 +78,7 @@ def HasCustomStr(component):
     Whether `component` has a custom __str__ method.
   """
   if hasattr(component, '__str__'):
-    class_attrs = completion.GetClassAttrsDict(type(component)) or {}
+    class_attrs = inspectutils.GetClassAttrsDict(type(component)) or {}
     str_attr = class_attrs.get('__str__')
     if str_attr and str_attr.defining_class is not object:
       return True
