Add support for Workflows (#1496)

To start supporting GitHub Actions, add the first part of that,
Workflow, which encapsulates a workflow over the API, along with
two methods on Repository to query them.
This commit is contained in:
Steve Kowalik
2020-05-05 15:49:45 +10:00
committed by GitHub
parent ba9d59c209
commit a1ed7c0e2d
7 changed files with 296 additions and 0 deletions
+24
View File
@@ -135,6 +135,7 @@ import github.StatsPunchCard
import github.Tag
import github.Team
import github.View
import github.Workflow
from . import Consts
@@ -3000,6 +3001,29 @@ class Repository(github.GithubObject.CompletableGithubObject):
github.NamedUser.NamedUser, self._requester, self.url + "/watchers", None
)
def get_workflows(self):
"""
:calls: `GET /repos/:owner/:repo/actions/workflows <https://developer.github.com/v3/actions/workflows>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Workflow.Workflow`
"""
return github.PaginatedList.PaginatedList(
github.Workflow.Workflow,
self._requester,
self.url + "/actions/workflows",
None,
)
def get_workflow(self, id_or_name):
"""
:calls: `GET /repos/:owner/:repo/actions/workflows/:workflow_id <https://developer.github.com/v3/actions/workflows>`_
:rtype: :class:`github.Workflow.Workflow`
"""
assert isinstance(id_or_name, int) or isinstance(id_or_name, str), id_or_name
headers, data = self._requester.requestJsonAndCheck(
"GET", self.url + "/actions/workflows/" + id_or_name
)
return github.Workflow.Workflow(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>`_
+137
View File
@@ -0,0 +1,137 @@
# -*- 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/>. #
# #
################################################################################
import github.GithubObject
class Workflow(github.GithubObject.CompletableGithubObject):
"""
This class represents Workflows. The reference can be found here https://developer.github.com/v3/actions/workflows/
"""
def __repr__(self):
return self.get__repr__({"name": self._name.value, "url": self._url.value})
@property
def id(self):
"""
:type: int
"""
self._completeIfNotSet(self._id)
return self._id.value
@property
def name(self):
"""
:type: string
"""
self._completeIfNotSet(self._name)
return self._name.value
@property
def path(self):
"""
:type: string
"""
self._completeIfNotSet(self._path)
return self._path.value
@property
def state(self):
"""
:type: string
"""
self._completeIfNotSet(self._state)
return self._state.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 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 badge_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._badge_url)
return self._badge_url.value
def _initAttributes(self):
self._id = github.GithubObject.NotSet
self._name = github.GithubObject.NotSet
self._path = github.GithubObject.NotSet
self._state = github.GithubObject.NotSet
self._created_at = github.GithubObject.NotSet
self._updated_at = github.GithubObject.NotSet
self._url = github.GithubObject.NotSet
self._html_url = github.GithubObject.NotSet
self._badge_url = github.GithubObject.NotSet
def _useAttributes(self, attributes):
if "id" in attributes: # pragma no branch
self._id = self._makeIntAttribute(attributes["id"])
if "name" in attributes: # pragma no branch
self._name = self._makeStringAttribute(attributes["name"])
if "path" in attributes: # pragma no branch
self._path = self._makeStringAttribute(attributes["path"])
if "state" in attributes: # pragma no branch
self._state = self._makeStringAttribute(attributes["state"])
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 "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 "badge_url" in attributes: # pragma no branch
self._badge_url = self._makeStringAttribute(attributes["badge_url"])
+27
View File
@@ -0,0 +1,27 @@
from datetime import datetime
from typing import Any, Dict
from github.GithubObject import CompletableGithubObject
class Deployment(CompletableGithubObject):
def __repr__(self) -> str: ...
def _initAttributes(self) -> None: ...
def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
@property
def id(self) -> int: ...
@property
def name(self) -> str: ...
@property
def path(self) -> str: ...
@property
def state(self) -> str: ...
@property
def created_at(self) -> datetime: ...
@property
def updated_at(self) -> datetime: ...
@property
def url(self) -> str: ...
@property
def html_url(self) -> str: ...
@property
def badge_url(self) -> str: ...