Refactored utility function

Author: yushao2

pylint/checkers/refactoring/recommendation_checker.py

@@ -1,40 +1,14 @@
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 # For details: https://github.com/PyCQA/pylint/blob/master/LICENSE
 
-from typing import Optional, Union, cast
+from typing import cast
 
 import astroid
 
 from pylint import checkers, interfaces
 from pylint.checkers import utils
 
 
-def _check_if_dict_keys_used(
-    node: Union[astroid.For, astroid.Comprehension]
-) -> Optional[str]:
-    if not isinstance(node.iter, astroid.Call):
-        # Is it a dictionary?
-        if not isinstance(node.iter, (astroid.Name, astroid.Attribute)):
-            return None
-        inferred = utils.safe_infer(node.iter)
-        if not isinstance(inferred, (astroid.Dict, astroid.DictComp)):
-            return None
-        iterating_object_name = node.iter.as_string()
-
-    else:
-        # Is it a proper keys call?
-        if (
-            isinstance(node.iter.func, astroid.Name)
-            or node.iter.func.attrname != "keys"
-        ):
-            return None
-        inferred = utils.safe_infer(node.iter.func)
-        if not isinstance(inferred, (astroid.BoundMethod, astroid.Dict)):
-            return None
-        iterating_object_name = node.iter.as_string().partition(".")[0]
-    return iterating_object_name
-
-
 class RecommendationChecker(checkers.BaseChecker):
 
     __implements__ = (interfaces.IAstroidChecker,)
@@ -166,7 +140,7 @@ def _check_consider_using_dict_items(self, node: astroid.For) -> None:
         # that the object which is iterated is used as a subscript in the
         # body of the for.
 
-        iterating_object_name = _check_if_dict_keys_used(node)
+        iterating_object_name = utils.get_iterating_dictionary_name(node)
         if iterating_object_name is None:
             return
 
@@ -210,7 +184,7 @@ def _check_consider_using_dict_items(self, node: astroid.For) -> None:
 
     @utils.check_messages("consider-using-dict-items")
     def visit_comprehension(self, node: astroid.Comprehension) -> None:
-        iterating_object_name = _check_if_dict_keys_used(node)
+        iterating_object_name = utils.get_iterating_dictionary_name(node)
         if iterating_object_name is None:
             return
 

pylint/checkers/utils.py

@@ -1492,3 +1492,33 @@ def is_assign_name_annotated_with(node: astroid.AssignName, typing_name: str) ->
     ):
         return True
     return False
+
+
+def get_iterating_dictionary_name(
+    node: Union[astroid.For, astroid.Comprehension]
+) -> Optional[str]:
+    """Get the name of the dictionary which keys are being iterated over on
+    a ``astroid.For`` or ``astroid.Comprehension`` node.
+
+    If the iterating object is not either the keys method of a dictionary
+    or a dictionary itself, this returns None
+    """
+    if isinstance(node.iter, astroid.Call):
+        # Is it a proper keys call?
+        if (
+            isinstance(node.iter.func, astroid.Name)
+            or node.iter.func.attrname != "keys"
+        ):
+            return None
+        inferred = safe_infer(node.iter.func)
+        if not isinstance(inferred, (astroid.BoundMethod, astroid.Dict)):
+            return None
+        return node.iter.as_string().partition(".")[0]
+
+    # Is it a dictionary?
+    if not isinstance(node.iter, (astroid.Name, astroid.Attribute)):
+        return None
+    inferred = safe_infer(node.iter)
+    if not isinstance(inferred, (astroid.Dict, astroid.DictComp)):
+        return None
+    return node.iter.as_string()