Make patch attribute in response optional

tobiashenkel · tobiashenkel · commit 0550bf3192e7 · 2018-03-29T18:45:07.000+02:00
When requesting files from a pull request which adds a large file (e.g. more than 3000 lines) there can be the case that the response of GitGub doesn't contain the patch in the response. In this case we have to default to None. Resolves: sigmavirus24#816
diff --git a/github3/pulls.py b/github3/pulls.py
@@ -136,6 +136,12 @@ class PullFile(models.GitHubCore):
 
         The patch generated by this
 
+        .. note::
+
+            If the patch is larger than a specific size it may be missing
+            from GitHub's response. The attribute will be set to ``None``
+            in this case.
+
     .. attribute:: raw_url
 
         The API resource to view the raw diff of this file
@@ -158,7 +164,7 @@ def _update_attributes(self, pfile):
         self.changes_count = pfile['changes']
         self.blob_url = pfile['blob_url']
         self.raw_url = pfile['raw_url']
-        self.patch = pfile['patch']
+        self.patch = pfile.get('patch')
         self.contents_url = pfile['contents_url']
 
     def _repr(self):
diff --git a/tests/unit/json/pull_file_patch_example b/tests/unit/json/pull_file_patch_example
@@ -0,0 +1,11 @@
+{
+    "sha": "bbcd538c8e72b8c175046e27cc8f907076331401",
+    "filename": "file1.txt",
+    "status": "added",
+    "additions": 103,
+    "deletions": 21,
+    "changes": 124,
+    "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+    "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
+    "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e"
+}
diff --git a/tests/unit/test_pulls.py b/tests/unit/test_pulls.py
@@ -286,3 +286,21 @@ def test_contents(self):
         self.session.get.assert_called_once_with(
             self.example_data['contents_url']
         )
+
+
+class TestPullFilePatch(helper.UnitHelper):
+    """Unit tests for the PullFile class with empty patch."""
+
+    described_class = pulls.PullFile
+    get_pull_file_patch_example_data = helper.create_example_data_helper(
+        'pull_file_patch_example'
+    )
+    example_data = get_pull_file_patch_example_data()
+
+    def test_contents(self):
+        """Verify the request made to fetch a pull request file contents."""
+        self.instance.contents()
+
+        self.session.get.assert_called_once_with(
+            self.example_data['contents_url']
+        )
