| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
| from __future__ import annotations |
|
|
| from datetime import datetime |
| from typing import TYPE_CHECKING, Any |
|
|
| import github.CheckRun |
| import github.GitCommit |
| import github.GithubApp |
| import github.PullRequest |
| import github.Repository |
| from github.GithubObject import Attribute, CompletableGithubObject, NotSet, Opt, is_defined, is_optional |
| from github.PaginatedList import PaginatedList |
|
|
| if TYPE_CHECKING: |
| from github.CheckRun import CheckRun |
| from github.GitCommit import GitCommit |
| from github.GithubApp import GithubApp |
| from github.PullRequest import PullRequest |
| from github.Repository import Repository |
|
|
|
|
| class CheckSuite(CompletableGithubObject): |
| """ |
| This class represents check suites. |
| |
| The reference can be found here |
| https://docs.github.com/en/rest/reference/checks#check-suites |
| |
| The OpenAPI schema can be found at |
| - /components/schemas/check-run/properties/check_suite |
| - /components/schemas/check-suite |
| |
| """ |
|
|
| def _initAttributes(self) -> None: |
| self._after: Attribute[str] = NotSet |
| self._app: Attribute[GithubApp] = NotSet |
| self._before: Attribute[str] = NotSet |
| self._check_runs_url: Attribute[str] = NotSet |
| self._conclusion: Attribute[str] = NotSet |
| self._created_at: Attribute[datetime] = NotSet |
| self._head_branch: Attribute[str] = NotSet |
| self._head_commit: Attribute[GitCommit] = NotSet |
| self._head_sha: Attribute[str] = NotSet |
| self._id: Attribute[int] = NotSet |
| self._latest_check_runs_count: Attribute[int] = NotSet |
| self._node_id: Attribute[str] = NotSet |
| self._pull_requests: Attribute[list[PullRequest]] = NotSet |
| self._repository: Attribute[Repository] = NotSet |
| self._rerequestable: Attribute[bool] = NotSet |
| self._runs_rerequestable: Attribute[bool] = NotSet |
| self._status: Attribute[str] = NotSet |
| self._updated_at: Attribute[datetime] = NotSet |
| self._url: Attribute[str] = NotSet |
|
|
| def __repr__(self) -> str: |
| return self.get__repr__({"id": self._id.value, "url": self._url.value}) |
|
|
| @property |
| def after(self) -> str: |
| """ |
| :type: string |
| """ |
| self._completeIfNotSet(self._after) |
| return self._after.value |
|
|
| @property |
| def app(self) -> GithubApp: |
| """ |
| :type: :class:`github.GithubApp.GithubApp` |
| """ |
| self._completeIfNotSet(self._app) |
| return self._app.value |
|
|
| @property |
| def before(self) -> str: |
| """ |
| :type: string |
| """ |
| self._completeIfNotSet(self._before) |
| return self._before.value |
|
|
| @property |
| def check_runs_url(self) -> str: |
| """ |
| :type: string |
| """ |
| self._completeIfNotSet(self._check_runs_url) |
| return self._check_runs_url.value |
|
|
| @property |
| def conclusion(self) -> str: |
| """ |
| :type: string |
| """ |
| self._completeIfNotSet(self._conclusion) |
| return self._conclusion.value |
|
|
| @property |
| def created_at(self) -> datetime: |
| """ |
| :type: datetime.datetime |
| """ |
| self._completeIfNotSet(self._created_at) |
| return self._created_at.value |
|
|
| @property |
| def head_branch(self) -> str: |
| """ |
| :type: string |
| """ |
| self._completeIfNotSet(self._head_branch) |
| return self._head_branch.value |
|
|
| @property |
| def head_commit(self) -> GitCommit: |
| """ |
| :type: :class:`github.GitCommit.GitCommit` |
| """ |
| self._completeIfNotSet(self._head_commit) |
| return self._head_commit.value |
|
|
| @property |
| def head_sha(self) -> str: |
| """ |
| :type: string |
| """ |
| self._completeIfNotSet(self._head_sha) |
| return self._head_sha.value |
|
|
| @property |
| def id(self) -> int: |
| """ |
| :type: int |
| """ |
| self._completeIfNotSet(self._id) |
| return self._id.value |
|
|
| @property |
| def latest_check_runs_count(self) -> int: |
| """ |
| :type: int |
| """ |
| self._completeIfNotSet(self._latest_check_runs_count) |
| return self._latest_check_runs_count.value |
|
|
| @property |
| def node_id(self) -> str: |
| self._completeIfNotSet(self._node_id) |
| return self._node_id.value |
|
|
| @property |
| def pull_requests(self) -> list[PullRequest]: |
| """ |
| :type: list of :class:`github.PullRequest.PullRequest` |
| """ |
| self._completeIfNotSet(self._pull_requests) |
| return self._pull_requests.value |
|
|
| @property |
| def repository(self) -> Repository: |
| """ |
| :type: :class:`github.Repository.Repository` |
| """ |
| self._completeIfNotSet(self._repository) |
| return self._repository.value |
|
|
| @property |
| def rerequestable(self) -> bool: |
| self._completeIfNotSet(self._rerequestable) |
| return self._rerequestable.value |
|
|
| @property |
| def runs_rerequestable(self) -> bool: |
| self._completeIfNotSet(self._runs_rerequestable) |
| return self._runs_rerequestable.value |
|
|
| @property |
| def status(self) -> str: |
| """ |
| :type: string |
| """ |
| self._completeIfNotSet(self._status) |
| return self._status.value |
|
|
| @property |
| def updated_at(self) -> datetime: |
| """ |
| :type: datetime.datetime |
| """ |
| self._completeIfNotSet(self._updated_at) |
| return self._updated_at.value |
|
|
| @property |
| def url(self) -> str: |
| """ |
| :type: string |
| """ |
| return self._url.value |
|
|
| def rerequest(self) -> bool: |
| """ |
| :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", f"{self.url}/rerequest", headers=request_headers) |
| return status == 201 |
|
|
| def get_check_runs( |
| self, |
| check_name: Opt[str] = NotSet, |
| status: Opt[str] = NotSet, |
| filter: Opt[str] = NotSet, |
| ) -> PaginatedList[CheckRun]: |
| """ |
| :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>`_ |
| """ |
| assert is_optional(check_name, str), check_name |
| assert is_optional(status, str), status |
| assert is_optional(filter, str), filter |
| url_parameters: dict[str, Any] = {} |
| if is_defined(check_name): |
| url_parameters["check_name"] = check_name |
| if is_defined(status): |
| url_parameters["status"] = status |
| if is_defined(filter): |
| url_parameters["filter"] = filter |
| return PaginatedList( |
| github.CheckRun.CheckRun, |
| self._requester, |
| f"{self.url}/check-runs", |
| url_parameters, |
| headers={"Accept": "application/vnd.github.v3+json"}, |
| list_item="check_runs", |
| ) |
|
|
| def _useAttributes(self, attributes: dict[str, Any]) -> None: |
| if "after" in attributes: |
| self._after = self._makeStringAttribute(attributes["after"]) |
| if "app" in attributes: |
| self._app = self._makeClassAttribute(github.GithubApp.GithubApp, attributes["app"]) |
| if "before" in attributes: |
| self._before = self._makeStringAttribute(attributes["before"]) |
| if "check_runs_url" in attributes: |
| self._check_runs_url = self._makeStringAttribute(attributes["check_runs_url"]) |
| if "conclusion" in attributes: |
| self._conclusion = self._makeStringAttribute(attributes["conclusion"]) |
| if "created_at" in attributes: |
| self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) |
| if "head_branch" in attributes: |
| self._head_branch = self._makeStringAttribute(attributes["head_branch"]) |
| if "head_commit" in attributes: |
| |
| |
| 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: |
| self._head_sha = self._makeStringAttribute(attributes["head_sha"]) |
| if "id" in attributes: |
| self._id = self._makeIntAttribute(attributes["id"]) |
| if "latest_check_runs_count" in attributes: |
| self._latest_check_runs_count = self._makeIntAttribute(attributes["latest_check_runs_count"]) |
| if "node_id" in attributes: |
| self._node_id = self._makeStringAttribute(attributes["node_id"]) |
| if "pull_requests" in attributes: |
| self._pull_requests = self._makeListOfClassesAttribute( |
| github.PullRequest.PullRequest, attributes["pull_requests"] |
| ) |
| if "repository" in attributes: |
| self._repository = self._makeClassAttribute(github.Repository.Repository, attributes["repository"]) |
| if "rerequestable" in attributes: |
| self._rerequestable = self._makeBoolAttribute(attributes["rerequestable"]) |
| if "runs_rerequestable" in attributes: |
| self._runs_rerequestable = self._makeBoolAttribute(attributes["runs_rerequestable"]) |
| if "status" in attributes: |
| self._status = self._makeStringAttribute(attributes["status"]) |
| if "updated_at" in attributes: |
| self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"]) |
| if "url" in attributes: |
| self._url = self._makeStringAttribute(attributes["url"]) |
|
|
