mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
Add support for Check Suites (#1764)
* Add initial support for Check Suites * Add API call detail in CheckSuite.rerequest * Update Accept header with general instead of preview * Add 'get check runs' endpoint for CheckSuite with stubs * Add create check suite endpoint with stub * Update CheckSuite tests with creat check suite endpoint * Add update check suites preferences endpoint * Add repository preferences object and stub file * Add update check suite preferences tests Needed for #1621 Co-authored-by: Raju Subramanian <coder@mahesh.net>
This commit is contained in:
Dhruv Manilawala
co-authored by
Raju Subramanian
Raju Subramanian
parent
197e065372
commit
6d501b286e
@@ -0,0 +1,275 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
############################ Copyrights and license ############################
|
||||
# #
|
||||
# Copyright 2020 Raju Subramanian <coder@mahesh.net> #
|
||||
# #
|
||||
# This file is part of PyGithub. #
|
||||
# http://pygithub.readthedocs.io/ #
|
||||
# #
|
||||
# PyGithub is free software: you can redistribute it and/or modify it under #
|
||||
# the terms of the GNU Lesser General Public License as published by the Free #
|
||||
# Software Foundation, either version 3 of the License, or (at your option) #
|
||||
# any later version. #
|
||||
# #
|
||||
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
||||
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
||||
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
||||
# details. #
|
||||
# #
|
||||
# You should have received a copy of the GNU Lesser General Public License #
|
||||
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
||||
# #
|
||||
################################################################################
|
||||
|
||||
import github
|
||||
|
||||
|
||||
class CheckSuite(github.GithubObject.CompletableGithubObject):
|
||||
"""
|
||||
This class represents check suites. The reference can be found here https://docs.github.com/en/rest/reference/checks#check-suites
|
||||
"""
|
||||
|
||||
def __repr__(self):
|
||||
return self.get__repr__({"id": self._id.value, "url": self._url.value})
|
||||
|
||||
@property
|
||||
def after(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._after)
|
||||
return self._after.value
|
||||
|
||||
@property
|
||||
def app(self):
|
||||
"""
|
||||
:type: :class:`github.GithubApp.GithubApp`
|
||||
"""
|
||||
self._completeIfNotSet(self._app)
|
||||
return self._app.value
|
||||
|
||||
@property
|
||||
def before(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._before)
|
||||
return self._before.value
|
||||
|
||||
@property
|
||||
def check_runs_url(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._check_runs_url)
|
||||
return self._check_runs_url.value
|
||||
|
||||
@property
|
||||
def conclusion(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._conclusion)
|
||||
return self._conclusion.value
|
||||
|
||||
@property
|
||||
def created_at(self):
|
||||
"""
|
||||
:type: datetime.datetime
|
||||
"""
|
||||
self._completeIfNotSet(self._created_at)
|
||||
return self._created_at.value
|
||||
|
||||
@property
|
||||
def head_branch(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._head_branch)
|
||||
return self._head_branch.value
|
||||
|
||||
@property
|
||||
def head_commit(self):
|
||||
"""
|
||||
:type: :class:`github.GitCommit.GitCommit`
|
||||
"""
|
||||
self._completeIfNotSet(self._head_commit)
|
||||
return self._head_commit.value
|
||||
|
||||
@property
|
||||
def head_sha(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._head_sha)
|
||||
return self._head_sha.value
|
||||
|
||||
@property
|
||||
def id(self):
|
||||
"""
|
||||
:type: int
|
||||
"""
|
||||
self._completeIfNotSet(self._id)
|
||||
return self._id.value
|
||||
|
||||
@property
|
||||
def latest_check_runs_count(self):
|
||||
"""
|
||||
:type: int
|
||||
"""
|
||||
self._completeIfNotSet(self._latest_check_runs_count)
|
||||
return self._latest_check_runs_count.value
|
||||
|
||||
@property
|
||||
def pull_requests(self):
|
||||
"""
|
||||
:type: list of :class:`github.PullRequest.PullRequest`
|
||||
"""
|
||||
self._completeIfNotSet(self._pull_requests)
|
||||
return self._pull_requests.value
|
||||
|
||||
@property
|
||||
def repository(self):
|
||||
"""
|
||||
:type: :class:`github.Repository.Repository`
|
||||
"""
|
||||
self._completeIfNotSet(self._repository)
|
||||
return self._repository.value
|
||||
|
||||
@property
|
||||
def status(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._status)
|
||||
return self._status.value
|
||||
|
||||
@property
|
||||
def updated_at(self):
|
||||
"""
|
||||
:type: datetime.datetime
|
||||
"""
|
||||
self._completeIfNotSet(self._updated_at)
|
||||
return self._updated_at.value
|
||||
|
||||
@property
|
||||
def url(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
self._completeIfNotSet(self._url)
|
||||
return self._url.value
|
||||
|
||||
def rerequest(self):
|
||||
"""
|
||||
:calls: `POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest <https://docs.github.com/en/rest/reference/checks#rerequest-a-check-suite>`_
|
||||
:rtype: bool
|
||||
"""
|
||||
request_headers = {"Accept": "application/vnd.github.v3+json"}
|
||||
status, _, _ = self._requester.requestJson(
|
||||
"POST", self.url + "/rerequest", headers=request_headers
|
||||
)
|
||||
return status == 201
|
||||
|
||||
def get_check_runs(
|
||||
self,
|
||||
check_name=github.GithubObject.NotSet,
|
||||
status=github.GithubObject.NotSet,
|
||||
filter=github.GithubObject.NotSet,
|
||||
):
|
||||
"""
|
||||
:calls: `GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs <https://docs.github.com/en/rest/reference/checks#list-check-runs-in-a-check-suite>`_
|
||||
:param check_name: string
|
||||
:param status: string
|
||||
:param filter: string
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.CheckRun.CheckRun`
|
||||
"""
|
||||
assert check_name is github.GithubObject.NotSet or isinstance(
|
||||
check_name, str
|
||||
), check_name
|
||||
assert status is github.GithubObject.NotSet or isinstance(status, str), status
|
||||
assert filter is github.GithubObject.NotSet or isinstance(filter, str), filter
|
||||
url_parameters = dict()
|
||||
if check_name is not github.GithubObject.NotSet:
|
||||
url_parameters["check_name"] = check_name
|
||||
if status is not github.GithubObject.NotSet:
|
||||
url_parameters["status"] = status
|
||||
if status is not github.GithubObject.NotSet:
|
||||
url_parameters["filter"] = filter
|
||||
return github.PaginatedList.PaginatedList(
|
||||
github.CheckRun.CheckRun,
|
||||
self._requester,
|
||||
self.url + "/check-runs",
|
||||
url_parameters,
|
||||
headers={"Accept": "application/vnd.github.v3+json"},
|
||||
list_item="check_runs",
|
||||
)
|
||||
|
||||
def _initAttributes(self):
|
||||
self._after = github.GithubObject.NotSet
|
||||
self._app = github.GithubObject.NotSet
|
||||
self._before = github.GithubObject.NotSet
|
||||
self._check_runs_url = github.GithubObject.NotSet
|
||||
self._conclusion = github.GithubObject.NotSet
|
||||
self._created_at = github.GithubObject.NotSet
|
||||
self._head_branch = github.GithubObject.NotSet
|
||||
self._head_commit = github.GithubObject.NotSet
|
||||
self._head_sha = github.GithubObject.NotSet
|
||||
self._id = github.GithubObject.NotSet
|
||||
self._latest_check_runs_count = github.GithubObject.NotSet
|
||||
self._pull_requests = github.GithubObject.NotSet
|
||||
self._repository = github.GithubObject.NotSet
|
||||
self._status = github.GithubObject.NotSet
|
||||
self._updated_at = github.GithubObject.NotSet
|
||||
self._url = github.GithubObject.NotSet
|
||||
|
||||
def _useAttributes(self, attributes):
|
||||
if "after" in attributes: # pragma no branch
|
||||
self._after = self._makeStringAttribute(attributes["after"])
|
||||
if "app" in attributes: # pragma no branch
|
||||
self._app = self._makeClassAttribute(
|
||||
github.GithubApp.GithubApp, attributes["app"]
|
||||
)
|
||||
if "before" in attributes: # pragma no branch
|
||||
self._before = self._makeStringAttribute(attributes["before"])
|
||||
if "check_runs_url" in attributes: # pragma no branch
|
||||
self._check_runs_url = self._makeStringAttribute(
|
||||
attributes["check_runs_url"]
|
||||
)
|
||||
if "conclusion" in attributes: # pragma no branch
|
||||
self._conclusion = self._makeStringAttribute(attributes["conclusion"])
|
||||
if "created_at" in attributes: # pragma no branch
|
||||
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
|
||||
if "head_branch" in attributes: # pragma no branch
|
||||
self._head_branch = self._makeStringAttribute(attributes["head_branch"])
|
||||
if "head_commit" in attributes: # pragma no branch
|
||||
# This JSON swaps the 'sha' attribute for an 'id' attribute.
|
||||
# The GitCommit object only looks for 'sha'
|
||||
if "id" in attributes["head_commit"]:
|
||||
attributes["head_commit"]["sha"] = attributes["head_commit"]["id"]
|
||||
self._head_commit = self._makeClassAttribute(
|
||||
github.GitCommit.GitCommit, attributes["head_commit"]
|
||||
)
|
||||
if "head_sha" in attributes: # pragma no branch
|
||||
self._head_sha = self._makeStringAttribute(attributes["head_sha"])
|
||||
if "id" in attributes: # pragma no branch
|
||||
self._id = self._makeIntAttribute(attributes["id"])
|
||||
if "latest_check_runs_count" in attributes: # pragma no branch
|
||||
self._latest_check_runs_count = self._makeIntAttribute(
|
||||
attributes["latest_check_runs_count"]
|
||||
)
|
||||
if "pull_requests" in attributes: # pragma no branch
|
||||
self._pull_requests = self._makeListOfClassesAttribute(
|
||||
github.PullRequest.PullRequest, attributes["pull_requests"]
|
||||
)
|
||||
if "repository" in attributes: # pragma no branch
|
||||
self._repository = self._makeClassAttribute(
|
||||
github.Repository.Repository, attributes["repository"]
|
||||
)
|
||||
if "status" in attributes: # pragma no branch
|
||||
self._status = self._makeStringAttribute(attributes["status"])
|
||||
if "updated_at" in attributes: # pragma no branch
|
||||
self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])
|
||||
if "url" in attributes: # pragma no branch
|
||||
self._url = self._makeStringAttribute(attributes["url"])
|
||||
@@ -0,0 +1,51 @@
|
||||
from datetime import datetime
|
||||
from typing import Any, Dict, List
|
||||
|
||||
from github.CheckRun import CheckRun
|
||||
from github.GitCommit import GitCommit
|
||||
from github.GithubApp import GithubApp
|
||||
from github.GithubObject import CompletableGithubObject
|
||||
from github.PaginatedList import PaginatedList
|
||||
from github.PullRequest import PullRequest
|
||||
from github.Repository import Repository
|
||||
|
||||
class CheckSuite(CompletableGithubObject):
|
||||
def __repr__(self) -> str: ...
|
||||
def _initAttributes(self) -> None: ...
|
||||
def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
|
||||
@property
|
||||
def after(self) -> str: ...
|
||||
@property
|
||||
def app(self) -> GithubApp: ...
|
||||
@property
|
||||
def before(self) -> str: ...
|
||||
@property
|
||||
def check_runs_url(self) -> str: ...
|
||||
@property
|
||||
def conclusion(self) -> str: ...
|
||||
@property
|
||||
def created_at(self) -> datetime: ...
|
||||
@property
|
||||
def head_branch(self) -> str: ...
|
||||
@property
|
||||
def head_commit(self) -> GitCommit: ...
|
||||
@property
|
||||
def head_sha(self) -> str: ...
|
||||
@property
|
||||
def id(self) -> int: ...
|
||||
@property
|
||||
def latest_check_runs_count(self) -> int: ...
|
||||
@property
|
||||
def pull_requests(self) -> List[PullRequest]: ...
|
||||
@property
|
||||
def repository(self) -> Repository: ...
|
||||
@property
|
||||
def status(self) -> str: ...
|
||||
@property
|
||||
def updated_at(self) -> datetime: ...
|
||||
@property
|
||||
def url(self) -> str: ...
|
||||
def rerequest(self) -> bool: ...
|
||||
def get_check_runs(
|
||||
self, check_name: str, status: str, filter: str
|
||||
) -> PaginatedList[CheckRun]: ...
|
||||
@@ -33,6 +33,7 @@
|
||||
################################################################################
|
||||
|
||||
import github.CheckRun
|
||||
import github.CheckSuite
|
||||
import github.CommitCombinedStatus
|
||||
import github.CommitComment
|
||||
import github.CommitStats
|
||||
@@ -293,6 +294,34 @@ class Commit(github.GithubObject.CompletableGithubObject):
|
||||
list_item="check_runs",
|
||||
)
|
||||
|
||||
def get_check_suites(
|
||||
self, app_id=github.GithubObject.NotSet, check_name=github.GithubObject.NotSet
|
||||
):
|
||||
"""
|
||||
:class: `GET /repos/:owner/:repo/commits/:ref/check-suites <https://docs.github.com/en/rest/reference/checks#list-check-suites-for-a-git-reference>`_
|
||||
:param app_id: int
|
||||
:param check_name: string
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.CheckSuite.CheckSuite`
|
||||
"""
|
||||
assert app_id is github.GithubObject.NotSet or isinstance(app_id, int), app_id
|
||||
assert check_name is github.GithubObject.NotSet or isinstance(
|
||||
check_name, str
|
||||
), check_name
|
||||
parameters = dict()
|
||||
if app_id is not github.GithubObject.NotSet:
|
||||
parameters["app_id"] = app_id
|
||||
if check_name is not github.GithubObject.NotSet:
|
||||
parameters["check_name"] = check_name
|
||||
request_headers = {"Accept": "application/vnd.github.v3+json"}
|
||||
return github.PaginatedList.PaginatedList(
|
||||
github.CheckSuite.CheckSuite,
|
||||
self._requester,
|
||||
self.url + "/check-suites",
|
||||
parameters,
|
||||
headers=request_headers,
|
||||
list_item="check_suites",
|
||||
)
|
||||
|
||||
@property
|
||||
def _identity(self):
|
||||
return self.sha
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
from typing import Any, Dict, List, Union
|
||||
|
||||
from github.CheckRun import CheckRun
|
||||
from github.CheckSuite import CheckSuite
|
||||
from github.CommitCombinedStatus import CommitCombinedStatus
|
||||
from github.CommitComment import CommitComment
|
||||
from github.CommitStats import CommitStats
|
||||
@@ -41,6 +42,11 @@ class Commit(CompletableGithubObject):
|
||||
) -> CommitStatus: ...
|
||||
@property
|
||||
def files(self) -> List[File]: ...
|
||||
def get_check_suites(
|
||||
self,
|
||||
app_id: Union[_NotSetType, int],
|
||||
check_name: Union[_NotSetType, str],
|
||||
) -> PaginatedList[CheckSuite]: ...
|
||||
def get_combined_status(self) -> CommitCombinedStatus: ...
|
||||
def get_comments(self) -> PaginatedList[CommitComment]: ...
|
||||
def get_statuses(self) -> PaginatedList[CommitStatus]: ...
|
||||
|
||||
@@ -95,6 +95,7 @@ from deprecated import deprecated
|
||||
|
||||
import github.Branch
|
||||
import github.CheckRun
|
||||
import github.CheckSuite
|
||||
import github.Clones
|
||||
import github.Commit
|
||||
import github.CommitComment
|
||||
@@ -127,6 +128,7 @@ import github.PullRequest
|
||||
import github.Referrer
|
||||
import github.Repository
|
||||
import github.RepositoryKey
|
||||
import github.RepositoryPreferences
|
||||
import github.SelfHostedActionsRunner
|
||||
import github.SourceImport
|
||||
import github.Stargazer
|
||||
@@ -3444,6 +3446,57 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
"""
|
||||
return self._hub("unsubscribe", event, callback, github.GithubObject.NotSet)
|
||||
|
||||
def create_check_suite(self, head_sha):
|
||||
"""
|
||||
:calls: `POST /repos/:owner/:repo/check-suites <https://docs.github.com/en/rest/reference/checks#create-a-check-suite>`_
|
||||
:param head_sha: string
|
||||
:rtype: :class:`github.CheckSuite.CheckSuite`
|
||||
"""
|
||||
assert isinstance(head_sha, str), head_sha
|
||||
headers, data = self._requester.requestJsonAndCheck(
|
||||
"POST",
|
||||
self.url + "/check-suites",
|
||||
input={"head_sha": head_sha},
|
||||
)
|
||||
return github.CheckSuite.CheckSuite(
|
||||
self._requester, headers, data, completed=True
|
||||
)
|
||||
|
||||
def get_check_suite(self, check_suite_id):
|
||||
"""
|
||||
:calls: `GET /repos/:owner/:repo/check-suites/:check_suite_id <https://docs.github.com/en/rest/reference/checks#get-a-check-suite>`_
|
||||
:param check_suite_id: int
|
||||
:rtype: :class:`github.CheckSuite.CheckSuite`
|
||||
"""
|
||||
assert isinstance(check_suite_id, int), check_suite_id
|
||||
requestHeaders = {"Accept": "application/vnd.github.v3+json"}
|
||||
headers, data = self._requester.requestJsonAndCheck(
|
||||
"GET",
|
||||
self.url + "/check-suites/" + str(check_suite_id),
|
||||
headers=requestHeaders,
|
||||
)
|
||||
return github.CheckSuite.CheckSuite(
|
||||
self._requester, headers, data, completed=True
|
||||
)
|
||||
|
||||
def update_check_suites_preferences(self, auto_trigger_checks):
|
||||
"""
|
||||
:calls: `PATCH /repos/:owner/:repo/check-suites/preferences <https://docs.github.com/en/rest/reference/checks#update-repository-preferences-for-check-suites>`_
|
||||
:param auto_trigger_checks: list of dict
|
||||
:rtype: :class:`github.RepositoryPreferences.RepositoryPreferences`
|
||||
"""
|
||||
assert all(
|
||||
isinstance(element, dict) for element in auto_trigger_checks
|
||||
), auto_trigger_checks
|
||||
headers, data = self._requester.requestJsonAndCheck(
|
||||
"PATCH",
|
||||
self.url + "/check-suites/preferences",
|
||||
input={"auto_trigger_checks": auto_trigger_checks},
|
||||
)
|
||||
return github.RepositoryPreferences.RepositoryPreferences(
|
||||
self._requester, headers, data, completed=True
|
||||
)
|
||||
|
||||
def _hub(self, mode, event, callback, secret):
|
||||
assert isinstance(mode, str), mode
|
||||
assert isinstance(event, str), event
|
||||
|
||||
+33
-5
@@ -4,6 +4,7 @@ from typing import Any, Dict, List, Optional, Union, overload
|
||||
from github.AuthenticatedUser import AuthenticatedUser
|
||||
from github.Branch import Branch
|
||||
from github.CheckRun import CheckRun
|
||||
from github.CheckSuite import CheckSuite
|
||||
from github.Clones import Clones
|
||||
from github.Commit import Commit
|
||||
from github.CommitComment import CommitComment
|
||||
@@ -40,6 +41,7 @@ from github.PullRequest import PullRequest
|
||||
from github.PullRequestComment import PullRequestComment
|
||||
from github.Referrer import Referrer
|
||||
from github.RepositoryKey import RepositoryKey
|
||||
from github.RepositoryPreferences import RepositoryPreferences
|
||||
from github.SelfHostedActionsRunner import SelfHostedActionsRunner
|
||||
from github.SourceImport import SourceImport
|
||||
from github.Stargazer import Stargazer
|
||||
@@ -110,9 +112,12 @@ class Repository(CompletableGithubObject):
|
||||
started_at: Union[_NotSetType, datetime] = ...,
|
||||
conclusion: Union[_NotSetType, str] = ...,
|
||||
completed_at: Union[_NotSetType, datetime] = ...,
|
||||
output: Union[_NotSetType, Dict[str, Union[str, List[Dict[str, Union[str, int]]]]]] = ...,
|
||||
output: Union[
|
||||
_NotSetType, Dict[str, Union[str, List[Dict[str, Union[str, int]]]]]
|
||||
] = ...,
|
||||
actions: Union[_NotSetType, List[Dict[str, str]]] = ...,
|
||||
) -> CheckRun: ...
|
||||
def create_check_suite(self, head_sha: str) -> CheckSuite: ...
|
||||
def create_deployment(
|
||||
self,
|
||||
ref: str,
|
||||
@@ -209,9 +214,26 @@ class Repository(CompletableGithubObject):
|
||||
) -> Milestone: ...
|
||||
def create_project(self, name: str, body: str = ...) -> Project: ...
|
||||
@overload
|
||||
def create_pull(self, title: str, body: str, base: str, head: str, maintainer_can_modify: Union[bool, _NotSetType] = _NotSetType(), draft: bool = False, issue: _NotSetType = _NotSetType()) -> PullRequest: ...
|
||||
def create_pull(
|
||||
self,
|
||||
title: str,
|
||||
body: str,
|
||||
base: str,
|
||||
head: str,
|
||||
maintainer_can_modify: Union[bool, _NotSetType] = _NotSetType(),
|
||||
draft: bool = False,
|
||||
issue: _NotSetType = _NotSetType(),
|
||||
) -> PullRequest: ...
|
||||
@overload
|
||||
def create_pull(self, title: _NotSetType, body: _NotSetType, base: str, head: str, maintainer_can_modify: _NotSetType, issue: Issue) -> PullRequest: ...
|
||||
def create_pull(
|
||||
self,
|
||||
title: _NotSetType,
|
||||
body: _NotSetType,
|
||||
base: str,
|
||||
head: str,
|
||||
maintainer_can_modify: _NotSetType,
|
||||
issue: Issue,
|
||||
) -> PullRequest: ...
|
||||
def create_repository_dispatch(
|
||||
self, event_type: str, client_payload: Dict[str, Any]
|
||||
) -> bool: ...
|
||||
@@ -282,6 +304,7 @@ class Repository(CompletableGithubObject):
|
||||
def get_branch(self, branch: str) -> Branch: ...
|
||||
def get_branches(self) -> PaginatedList[Branch]: ...
|
||||
def get_check_run(self, check_run_id: int) -> CheckRun: ...
|
||||
def get_check_suite(self, check_suite_id: int) -> CheckSuite: ...
|
||||
def get_clones_traffic(
|
||||
self, per: Union[str, _NotSetType] = ...
|
||||
) -> Dict[str, Union[int, List[Clones]]]: ...
|
||||
@@ -408,7 +431,7 @@ class Repository(CompletableGithubObject):
|
||||
def get_release(self, id: Union[int, str]) -> GitRelease: ...
|
||||
def get_release_asset(self, id: int) -> GitReleaseAsset: ...
|
||||
def get_releases(self) -> PaginatedList[GitRelease]: ...
|
||||
def get_self_hosted_runner(self, runner_id: int) -> SelfHostedActionsRunner: ...
|
||||
def get_self_hosted_runner(self, runner_id: int) -> SelfHostedActionsRunner: ...
|
||||
def get_self_hosted_runners(self) -> PaginatedList[SelfHostedActionsRunner]: ...
|
||||
def get_source_import(self) -> SourceImport: ...
|
||||
def get_stargazers(self) -> PaginatedList[NamedUser]: ...
|
||||
@@ -433,6 +456,9 @@ class Repository(CompletableGithubObject):
|
||||
def get_workflows(self) -> PaginatedList[Workflow]: ...
|
||||
def get_workflow_run(self, id_: int) -> WorkflowRun: ...
|
||||
def get_workflow_runs(self) -> PaginatedList[WorkflowRun]: ...
|
||||
def update_check_suites_preferences(
|
||||
self, auto_trigger_checks: List[Dict[str, Union[bool, int]]]
|
||||
) -> RepositoryPreferences: ...
|
||||
@property
|
||||
def git_commits_url(self) -> str: ...
|
||||
@property
|
||||
@@ -517,7 +543,9 @@ class Repository(CompletableGithubObject):
|
||||
def remove_from_collaborators(
|
||||
self, collaborator: Union[str, NamedUser]
|
||||
) -> None: ...
|
||||
def remove_self_hosted_runner(self, runner: Union[SelfHostedActionsRunner, int]) -> bool: ...
|
||||
def remove_self_hosted_runner(
|
||||
self, runner: Union[SelfHostedActionsRunner, int]
|
||||
) -> bool: ...
|
||||
def remove_invitation(self, invite_id: int) -> None: ...
|
||||
def replace_topics(self, topics: List[str]) -> None: ...
|
||||
@property
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
############################ Copyrights and license ############################
|
||||
# #
|
||||
# Copyright 2020 Dhruv Manilawala <dhruvmanila@gmail.com> #
|
||||
# #
|
||||
# This file is part of PyGithub. #
|
||||
# http://pygithub.readthedocs.io/ #
|
||||
# #
|
||||
# PyGithub is free software: you can redistribute it and/or modify it under #
|
||||
# the terms of the GNU Lesser General Public License as published by the Free #
|
||||
# Software Foundation, either version 3 of the License, or (at your option) #
|
||||
# any later version. #
|
||||
# #
|
||||
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
||||
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
||||
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
||||
# details. #
|
||||
# #
|
||||
# You should have received a copy of the GNU Lesser General Public License #
|
||||
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
||||
# #
|
||||
################################################################################
|
||||
|
||||
import github.GithubObject
|
||||
import github.Repository
|
||||
|
||||
|
||||
class RepositoryPreferences(github.GithubObject.NonCompletableGithubObject):
|
||||
"""
|
||||
This class represents repository preferences.
|
||||
The reference can be found here https://docs.github.com/en/free-pro-team@latest/rest/reference/checks#update-repository-preferences-for-check-suites
|
||||
"""
|
||||
|
||||
@property
|
||||
def preferences(self):
|
||||
"""
|
||||
:type: dict
|
||||
"""
|
||||
return self._preferences.value
|
||||
|
||||
@property
|
||||
def repository(self):
|
||||
"""
|
||||
:type: :class:`github.Repository.Repository`
|
||||
"""
|
||||
return self._repository.value
|
||||
|
||||
def _initAttributes(self):
|
||||
self._preferences = github.GithubObject.NotSet
|
||||
self._repository = github.GithubObject.NotSet
|
||||
|
||||
def _useAttributes(self, attributes):
|
||||
if "preferences" in attributes: # pragma no branch
|
||||
self._preferences = self._makeDictAttribute(attributes["preferences"])
|
||||
if "repository" in attributes: # pragma no branch
|
||||
self._repository = self._makeClassAttribute(
|
||||
github.Repository.Repository, attributes["repository"]
|
||||
)
|
||||
@@ -0,0 +1,12 @@
|
||||
from typing import Any, Dict, List, Union
|
||||
|
||||
from github.GithubObject import NonCompletableGithubObject
|
||||
from github.Repository import Repository
|
||||
|
||||
class RepositoryPreferences(NonCompletableGithubObject):
|
||||
def _initAttributes(self) -> None: ...
|
||||
def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
|
||||
@property
|
||||
def preferences(self) -> Dict[str, List[Dict[str, Union[bool, int]]]]: ...
|
||||
@property
|
||||
def repository(self) -> Repository: ...
|
||||
Reference in New Issue
Block a user