Allow multiline comments in PullRequest

github/PullRequest.py

@@ -398,36 +398,86 @@ def as_issue(self):
         headers, data = self._requester.requestJsonAndCheck("GET", self.issue_url)
         return github.Issue.Issue(self._requester, headers, data, completed=True)
 
-    def create_comment(self, body, commit_id, path, position):
+    def create_comment(self, body, commit, path, position):
         """
         :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
         :rtype: :class:`github.PullRequestComment.PullRequestComment`
         """
-        return self.create_review_comment(body, commit_id, path, position)
+        return self.create_review_comment(body, commit, path, position)
 
-    def create_review_comment(self, body, commit_id, path, position):
+    def create_review_comment(
+        self,
+        body,
+        commit,
+        path,
+        # line replaces deprecated position argument, so we put it between path and side
+        line=github.GithubObject.NotSet,
+        side=github.GithubObject.NotSet,
+        start_line=github.GithubObject.NotSet,
+        start_side=github.GithubObject.NotSet,
+        in_reply_to=github.GithubObject.NotSet,
+        subject_type=github.GithubObject.NotSet,
+        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 side: string
+        :param start_line: integer
+        :param start_side: string
+        :param in_reply_to: integer
+        :param subject_type: string
+        :param as_suggestion: bool interprets the body as suggested code and modifies it accordingly
         :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 line is github.GithubObject.NotSet or isinstance(line, int), line
+        assert side is github.GithubObject.NotSet or side in ["LEFT", "RIGHT"], side
+        assert start_line is github.GithubObject.NotSet or isinstance(
+            start_line, int
+        ), start_line
+        assert start_side is github.GithubObject.NotSet or start_side in [
+            "LEFT",
+            "RIGHT",
+        ], start_side
+        assert in_reply_to is github.GithubObject.NotSet or isinstance(
+            in_reply_to, int
+        ), in_reply_to
+        assert subject_type is github.GithubObject.NotSet or subject_type in [
+            "LINE",
+            "FILE",
+            "side",
+        ], subject_type
+        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,
         }
+        if line is not github.GithubObject.NotSet:
+            post_parameters["line"] = line
+        if side is not github.GithubObject.NotSet:
+            post_parameters["side"] = side
+        if start_line is not github.GithubObject.NotSet:
+            post_parameters["start_line"] = start_line
+        if start_side is not github.GithubObject.NotSet:
+            post_parameters["start_side"] = start_side
+        if in_reply_to is not github.GithubObject.NotSet:
+            post_parameters["in_reply_to"] = in_reply_to
+        if subject_type is not github.GithubObject.NotSet:
+            post_parameters["subject_type"] = subject_type
         headers, data = self._requester.requestJsonAndCheck(
             "POST", f"{self.url}/comments", input=post_parameters
         )

tests/PullRequest.py

@@ -152,6 +152,67 @@ def testCreateComment(self):
         )
         self.assertEqual(comment.id, 886298)
 
+    def testCreateReviewCommentInReplyTo(self):
+        commit = self.repo.get_commit("8a4f306d4b223682dd19410d4a9150636ebe4206")
+        comment = self.pull.create_review_comment(
+            "Comment created by PyGithub",
+            commit,
+            "src/github/Issue.py",
+            5,
+            in_reply_to=42,
+        )
+        self.assertEqual(comment.id, 886298)
+
+    def testCreateReviewCommentSubjectType(self):
+        commit = self.repo.get_commit("8a4f306d4b223682dd19410d4a9150636ebe4206")
+        comment = self.pull.create_review_comment(
+            "Comment created by PyGithub",
+            commit,
+            "src/github/Issue.py",
+            5,
+            subject_type="FILE",
+        )
+        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,
+            start_line=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,
+            start_line=5,
+            as_suggestion=True,
+        )
+        self.assertEqual(comment.id, 886298)
+        self.assertEqual(
+            comment.body, "```suggestion\nComment created by PyGithub\n```"
+        )
+
+    def testCreateMultilineReviewCommentChoosingSide(self):
+        commit = self.repo.get_commit("8a4f306d4b223682dd19410d4a9150636ebe4206")
+        comment = self.pull.create_review_comment(
+            "Comment created by PyGithub",
+            commit,
+            "src/github/Issue.py",
+            10,
+            start_line=5,
+            side="RIGHT",
+            start_side="RIGHT",
+        )
+        self.assertEqual(comment.id, 886298)
+
     def testGetComments(self):
         epoch = datetime.datetime(1970, 1, 1, 0, 0)
         comments = self.pull.get_comments(sort="updated", direction="desc", since=epoch)

tests/ReplayData/PullRequest.testCreateComment.txt

@@ -15,8 +15,8 @@ api.github.com
 None
 /repos/PyGithub/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/PyGithub/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/PyGithub/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/PyGithub/PyGithub/pulls/comments/886298"},"html":{"href":"https://github.com/PyGithub/PyGithub/pull/31#r886298"},"pull_request":{"href":"https://api.github.com/repos/PyGithub/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/PyGithub/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/PyGithub/PyGithub/pulls/comments/886298"},"html":{"href":"https://github.com/PyGithub/PyGithub/pull/31#r886298"},"pull_request":{"href":"https://api.github.com/repos/PyGithub/PyGithub/pulls/31"}}}