1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
############################ Copyrights and license ############################
# #
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2012 Zearin <zearin@gonk.net> #
# Copyright 2013 AKFish <akfish@gmail.com> #
# Copyright 2013 Michael Stead <michael.stead@gmail.com> #
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2017 Nicolas AgustÃn Torres <nicolastrres@gmail.com> #
# Copyright 2018 Shubham Singh <41840111+singh811@users.noreply.github.com> #
# Copyright 2018 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2018 per1234 <accounts@perglass.com> #
# Copyright 2018 sfdye <tsfdye@gmail.com> #
# Copyright 2019 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2019 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2021 Mark Walker <mark.walker@realbuzz.com> #
# Copyright 2021 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Mark Amery <markamery@btinternet.com> #
# Copyright 2023 Trim21 <trim21.me@gmail.com> #
# Copyright 2024 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev> #
# #
# 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 __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
The OpenAPI schema can be found at
- /components/schemas/migration
"""
def _initAttributes(self) -> None:
self._archive_url: Attribute[str] = NotSet
self._created_at: Attribute[datetime] = NotSet
self._exclude: Attribute[list[str]] = NotSet
self._exclude_attachments: Attribute[bool] = NotSet
self._exclude_git_data: Attribute[bool] = NotSet
self._exclude_metadata: Attribute[bool] = NotSet
self._exclude_owner_projects: Attribute[bool] = NotSet
self._exclude_releases: Attribute[bool] = NotSet
self._guid: Attribute[str] = NotSet
self._id: Attribute[int] = NotSet
self._lock_repositories: Attribute[bool] = NotSet
self._node_id: Attribute[str] = NotSet
self._org_metadata_only: Attribute[bool] = NotSet
self._owner: Attribute[github.NamedUser.NamedUser] = NotSet
self._repositories: Attribute[list[github.Repository.Repository]] = NotSet
self._state: Attribute[str] = NotSet
self._updated_at: Attribute[datetime] = NotSet
self._url: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"state": self._state.value, "url": self._url.value})
@property
def archive_url(self) -> str:
self._completeIfNotSet(self._archive_url)
return self._archive_url.value
@property
def created_at(self) -> datetime:
self._completeIfNotSet(self._created_at)
return self._created_at.value
@property
def exclude(self) -> list[str]:
self._completeIfNotSet(self._exclude)
return self._exclude.value
@property
def exclude_attachments(self) -> bool:
self._completeIfNotSet(self._exclude_attachments)
return self._exclude_attachments.value
@property
def exclude_git_data(self) -> bool:
self._completeIfNotSet(self._exclude_git_data)
return self._exclude_git_data.value
@property
def exclude_metadata(self) -> bool:
self._completeIfNotSet(self._exclude_metadata)
return self._exclude_metadata.value
@property
def exclude_owner_projects(self) -> bool:
self._completeIfNotSet(self._exclude_owner_projects)
return self._exclude_owner_projects.value
@property
def exclude_releases(self) -> bool:
self._completeIfNotSet(self._exclude_releases)
return self._exclude_releases.value
@property
def guid(self) -> str:
self._completeIfNotSet(self._guid)
return self._guid.value
@property
def id(self) -> int:
return self._id.value
@property
def lock_repositories(self) -> bool:
self._completeIfNotSet(self._repositories)
return self._lock_repositories.value
@property
def node_id(self) -> str:
self._completeIfNotSet(self._node_id)
return self._node_id.value
@property
def org_metadata_only(self) -> bool:
self._completeIfNotSet(self._org_metadata_only)
return self._org_metadata_only.value
@property
def owner(self) -> github.NamedUser.NamedUser:
self._completeIfNotSet(self._owner)
return self._owner.value
@property
def repositories(self) -> list[github.Repository.Repository]:
self._completeIfNotSet(self._repositories)
return self._repositories.value
@property
def state(self) -> str:
self._completeIfNotSet(self._guid)
return self._state.value
@property
def updated_at(self) -> datetime:
self._completeIfNotSet(self._updated_at)
return self._updated_at.value
@property
def url(self) -> str:
self._completeIfNotSet(self._url)
return self._url.value
def get_status(self) -> str:
"""
:calls: `GET /user/migrations/{migration_id} <https://docs.github.com/en/rest/reference/migrations>`_
"""
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 <https://docs.github.com/en/rest/reference/migrations>`_
"""
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 <https://docs.github.com/en/rest/reference/migrations>`_
"""
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 <https://docs.github.com/en/rest/reference/migrations>`_
"""
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 "archive_url" in attributes: # pragma no branch
self._archive_url = self._makeStringAttribute(attributes["archive_url"])
if "created_at" in attributes:
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
if "exclude" in attributes: # pragma no branch
self._exclude = self._makeListOfStringsAttribute(attributes["exclude"])
if "exclude_attachments" in attributes:
self._exclude_attachments = self._makeBoolAttribute(attributes["exclude_attachments"])
if "exclude_git_data" in attributes: # pragma no branch
self._exclude_git_data = self._makeBoolAttribute(attributes["exclude_git_data"])
if "exclude_metadata" in attributes: # pragma no branch
self._exclude_metadata = self._makeBoolAttribute(attributes["exclude_metadata"])
if "exclude_owner_projects" in attributes: # pragma no branch
self._exclude_owner_projects = self._makeBoolAttribute(attributes["exclude_owner_projects"])
if "exclude_releases" in attributes: # pragma no branch
self._exclude_releases = self._makeBoolAttribute(attributes["exclude_releases"])
if "guid" in attributes:
self._guid = self._makeStringAttribute(attributes["guid"])
if "id" in attributes:
self._id = self._makeIntAttribute(attributes["id"])
if "lock_repositories" in attributes:
self._lock_repositories = self._makeBoolAttribute(attributes["lock_repositories"])
if "node_id" in attributes: # pragma no branch
self._node_id = self._makeStringAttribute(attributes["node_id"])
if "org_metadata_only" in attributes: # pragma no branch
self._org_metadata_only = self._makeBoolAttribute(attributes["org_metadata_only"])
if "owner" in attributes:
self._owner = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["owner"])
if "repositories" in attributes:
self._repositories = self._makeListOfClassesAttribute(
github.Repository.Repository, attributes["repositories"]
)
if "state" in attributes:
self._state = self._makeStringAttribute(attributes["state"])
if "updated_at" in attributes:
self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])
if "url" in attributes:
self._url = self._makeStringAttribute(attributes["url"])
|
