############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2015 Matt Babineau # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Martijn Koster # # Copyright 2016 Peter Buckley # # Copyright 2018 Wan Liuyang # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Colby Gallup # # Copyright 2020 Pascal Hofmann # # Copyright 2020 Steve Kowalik # # Copyright 2021 Steve Kowalik # # Copyright 2023 Enrico Minack # # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2023 Nevins # # Copyright 2023 Trim21 # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.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 . # # # ################################################################################ from __future__ import annotations from datetime import datetime from typing import Any import github.Consts import github.DeploymentStatus import github.NamedUser from github.GithubObject import Attribute, CompletableGithubObject, NotSet, Opt from github.PaginatedList import PaginatedList class Deployment(CompletableGithubObject): """ This class represents Deployments. The reference can be found here https://docs.github.com/en/rest/reference/repos#deployments """ def _initAttributes(self) -> None: self._id: Attribute[int] = NotSet self._ref: Attribute[str] = NotSet self._url: Attribute[str] = NotSet self._sha: Attribute[str] = NotSet self._task: Attribute[str] = NotSet self._payload: Attribute[dict[str, Any]] = NotSet self._original_environment: Attribute[str] = NotSet self._environment: Attribute[str] = NotSet self._production_environment: Attribute[bool] = NotSet self._transient_environment: Attribute[bool] = NotSet self._description: Attribute[str] = NotSet self._creator: Attribute[github.NamedUser.NamedUser] = NotSet self._created_at: Attribute[datetime] = NotSet self._updated_at: Attribute[datetime | None] = NotSet self._statuses_url: Attribute[str] = NotSet self._repository_url: Attribute[str] = NotSet def __repr__(self) -> str: return self.get__repr__({"id": self._id.value, "url": self._url.value}) @property def id(self) -> int: self._completeIfNotSet(self._id) return self._id.value @property def ref(self) -> str: self._completeIfNotSet(self._ref) return self._ref.value @property def url(self) -> str: self._completeIfNotSet(self._url) return self._url.value @property def sha(self) -> str: self._completeIfNotSet(self._sha) return self._sha.value @property def task(self) -> str: self._completeIfNotSet(self._task) return self._task.value @property def payload(self) -> dict[str, Any]: self._completeIfNotSet(self._payload) return self._payload.value @property def original_environment(self) -> str: self._completeIfNotSet(self._original_environment) return self._original_environment.value @property def environment(self) -> str: self._completeIfNotSet(self._environment) return self._environment.value @property def production_environment(self) -> bool: self._completeIfNotSet(self._production_environment) return self._production_environment.value @property def transient_environment(self) -> bool: self._completeIfNotSet(self._transient_environment) return self._transient_environment.value @property def description(self) -> str: self._completeIfNotSet(self._description) return self._description.value @property def creator(self) -> github.NamedUser.NamedUser: self._completeIfNotSet(self._creator) return self._creator.value @property def created_at(self) -> datetime: self._completeIfNotSet(self._created_at) return self._created_at.value @property def updated_at(self) -> datetime | None: self._completeIfNotSet(self._updated_at) return self._updated_at.value @property def statuses_url(self) -> str: self._completeIfNotSet(self._statuses_url) return self._statuses_url.value @property def repository_url(self) -> str: self._completeIfNotSet(self._repository_url) return self._repository_url.value def get_statuses(self) -> PaginatedList[github.DeploymentStatus.DeploymentStatus]: """ :calls: `GET /repos/{owner}/deployments/{deployment_id}/statuses `_ """ return PaginatedList( github.DeploymentStatus.DeploymentStatus, self._requester, f"{self.url}/statuses", None, headers={"Accept": self._get_accept_header()}, ) def get_status(self, id_: int) -> github.DeploymentStatus.DeploymentStatus: """ :calls: `GET /repos/{owner}/deployments/{deployment_id}/statuses/{status_id} `_ """ assert isinstance(id_, int), id_ headers, data = self._requester.requestJsonAndCheck( "GET", f"{self.url}/statuses/{id_}", headers={"Accept": self._get_accept_header()}, ) return github.DeploymentStatus.DeploymentStatus(self._requester, headers, data, completed=True) def create_status( self, state: str, target_url: Opt[str] = NotSet, description: Opt[str] = NotSet, environment: Opt[str] = NotSet, environment_url: Opt[str] = NotSet, auto_inactive: Opt[bool] = NotSet, ) -> github.DeploymentStatus.DeploymentStatus: """ :calls: `POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses `_ """ assert isinstance(state, str), state assert target_url is NotSet or isinstance(target_url, str), target_url assert description is NotSet or isinstance(description, str), description assert environment is NotSet or isinstance(environment, str), environment assert environment_url is NotSet or isinstance(environment_url, str), environment_url assert auto_inactive is NotSet or isinstance(auto_inactive, bool), auto_inactive post_parameters = NotSet.remove_unset_items( { "state": state, "target_url": target_url, "description": description, "environment": environment, "environment_url": environment_url, "auto_inactive": auto_inactive, } ) headers, data = self._requester.requestJsonAndCheck( "POST", f"{self.url}/statuses", input=post_parameters, headers={"Accept": self._get_accept_header()}, ) return github.DeploymentStatus.DeploymentStatus(self._requester, headers, data, completed=True) @staticmethod def _get_accept_header() -> str: return ", ".join( [ github.Consts.deploymentEnhancementsPreview, github.Consts.deploymentStatusEnhancementsPreview, ] ) def _useAttributes(self, attributes: dict[str, Any]) -> None: if "id" in attributes: # pragma no branch self._id = self._makeIntAttribute(attributes["id"]) if "production_environment" in attributes: # pragma no branch self._production_environment = self._makeBoolAttribute(attributes["production_environment"]) if "ref" in attributes: # pragma no branch self._ref = self._makeStringAttribute(attributes["ref"]) if "transient_environment" in attributes: # pragma no branch self._transient_environment = self._makeBoolAttribute(attributes["transient_environment"]) if "url" in attributes: # pragma no branch self._url = self._makeStringAttribute(attributes["url"]) if "sha" in attributes: # pragma no branch self._sha = self._makeStringAttribute(attributes["sha"]) if "task" in attributes: # pragma no branch self._task = self._makeStringAttribute(attributes["task"]) if "payload" in attributes: # pragma no branch self._payload = self._makeDictAttribute(attributes["payload"]) if "original_environment" in attributes: # pragma no branch self._original_environment = self._makeStringAttribute(attributes["original_environment"]) if "environment" in attributes: # pragma no branch self._environment = self._makeStringAttribute(attributes["environment"]) if "description" in attributes: # pragma no branch self._description = self._makeStringAttribute(attributes["description"]) if "creator" in attributes: # pragma no branch self._creator = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["creator"]) 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 "statuses_url" in attributes: # pragma no branch self._statuses_url = self._makeStringAttribute(attributes["statuses_url"]) if "repository_url" in attributes: # pragma no branch self._repository_url = self._makeStringAttribute(attributes["repository_url"])