############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Michael Stead # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2017 Nicolas Agustín Torres # # Copyright 2018 Shubham Singh <41840111+singh811@users.noreply.github.com> # # Copyright 2018 Wan Liuyang # # Copyright 2018 per1234 # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # Copyright 2021 Mark Walker # # Copyright 2021 Steve Kowalik # # Copyright 2023 Enrico Minack # # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2023 Mark Amery # # 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 import urllib.parse from datetime import datetime from typing import Any import github.GithubObject import github.NamedUser import github.PaginatedList import github.Repository from github import Consts from github.GithubObject import Attribute, CompletableGithubObject, NotSet class Migration(CompletableGithubObject): """ This class represents Migrations. The reference can be found here https://docs.github.com/en/rest/reference/migrations """ def _initAttributes(self) -> None: self._id: Attribute[int] = NotSet self._owner: Attribute[github.NamedUser.NamedUser] = NotSet self._guid: Attribute[str] = NotSet self._state: Attribute[str] = NotSet self._lock_repositories: Attribute[bool] = NotSet self._exclude_attachments: Attribute[bool] = NotSet self._repositories: Attribute[list[github.Repository.Repository]] = NotSet self._url: Attribute[str] = NotSet def __repr__(self) -> str: return self.get__repr__({"state": self._state.value, "url": self._url.value}) @property def id(self) -> int: return self._id.value @property def owner(self) -> github.NamedUser.NamedUser: self._completeIfNotSet(self._owner) return self._owner.value @property def guid(self) -> str: self._completeIfNotSet(self._guid) return self._guid.value @property def state(self) -> str: self._completeIfNotSet(self._guid) return self._state.value @property def lock_repositories(self) -> bool: self._completeIfNotSet(self._repositories) return self._lock_repositories.value @property def exclude_attachments(self) -> bool: self._completeIfNotSet(self._exclude_attachments) return self._exclude_attachments.value @property def repositories(self) -> list[github.Repository.Repository]: self._completeIfNotSet(self._repositories) return self._repositories.value @property def url(self) -> str: self._completeIfNotSet(self._url) return self._url.value @property def created_at(self) -> datetime: self._completeIfNotSet(self._created_at) return self._created_at.value @property def updated_at(self) -> datetime: self._completeIfNotSet(self._updated_at) return self._updated_at.value def get_status(self) -> str: """ :calls: `GET /user/migrations/{migration_id} `_ """ headers, data = self._requester.requestJsonAndCheck( "GET", self.url, headers={"Accept": Consts.mediaTypeMigrationPreview} ) self._useAttributes(data) return self.state def get_archive_url(self) -> str: """ :calls: `GET /user/migrations/{migration_id}/archive `_ """ headers, data = self._requester.requestJsonAndCheck( "GET", f"{self.url}/archive", headers={"Accept": Consts.mediaTypeMigrationPreview}, ) return data["data"] def delete(self) -> None: """ :calls: `DELETE /user/migrations/{migration_id}/archive `_ """ headers, data = self._requester.requestJsonAndCheck( "DELETE", f"{self.url}/archive", headers={"Accept": Consts.mediaTypeMigrationPreview}, ) def unlock_repo(self, repo_name: str) -> None: """ :calls: `DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock `_ """ assert isinstance(repo_name, str), repo_name repo_name = urllib.parse.quote(repo_name) headers, data = self._requester.requestJsonAndCheck( "DELETE", f"{self.url}/repos/{repo_name}/lock", headers={"Accept": Consts.mediaTypeMigrationPreview}, ) def _useAttributes(self, attributes: dict[str, Any]) -> None: if "id" in attributes: self._id = self._makeIntAttribute(attributes["id"]) if "owner" in attributes: self._owner = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["owner"]) if "guid" in attributes: self._guid = self._makeStringAttribute(attributes["guid"]) if "state" in attributes: self._state = self._makeStringAttribute(attributes["state"]) if "lock_repositories" in attributes: self._lock_repositories = self._makeBoolAttribute(attributes["lock_repositories"]) if "exclude_attachments" in attributes: self._exclude_attachments = self._makeBoolAttribute(attributes["exclude_attachments"]) if "repositories" in attributes: self._repositories = self._makeListOfClassesAttribute( github.Repository.Repository, attributes["repositories"] ) if "url" in attributes: self._url = self._makeStringAttribute(attributes["url"]) if "created_at" in attributes: self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) if "updated_at" in attributes: self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])