status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-08-31 19:01:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support for Workflow Runs (#1583)

Browse Source 
To build on the previous work supporting querying Workflows for GitHub
Actions, add a class and relevant methods to support querying runs of a
workflow.
This commit is contained in:
Steve Kowalik
2020-06-26 20:47:42 +10:00
committed by GitHub
parent 4ed7aaf8e5
commit 4fb1d23f4d
18 changed files with 784 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
github/Repository.py
+31
View File
@@ -136,6 +136,7 @@ import github.Tag
import github.Team
import github.View
import github.Workflow
import github.WorkflowRun
from . import Consts
@@ -3007,9 +3008,24 @@ class Repository(github.GithubObject.CompletableGithubObject):
list_item="workflows",
)
def get_workflow_runs(self):
"""
:calls: `GET /repos/:owner/:repo/actions/runs <https://developer.github.com/v3/actions/workflow-runs>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.WorkflowRun.WorkflowRun`
"""
return github.PaginatedList.PaginatedList(
github.WorkflowRun.WorkflowRun,
self._requester,
self.url + "/actions/runs",
None,
list_item="workflow_runs",
)
def get_workflow(self, id_or_name):
"""
:calls: `GET /repos/:owner/:repo/actions/workflows/:workflow_id <https://developer.github.com/v3/actions/workflows>`_
:param id_or_name: int or string
:rtype: :class:`github.Workflow.Workflow`
"""
assert isinstance(id_or_name, int) or isinstance(id_or_name, str), id_or_name
@@ -3018,6 +3034,21 @@ class Repository(github.GithubObject.CompletableGithubObject):
)
return github.Workflow.Workflow(self._requester, headers, data, completed=True)
def get_workflow_run(self, id_):
"""
:calls: `GET /repos/:owner/:repo/actions/runs/:run_id <https://developer.github.com/v3/actions/workflow-runs>`_
:param id_: int
:rtype: :class:`github.WorkflowRun.WorkflowRun`
"""
assert isinstance(id_, int)
headers, data = self._requester.requestJsonAndCheck(
"GET", self.url + "/actions/runs/" + str(id_)
)
return github.WorkflowRun.WorkflowRun(
self._requester, headers, data, completed=True
)
def has_in_assignees(self, assignee):
"""
:calls: `GET /repos/:owner/:repo/assignees/:assignee <http://developer.github.com/v3/issues/assignees>`_
github/Repository.pyi
+3
View File
@@ -49,6 +49,7 @@ from github.Tag import Tag
from github.Team import Team
from github.View import View
from github.Workflow import Workflow
from github.WorkflowRun import WorkflowRun
class Repository(CompletableGithubObject):
def __repr__(self) -> str: ...
@@ -387,6 +388,8 @@ class Repository(CompletableGithubObject):
def get_watchers(self) -> PaginatedList[NamedUser]: ...
def get_workflow(self, id_or_name: Union[str, int]) -> Workflow: ...
def get_workflows(self) -> PaginatedList[Workflow]: ...
def get_workflow_run(self, id_: int) -> WorkflowRun: ...
def get_workflow_runs(self) -> PaginatedList[WorkflowRun]: ...
@property
def git_commits_url(self) -> str: ...
@property
github/Workflow.py
+52
View File
@@ -23,6 +23,7 @@
################################################################################
import github.GithubObject
import github.WorkflowRun
class Workflow(github.GithubObject.CompletableGithubObject):
@@ -105,6 +106,57 @@ class Workflow(github.GithubObject.CompletableGithubObject):
self._completeIfNotSet(self._badge_url)
return self._badge_url.value
def get_runs(
self,
actor=github.GithubObject.NotSet,
branch=github.GithubObject.NotSet,
event=github.GithubObject.NotSet,
status=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs <https://developer.github.com/v3/actions/workflow-runs>`_
:param actor: :class:`github.NamedUser.NamedUser` or string
:param branch: :class:`github.Branch.Branch` or string
:param event: string
:param status: string
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.WorkflowRun.WorkflowRun`
"""
assert (
actor is github.GithubObject.NotSet
or isinstance(actor, github.NamedUser.NamedUser)
or isinstance(actor, str)
), actor
assert (
branch is github.GithubObject.NotSet
or isinstance(branch, github.Branch.Branch)
or isinstance(branch, str)
), branch
assert event is github.GithubObject.NotSet or isinstance(event, str), event
assert status is github.GithubObject.NotSet or isinstance(status, str), status
url_parameters = dict()
if actor is not github.GithubObject.NotSet:
url_parameters["actor"] = (
actor._identity
if isinstance(actor, github.NamedUser.NamedUser)
else actor
)
if branch is not github.GithubObject.NotSet:
url_parameters["branch"] = (
branch.name if isinstance(branch, github.Branch.Branch) else branch
)
if event is not github.GithubObject.NotSet:
url_parameters["event"] = event
if status is not github.GithubObject.NotSet:
url_parameters["status"] = status
return github.PaginatedList.PaginatedList(
github.WorkflowRun.WorkflowRun,
self._requester,
self.url + "/runs",
url_parameters,
None,
list_item="workflow_runs",
)
def _initAttributes(self):
self._id = github.GithubObject.NotSet
self._name = github.GithubObject.NotSet
github/Workflow.pyi
+13 -2
View File
@@ -1,12 +1,23 @@
from datetime import datetime
from typing import Any, Dict
from typing import Any, Dict, Union
from github.GithubObject import CompletableGithubObject
from github.Branch import Branch
from github.GithubObject import CompletableGithubObject, _NotSetType
from github.NamedUser import NamedUser
from github.PaginatedList import PaginatedList
from github.WorkflowRun import WorkflowRun
class Workflow(CompletableGithubObject):
def __repr__(self) -> str: ...
def _initAttributes(self) -> None: ...
def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
def get_runs(
self,
actor: Union[str, NamedUser, _NotSetType],
branch: Union[str, Branch, _NotSetType],
event: Union[str, _NotSetType],
status: Union[str, _NotSetType]
) -> PaginatedList[WorkflowRun]: ...
@property
def id(self) -> int: ...
@property
github/WorkflowRun.py
+318
View File
@@ -0,0 +1,318 @@
# -*- coding: utf-8 -*-
############################ Copyrights and license ############################
# #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
# #
# 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/>. #
# #
################################################################################
from collections import namedtuple
import github.GithubObject
import github.PullRequest
class WorkflowRun(github.GithubObject.CompletableGithubObject):
"""
This class represents Workflow Runs. The reference can be found here https://developer.github.com/v3/actions/workflow-runs/
"""
def __repr__(self):
return self.get__repr__({"id": self._id.value, "url": self._url.value})
@property
def id(self):
"""
:type: int
"""
self._completeIfNotSet(self._id)
return self._id.value
@property
def head_branch(self):
"""
:type: string
"""
self._completeIfNotSet(self._head_branch)
return self._head_branch.value
@property
def head_sha(self):
"""
:type: string
"""
self._completeIfNotSet(self._head_sha)
return self._head_sha.value
@property
def run_number(self):
"""
:type: int
"""
self._completeIfNotSet(self._run_number)
return self._run_number.value
@property
def event(self):
"""
:type: string
"""
self._completeIfNotSet(self._event)
return self._event.value
@property
def status(self):
"""
:type: string
"""
self._completeIfNotSet(self._status)
return self._status.value
@property
def conclusion(self):
"""
:type: string
"""
self._completeIfNotSet(self._conclusion)
return self._conclusion.value
@property
def url(self):
"""
:type: string
"""
self._completeIfNotSet(self._url)
return self._url.value
@property
def html_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._html_url)
return self._html_url.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 created_at(self):
"""
:type: datetime.datetime
"""
self._completeIfNotSet(self._created_at)
return self._created_at.value
@property
def updated_at(self):
"""
:type: datetime.datetime
"""
self._completeIfNotSet(self._updated_at)
return self._updated_at.value
@property
def jobs_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._jobs_url)
return self._jobs_url.value
@property
def logs_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._logs_url)
return self._logs_url.value
@property
def check_suite_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._check_suite_url)
return self._check_suite_url.value
@property
def artifacts_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._artifacts_url)
return self._artifacts_url.value
@property
def cancel_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._cancel_url)
return self._cancel_url.value
@property
def rerun_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._rerun_url)
return self._rerun_url.value
@property
def workflow_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._workflow_url)
return self._workflow_url.value
@property
def head_commit(self):
"""
:type: :class:`github.GitCommit.GitCommit`
"""
self._completeIfNotSet(self._head_commit)
return self._head_commit.value
@property
def repository(self):
"""
:type: :class:`github.Repository.Repository`
"""
self._completeIfNotSet(self._repository)
return self._repository.value
@property
def head_repository(self):
"""
:type: :class:`github.Repository.Repository`
"""
self._completeIfNotSet(self._head_repository)
return self._head_repository.value
def cancel(self):
"""
:calls: `POST /repos/:owner/:repo/actions/runs/:run_id/cancel <https://developer.github.com/v3/actions/workflow-runs/>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson("POST", self.cancel_url)
return status == 202
def rerun(self):
"""
:calls: `POST /repos/:owner/:repo/actions/runs/:run_id/rerun <https://developer.github.com/v3/actions/workflow-runs/>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson("POST", self.rerun_url)
return status == 201
def timing(self):
"""
:calls: `GET /repos/:owner/:repo/actions/runs/:run_id/timing <https://developer.github.com/v3/actions/workflow-runs/>`_
:rtype: namedtuple with billable and run_duration_ms members
"""
timingdata = namedtuple("TimingData", ["billable", "run_duration_ms"])
headers, data = self._requester.requestJsonAndCheck("GET", self.url + "/timing")
return timingdata._make(data.values())
def _initAttributes(self):
self._id = github.GithubObject.NotSet
self._head_branch = github.GithubObject.NotSet
self._head_sha = github.GithubObject.NotSet
self._run_number = github.GithubObject.NotSet
self._event = github.GithubObject.NotSet
self._status = github.GithubObject.NotSet
self._conclusion = github.GithubObject.NotSet
self._url = github.GithubObject.NotSet
self._html_url = github.GithubObject.NotSet
self._pull_requests = github.GithubObject.NotSet
self._created_at = github.GithubObject.NotSet
self._updated_at = github.GithubObject.NotSet
self._jobs_url = github.GithubObject.NotSet
self._logs_url = github.GithubObject.NotSet
self._check_suite_url = github.GithubObject.NotSet
self._artifacts_url = github.GithubObject.NotSet
self._cancel_url = github.GithubObject.NotSet
self._rerun_url = github.GithubObject.NotSet
self._workflow_url = github.GithubObject.NotSet
self._head_commit = github.GithubObject.NotSet
self._repository = github.GithubObject.NotSet
self._head_repository = github.GithubObject.NotSet
def _useAttributes(self, attributes):
if "id" in attributes: # pragma no branch
self._id = self._makeIntAttribute(attributes["id"])
if "head_branch" in attributes: # pragma no branch
self._head_branch = self._makeStringAttribute(attributes["head_branch"])
if "head_sha" in attributes: # pragma no branch
self._head_sha = self._makeStringAttribute(attributes["head_sha"])
if "run_number" in attributes: # pragma no branch
self._run_number = self._makeIntAttribute(attributes["run_number"])
if "event" in attributes: # pragma no branch
self._event = self._makeStringAttribute(attributes["event"])
if "status" in attributes: # pragma no branch
self._status = self._makeStringAttribute(attributes["status"])
if "conclusion" in attributes: # pragma no branch
self._conclusion = self._makeStringAttribute(attributes["conclusion"])
if "url" in attributes: # pragma no branch
self._url = self._makeStringAttribute(attributes["url"])
if "html_url" in attributes: # pragma no branch
self._html_url = self._makeStringAttribute(attributes["html_url"])
if "pull_requests" in attributes: # pragma no branch
self._pull_requests = self._makeListOfClassesAttribute(
github.PullRequest.PullRequest, attributes["pull_requests"]
)
if "created_at" in attributes: # pragma no branch
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
if "updated_at" in attributes: # pragma no branch
self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])
if "jobs_url" in attributes: # pragma no branch
self._jobs_url = self._makeStringAttribute(attributes["jobs_url"])
if "logs_url" in attributes: # pragma no branch
self._logs_url = self._makeStringAttribute(attributes["logs_url"])
if "check_suite_url" in attributes: # pragma no branch
self._check_suite_url = self._makeStringAttribute(
attributes["check_suite_url"]
)
if "artifacts_url" in attributes: # pragma no branch
self._artifacts_url = self._makeStringAttribute(attributes["artifacts_url"])
if "cancel_url" in attributes: # pragma no branch
self._cancel_url = self._makeStringAttribute(attributes["cancel_url"])
if "rerun_url" in attributes: # pragma no branch
self._rerun_url = self._makeStringAttribute(attributes["rerun_url"])
if "workflow_url" in attributes: # pragma no branch
self._workflow_url = self._makeStringAttribute(attributes["workflow_url"])
if "head_commit" in attributes: # pragma no branch
self._head_commit = self._makeClassAttribute(
github.GitCommit.GitCommit, attributes["head_commit"]
)
if "repository" in attributes: # pragma no branch
self._repository = self._makeClassAttribute(
github.Repository.Repository, attributes["repository"]
)
if "head_repository" in attributes: # pragma no branch
self._head_repository = self._makeClassAttribute(
github.Repository.Repository, attributes["head_repository"]
)
github/WorkflowRun.pyi
+63
View File
@@ -0,0 +1,63 @@
from datetime import datetime
from typing import Any, Dict, NamedTuple, List
from github.GitCommit import GitCommit
from github.GithubObject import CompletableGithubObject
from github.PullRequest import PullRequest
from github.Repository import Repository
class TimingData(NamedTuple):
billable: Dict[str, Dict[str, int]]
run_duration_ms: int
class WorkflowRun(CompletableGithubObject):
def __repr__(self) -> str: ...
def _initAttributes(self) -> None: ...
def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
@property
def id(self) -> int: ...
@property
def head_branch(self) -> str: ...
@property
def head_sha(self) -> str: ...
@property
def run_number(self) -> int: ...
@property
def event(self) -> str: ...
@property
def status(self) -> str: ...
@property
def conclusion(self) -> str: ...
@property
def url(self) -> str: ...
@property
def html_url(self) -> str: ...
@property
def pull_requests(self) -> List[PullRequest]: ...
@property
def created_at(self) -> datetime: ...
@property
def updated_at(self) -> datetime: ...
@property
def jobs_url(self) -> str: ...
@property
def logs_url(self) -> str: ...
@property
def check_suite_url(self) -> str: ...
@property
def artifacts_url(self) -> str: ...
@property
def cancel_url(self) -> str: ...
@property
def rerun_url(self) -> str: ...
@property
def workflow_url(self) -> str: ...
@property
def head_commit(self) -> GitCommit: ...
@property
def repository(self) -> Repository: ...
@property
def head_repository(self) -> Repository: ...
def cancel(self) -> bool: ...
def rerun(self) -> bool: ...
def timing(self) -> TimingData: ...