mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
87 lines
4.1 KiB
Python
87 lines
4.1 KiB
Python
############################ Copyrights and license ############################
|
|
# #
|
|
# Copyright 2021 Jeppe Fihl-Pearson <jeppe@tenzer.dk> #
|
|
# #
|
|
# 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 datetime import datetime
|
|
from typing import Any, Dict
|
|
|
|
from github.GithubObject import Attribute, CompletableGithubObject, NotSet
|
|
|
|
|
|
class WorkflowStep(CompletableGithubObject):
|
|
"""
|
|
This class represents steps in a Workflow Job. The reference can be found here https://docs.github.com/en/rest/reference/actions#workflow-jobs
|
|
"""
|
|
|
|
def _initAttributes(self) -> None:
|
|
self._completed_at: Attribute[datetime] = NotSet
|
|
self._conclusion: Attribute[str] = NotSet
|
|
self._name: Attribute[str] = NotSet
|
|
self._number: Attribute[int] = NotSet
|
|
self._started_at: Attribute[datetime] = NotSet
|
|
self._status: Attribute[str] = NotSet
|
|
|
|
def __repr__(self) -> str:
|
|
return self.get__repr__({"number": self._number.value, "name": self._name.value})
|
|
|
|
@property
|
|
def completed_at(self) -> datetime:
|
|
self._completeIfNotSet(self._completed_at)
|
|
return self._completed_at.value
|
|
|
|
@property
|
|
def conclusion(self) -> str:
|
|
self._completeIfNotSet(self._conclusion)
|
|
return self._conclusion.value
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
self._completeIfNotSet(self._name)
|
|
return self._name.value
|
|
|
|
@property
|
|
def number(self) -> int:
|
|
self._completeIfNotSet(self._number)
|
|
return self._number.value
|
|
|
|
@property
|
|
def started_at(self) -> datetime:
|
|
self._completeIfNotSet(self._started_at)
|
|
return self._started_at.value
|
|
|
|
@property
|
|
def status(self) -> str:
|
|
self._completeIfNotSet(self._status)
|
|
return self._status.value
|
|
|
|
def _useAttributes(self, attributes: Dict[str, Any]) -> None:
|
|
if "completed_at" in attributes: # pragma no branch
|
|
self._completed_at = self._makeDatetimeAttribute(attributes["completed_at"])
|
|
if "conclusion" in attributes: # pragma no branch
|
|
self._conclusion = self._makeStringAttribute(attributes["conclusion"])
|
|
if "name" in attributes: # pragma no branch
|
|
self._name = self._makeStringAttribute(attributes["name"])
|
|
if "number" in attributes: # pragma no branch
|
|
self._number = self._makeIntAttribute(attributes["number"])
|
|
if "started_at" in attributes: # pragma no branch
|
|
self._started_at = self._makeDatetimeAttribute(attributes["started_at"])
|
|
if "status" in attributes: # pragma no branch
|
|
self._status = self._makeStringAttribute(attributes["status"])
|