Issue¶
-
class
github.Issue.
Issue
¶ This class represents Issues. The reference can be found here https://docs.github.com/en/rest/reference/issues
-
assignee
¶ Type: github.NamedUser.NamedUser
-
assignees
¶ Type: list of github.NamedUser.NamedUser
-
body
¶ Type: string
-
closed_at
¶ Type: datetime.datetime
-
closed_by
¶ Type: github.NamedUser.NamedUser
-
comments
¶ Type: integer
-
comments_url
¶ Type: string
-
created_at
¶ Type: datetime.datetime
-
events_url
¶ Type: string
-
html_url
¶ Type: string
-
id
¶ Type: integer
-
labels
¶ Type: list of github.Label.Label
-
labels_url
¶ Type: string
-
milestone
¶ Type: github.Milestone.Milestone
-
number
¶ Type: integer
-
pull_request
¶ Type: github.IssuePullRequest.IssuePullRequest
-
repository
¶ Type: github.Repository.Repository
-
state
¶ Type: string
-
state_reason
¶ Type: string
-
title
¶ Type: string
-
updated_at
¶ Type: datetime.datetime
-
url
¶ Type: string
-
user
¶ Type: github.NamedUser.NamedUser
-
locked
¶ Type: bool
-
active_lock_reason
¶ Type: string
-
as_pull_request
()¶ Calls: GET /repos/{owner}/{repo}/pulls/{number} Return type: github.PullRequest.PullRequest
-
add_to_assignees
(*assignees)¶ Calls: POST /repos/{owner}/{repo}/issues/{number}/assignees Parameters: assignee – github.NamedUser.NamedUser
or stringReturn type: None
-
add_to_labels
(*labels)¶ Calls: POST /repos/{owner}/{repo}/issues/{number}/labels Parameters: label – github.Label.Label
or stringReturn type: None
-
create_comment
(body)¶ Calls: POST /repos/{owner}/{repo}/issues/{number}/comments Parameters: body – string Return type: github.IssueComment.IssueComment
-
delete_labels
()¶ Calls: DELETE /repos/{owner}/{repo}/issues/{number}/labels Return type: None
-
edit
(title=NotSet, body=NotSet, assignee=NotSet, state=NotSet, milestone=NotSet, labels=NotSet, assignees=NotSet, state_reason=NotSet)¶ Calls: Parameters: - title – string
- body – string
- assignee – string or
github.NamedUser.NamedUser
or None - state – string
- milestone –
github.Milestone.Milestone
or None - labels – list of string
- assignees – list of string or
github.NamedUser.NamedUser
- state_reason – string
Return type: None
-
lock
(lock_reason)¶ Calls: PUT /repos/{owner}/{repo}/issues/{issue_number}/lock Parameters: lock_reason – string Return type: None
-
unlock
()¶ Calls: DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock Return type: None
-
get_comment
(id)¶ Calls: GET /repos/{owner}/{repo}/issues/comments/{id} Parameters: id – integer Return type: github.IssueComment.IssueComment
-
get_comments
(since=NotSet)¶ Calls: GET /repos/{owner}/{repo}/issues/{number}/comments Parameters: since – datetime.datetime format YYYY-MM-DDTHH:MM:SSZ Return type: github.PaginatedList.PaginatedList
ofgithub.IssueComment.IssueComment
-
get_events
()¶ Calls: GET /repos/{owner}/{repo}/issues/{issue_number}/events Return type: github.PaginatedList.PaginatedList
ofgithub.IssueEvent.IssueEvent
-
get_labels
()¶ Calls: GET /repos/{owner}/{repo}/issues/{number}/labels Return type: github.PaginatedList.PaginatedList
ofgithub.Label.Label
-
remove_from_assignees
(*assignees)¶ Calls: DELETE /repos/{owner}/{repo}/issues/{number}/assignees Parameters: assignee – github.NamedUser.NamedUser
or stringReturn type: None
-
remove_from_labels
(label)¶ Calls: DELETE /repos/{owner}/{repo}/issues/{number}/labels/{name} Parameters: label – github.Label.Label
or stringReturn type: None
-
set_labels
(*labels)¶ Calls: PUT /repos/{owner}/{repo}/issues/{number}/labels Parameters: labels – list of github.Label.Label
or stringsReturn type: None
-
get_reactions
()¶ Calls: GET /repos/{owner}/{repo}/issues/{number}/reactions Returns: class: github.PaginatedList.PaginatedList
ofgithub.Reaction.Reaction
-
create_reaction
(reaction_type)¶ Calls: POST /repos/{owner}/{repo}/issues/{number}/reactions Parameters: reaction_type – string Return type: github.Reaction.Reaction
-
delete_reaction
(reaction_id)¶ Calls: DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id} Parameters: reaction_id – integer Return type: bool
-
get_timeline
()¶ Calls: GET /repos/{owner}/{repo}/issues/{number}/timeline Returns: class: github.PaginatedList.PaginatedList
ofgithub.TimelineEvent.TimelineEvent
-