Add hook to GitHubIterator for object responses

westphahl · westphahl · commit 453d09514bdb · 2019-01-03T12:33:22.000+01:00
Some GitHub APIs don't directly return lists when listing objects, but
contain the elements below a dict key.

The hook allows classes to declare a 'list_response_dict_key' attribute
that is used to lookup the list of elements in the return JSON object.
diff --git a/src/github3/checks.py b/src/github3/checks.py
@@ -193,6 +193,7 @@ class CheckSuite(models.GitHubCore):
     """
 
     class_name = "CheckSuite"
+    list_response_dict_key = "check_suites"
     CUSTOM_HEADERS = {"Accept": "application/vnd.github.antiope-preview+json"}
 
     def _update_attributes(self, suite):
@@ -320,6 +321,7 @@ class CheckRun(models.GitHubCore):
     """
 
     class_name = "CheckRun"
+    list_response_dict_key = "check_runs"
     CUSTOM_HEADERS = {"Accept": "application/vnd.github.antiope-preview+json"}
 
     def _update_attributes(self, run):
diff --git a/src/github3/structs.py b/src/github3/structs.py
@@ -112,7 +112,12 @@ def __next__(self):
         return next(self.__i__)
 
     def _get_json(self, response):
-        return self._json(response, 200)
+        json = self._json(response, 200)
+        if isinstance(json, dict):
+            list_key = getattr(self.cls, "list_response_dict_key", None)
+            if list_key is not None:
+                return json.get(list_key)
+        return json
 
     def refresh(self, conditional=False):
         self.count = self.original
