Allow multiline comments in PullRequest

github/PullRequest.py

@@ -409,25 +409,36 @@ def create_comment(self, body, commit_id, path, position):
         """
         return self.create_review_comment(body, commit_id, path, position)
 
-    def create_review_comment(self, body, commit_id, path, position):
+    def create_review_comment(
+        self, body, commit, path, line, start_line=None, as_suggestion=False
+    ):
         """
         :calls: `POST /repos/{owner}/{repo}/pulls/{number}/comments <https://docs.github.com/en/rest/reference/pulls#review-comments>`_
         :param body: string
-        :param commit_id: :class:`github.Commit.Commit`
+        :param commit: :class:`github.Commit.Commit`
         :param path: string
-        :param position: integer
+        :param line: integer
+        :param start_line: integer
+        :param as_suggestion: bool
         :rtype: :class:`github.PullRequestComment.PullRequestComment`
         """
         assert isinstance(body, str), body
-        assert isinstance(commit_id, github.Commit.Commit), commit_id
+        assert isinstance(commit, github.Commit.Commit), commit
         assert isinstance(path, str), path
-        assert isinstance(position, int), position
+        assert isinstance(line, int), line
+        assert start_line is None or isinstance(start_line, int), start_line
+        assert isinstance(as_suggestion, bool), as_suggestion
+
+        if as_suggestion:
+            body = f"```suggestion\n{body}\n```"
         post_parameters = {
             "body": body,
-            "commit_id": commit_id._identity,
+            "commit_id": commit._identity,
             "path": path,
-            "position": position,
+            "line": line,
         }
+        if start_line is not None:
+            post_parameters["start_line"] = start_line
         headers, data = self._requester.requestJsonAndCheck(
             "POST", f"{self.url}/comments", input=post_parameters
         )

tests/PullRequest.py

@@ -154,6 +154,20 @@ def testCreateComment(self):
         )
         self.assertEqual(comment.id, 886298)
 
+    def testCreateMultilineReviewComment(self):
+        commit = self.repo.get_commit("8a4f306d4b223682dd19410d4a9150636ebe4206")
+        comment = self.pull.create_review_comment(
+            "Comment created by PyGithub", commit, "src/github/Issue.py", 10, 5
+        )
+        self.assertEqual(comment.id, 886298)
+
+    def testCreateMultilineReviewCommentAsSuggestion(self):
+        commit = self.repo.get_commit("8a4f306d4b223682dd19410d4a9150636ebe4206")
+        comment = self.pull.create_review_comment(
+            "Comment created by PyGithub", commit, "src/github/Issue.py", 10, 5, True
+        )
+        self.assertEqual(comment.id, 886298)
+
     def testGetComments(self):
         self.assertListKeyEqual(self.pull.get_comments(), lambda c: c.id, [886298])
 

tests/ReplayData/PullRequest.testCreateComment.txt

@@ -15,8 +15,8 @@ api.github.com
 None
 /repos/jacquev6/PyGithub/pulls/31/comments
 {'Content-Type': 'application/json', 'Authorization': 'Basic login_and_password_removed', 'User-Agent': 'PyGithub/Python'}
-{"body": "Comment created by PyGithub", "commit_id": "8a4f306d4b223682dd19410d4a9150636ebe4206", "position": 5, "path": "src/github/Issue.py"}
+{"body": "Comment created by PyGithub", "commit_id": "8a4f306d4b223682dd19410d4a9150636ebe4206", "line": 5, "path": "src/github/Issue.py"}
 201
 [('status', '201 Created'), ('x-ratelimit-remaining', '4953'), ('content-length', '937'), ('server', 'nginx/1.0.13'), ('connection', 'keep-alive'), ('x-ratelimit-limit', '5000'), ('etag', '"7ca841d45253326d61bee20c809872dc"'), ('date', 'Sun, 27 May 2012 09:40:12 GMT'), ('content-type', 'application/json; charset=utf-8'), ('location', 'https://api.github.com/repos/jacquev6/PyGithub/pulls/comments/886298')]
-{"updated_at":"2012-05-27T09:40:12Z","position":5,"original_position":5,"body":"Comment created by PyGithub","url":"https://api.github.com/repos/jacquev6/PyGithub/pulls/comments/886298","commit_id":"8a4f306d4b223682dd19410d4a9150636ebe4206","created_at":"2012-05-27T09:40:12Z","user":{"url":"https://api.github.com/users/jacquev6","avatar_url":"https://secure.gravatar.com/avatar/b68de5ae38616c296fa345d2b9df2225?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png","gravatar_id":"b68de5ae38616c296fa345d2b9df2225","login":"jacquev6","id":327146},"original_commit_id":"8a4f306d4b223682dd19410d4a9150636ebe4206","path":"src/github/Issue.py","id":886298,"_links":{"self":{"href":"https://api.github.com/repos/jacquev6/PyGithub/pulls/comments/886298"},"html":{"href":"https://github.com/jacquev6/PyGithub/pull/31#r886298"},"pull_request":{"href":"https://api.github.com/repos/jacquev6/PyGithub/pulls/31"}}}
+{"updated_at":"2012-05-27T09:40:12Z","line":5,"original_position":5,"body":"Comment created by PyGithub","url":"https://api.github.com/repos/jacquev6/PyGithub/pulls/comments/886298","commit_id":"8a4f306d4b223682dd19410d4a9150636ebe4206","created_at":"2012-05-27T09:40:12Z","user":{"url":"https://api.github.com/users/jacquev6","avatar_url":"https://secure.gravatar.com/avatar/b68de5ae38616c296fa345d2b9df2225?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png","gravatar_id":"b68de5ae38616c296fa345d2b9df2225","login":"jacquev6","id":327146},"original_commit_id":"8a4f306d4b223682dd19410d4a9150636ebe4206","path":"src/github/Issue.py","id":886298,"_links":{"self":{"href":"https://api.github.com/repos/jacquev6/PyGithub/pulls/comments/886298"},"html":{"href":"https://github.com/jacquev6/PyGithub/pull/31#r886298"},"pull_request":{"href":"https://api.github.com/repos/jacquev6/PyGithub/pulls/31"}}}