PullRequestComment

class github.PullRequestComment.PullRequestComment

This class represents PullRequestComments.

The reference can be found here https://docs.github.com/en/rest/reference/pulls#review-comments

The OpenAPI schema can be found at

  • /components/schemas/pull-request-review-comment

  • /components/schemas/review-comment

A CompletableGithubObject can be partially initialised (completed=False). Accessing attributes that are not initialized will then trigger a request to complete all attributes.

A partially initialized CompletableGithubObject (completed=False) can be completed via complete(). This requires the url to be given via parameter url or attributes.

With a requester where Requester.is_lazy == True, this CompletableGithubObjects is partially initialized. This requires the url to be given via parameter url or attributes. Any CompletableGithubObject created from this lazy object will be lazy itself if created with parameter url or attributes.

Parameters:

  • requester – requester

  • headers – response headers

  • attributes – attributes to initialize

  • completed – do not update non-initialized attributes when True

  • url – url of this instance, overrides attributes[‘url’]

  • accept – use this accept header when completing this instance

delete() → None
Calls:

DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}

Return type:

None

edit(body: str) → None
Calls:

PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}

Parameters:

body – string

Return type:

None

get_reactions() → PaginatedList[Reaction]
Calls:

GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions

Returns:

class:

github.PaginatedList.PaginatedList of github.Reaction.Reaction

create_reaction(reaction_type: str) → Reaction
Calls:

POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions

Parameters:

reaction_type – string

Return type:

github.Reaction.Reaction

delete_reaction(reaction_id: int) → bool
Calls:

DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}

Parameters:

reaction_id – integer

Return type:

bool