Issue

class github.Issue.Issue

This class represents Issues.

The reference can be found here https://docs.github.com/en/rest/reference/issues

The OpenAPI schema can be found at

/components/schemas/issue
/components/schemas/nullable-issue

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

as_pull_request() → PullRequest

Calls:: GET /repos/{owner}/{repo}/pulls/{pull_number}

add_to_assignees(*assignees: NamedUser | str) → None

Calls:: POST /repos/{owner}/{repo}/issues/{issue_number}/assignees

add_to_labels(*labels: Label | str) → None

Calls:: POST /repos/{owner}/{repo}/issues/{issue_number}/labels

create_comment(body: str) → IssueComment

Calls:: POST /repos/{owner}/{repo}/issues/{issue_number}/comments

delete_labels() → None

Calls:: DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels

edit(title: Opt[str] = NotSet, body: Opt[str] = NotSet, assignee: Opt[str | NamedUser | None] = NotSet, state: Opt[str] = NotSet, milestone: Opt[Milestone | None] = NotSet, labels: Opt[list[str]] = NotSet, assignees: Opt[list[NamedUser | str]] = NotSet, state_reason: Opt[str] = NotSet) → None

Calls:

PATCH /repos/{owner}/{repo}/issues/{issue_number}

Parameters:

assignee – deprecated, use assignees instead. assignee=None means to remove current assignee.
milestone – milestone=None means to remove current milestone.

lock(lock_reason: str) → None

Calls:: PUT /repos/{owner}/{repo}/issues/{issue_number}/lock

unlock() → None

Calls:: DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock

get_comment(id: int) → IssueComment

Calls:: GET /repos/{owner}/{repo}/issues/comments/{comment_id}

get_comments(since: Opt[datetime] = NotSet) → PaginatedList[IssueComment]

Calls:: GET /repos/{owner}/{repo}/issues/{issue_number}/comments

get_events() → PaginatedList[IssueEvent]

Calls:: GET /repos/{owner}/{repo}/issues/{issue_number}/events

get_labels() → PaginatedList[Label]

Calls:: GET /repos/{owner}/{repo}/issues/{issue_number}/labels

remove_from_assignees(*assignees: NamedUser | str) → None

Calls:: DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees

remove_from_labels(label: Label | str) → None

Calls:: DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}

set_labels(*labels: Label | str) → None

Calls:: PUT /repos/{owner}/{repo}/issues/{issue_number}/labels

get_reactions() → PaginatedList[Reaction]

Calls:: GET /repos/{owner}/{repo}/issues/{issue_number}/reactions

get_sub_issues() → PaginatedList[SubIssue]

Calls:: GET /repos/{owner}/{repo}/issues/{issue_number}/sub_issues
Return type:: github.PaginatedList.PaginatedList of github.Issue.Issue

add_sub_issue(sub_issue: int | Issue) → SubIssue

Calls:: POST /repos/{owner}/{repo}/issues/{issue_number}/sub_issues
Parameters:: sub_issue – int (sub-issue ID) or Issue object. Note: Use sub_issue.id, not sub_issue.number
Return type:: github.Issue.SubIssue

remove_sub_issue(sub_issue: int | Issue) → SubIssue

Calls:: DELETE /repos/{owner}/{repo}/issues/{issue_number}/sub_issue
Parameters:: sub_issue – int (sub-issue ID) or Issue object. Note: Use sub_issue.id, not sub_issue.number
Return type:: github.Issue.SubIssue

prioritize_sub_issue(sub_issue: int | Issue, after_sub_issue: int | Issue | None) → SubIssue

Calls:

PATCH /repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority

Parameters:

sub_issue – int (sub-issue ID) or Issue object. Note: Use sub_issue.id, not sub_issue.number
after_sub_issue – int (sub-issue ID) or Issue object. Note: Use sub_issue.id, not sub_issue.number

Return type: