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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
############################ Copyrights and license ############################
# #
# Copyright 2015 Ed Holland <eholland@alertlogic.com> #
# Copyright 2016 Benjamin Whitney <benjamin.whitney@ironnetcybersecurity.com> #
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2017 Chris McBride <thehighlander@users.noreply.github.com> #
# Copyright 2017 Simon <spam@esemi.ru> #
# Copyright 2018 Daniel Kesler <kesler.daniel@gmail.com> #
# Copyright 2018 Kuba <jakub.glapa@adspired.com> #
# Copyright 2018 Maarten Fonville <mfonville@users.noreply.github.com> #
# Copyright 2018 Shinichi TAMURA <shnch.tmr@gmail.com> #
# Copyright 2018 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2018 edquist <edquist@users.noreply.github.com> #
# Copyright 2018 nurupo <nurupo.contributions@gmail.com> #
# Copyright 2018 sfdye <tsfdye@gmail.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 <http://www.gnu.org/licenses/>. #
# #
################################################################################
from os.path import basename
import github.GithubObject
import github.GitReleaseAsset
import github.NamedUser
from . import Consts
class GitRelease(github.GithubObject.CompletableGithubObject):
"""
This class represents GitReleases. The reference can be found here https://docs.github.com/en/rest/reference/repos#releases
"""
def __repr__(self):
return self.get__repr__({"title": self._title.value})
@property
def id(self):
"""
:type: integer
"""
self._completeIfNotSet(self._id)
return self._id.value
@property
def body(self):
"""
:type: string
"""
self._completeIfNotSet(self._body)
return self._body.value
@property
def title(self):
"""
:type: string
"""
self._completeIfNotSet(self._title)
return self._title.value
@property
def tag_name(self):
"""
:type: string
"""
self._completeIfNotSet(self._tag_name)
return self._tag_name.value
@property
def target_commitish(self):
"""
:type: string
"""
self._completeIfNotSet(self._target_commitish)
return self._target_commitish.value
@property
def draft(self):
"""
:type: bool
"""
self._completeIfNotSet(self._draft)
return self._draft.value
@property
def prerelease(self):
"""
:type: bool
"""
self._completeIfNotSet(self._prerelease)
return self._prerelease.value
@property
def author(self):
"""
:type: :class:`github.NamedUser.NamedUser`
"""
self._completeIfNotSet(self._author)
return self._author.value
@property
def created_at(self):
"""
:type: datetime.datetime
"""
self._completeIfNotSet(self._created_at)
return self._created_at.value
@property
def published_at(self):
"""
:type: datetime.datetime
"""
self._completeIfNotSet(self._published_at)
return self._published_at.value
@property
def url(self):
"""
:type: string
"""
self._completeIfNotSet(self._url)
return self._url.value
@property
def upload_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._upload_url)
return self._upload_url.value
@property
def html_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._html_url)
return self._html_url.value
@property
def tarball_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._tarball_url)
return self._tarball_url.value
@property
def zipball_url(self):
"""
:type: string
"""
self._completeIfNotSet(self._zipball_url)
return self._zipball_url.value
def delete_release(self):
"""
:calls: `DELETE /repos/{owner}/{repo}/releases/{release_id} <https://docs.github.com/en/rest/reference/repos/releases#delete-a-release>`_
:rtype: None
"""
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)
def update_release(
self,
name,
message,
draft=False,
prerelease=False,
tag_name=github.GithubObject.NotSet,
target_commitish=github.GithubObject.NotSet,
):
"""
:calls: `PATCH /repos/{owner}/{repo}/releases/{release_id} <https://docs.github.com/en/rest/reference/repos/releases#edit-a-release>`_
:param name: string
:param message: string
:param draft: bool
:param prerelease: bool
:param tag_name: string
:param target_commitish: string
:rtype: :class:`github.GitRelease.GitRelease`
"""
assert tag_name is github.GithubObject.NotSet or isinstance(
tag_name, str
), "tag_name must be a str/unicode object"
assert target_commitish is github.GithubObject.NotSet or isinstance(
target_commitish, str
), "target_commitish must be a str/unicode object"
assert isinstance(name, str), name
assert isinstance(message, str), message
assert isinstance(draft, bool), draft
assert isinstance(prerelease, bool), prerelease
if tag_name is github.GithubObject.NotSet:
tag_name = self.tag_name
post_parameters = {
"tag_name": tag_name,
"name": name,
"body": message,
"draft": draft,
"prerelease": prerelease,
}
# Do not set target_commitish to self.target_commitish when omitted, just don't send it
# altogether in that case, in order to match the Github API behaviour. Only send it when set.
if target_commitish is not github.GithubObject.NotSet:
post_parameters["target_commitish"] = target_commitish
headers, data = self._requester.requestJsonAndCheck(
"PATCH", self.url, input=post_parameters
)
return github.GitRelease.GitRelease(
self._requester, headers, data, completed=True
)
def upload_asset(
self,
path,
label="",
content_type=github.GithubObject.NotSet,
name=github.GithubObject.NotSet,
):
"""
:calls: `POST https://<upload_url>/repos/{owner}/{repo}/releases/{release_id}/assets <https://docs.github.com/en/rest/reference/repos/releases#upload-a-release-asset>`_
:param path: string
:param label: string
:param content_type: string
:param name: string
:rtype: :class:`github.GitReleaseAsset.GitReleaseAsset`
"""
assert isinstance(path, str), path
assert isinstance(label, str), label
assert name is github.GithubObject.NotSet or isinstance(name, str), name
post_parameters = {"label": label}
if name is github.GithubObject.NotSet:
post_parameters["name"] = basename(path)
else:
post_parameters["name"] = name
headers = {}
if content_type is not github.GithubObject.NotSet:
headers["Content-Type"] = content_type
resp_headers, data = self._requester.requestBlobAndCheck(
"POST",
self.upload_url.split("{?")[0],
parameters=post_parameters,
headers=headers,
input=path,
)
return github.GitReleaseAsset.GitReleaseAsset(
self._requester, resp_headers, data, completed=True
)
def upload_asset_from_memory(
self,
file_like,
file_size,
name,
content_type=github.GithubObject.NotSet,
label="",
):
"""Uploads an asset. Unlike ``upload_asset()`` this method allows you to pass in a file-like object to upload.
Note that this method is more strict and requires you to specify the ``name``, since there's no file name to infer these from.
:calls: `POST https://<upload_url>/repos/{owner}/{repo}/releases/{release_id}/assets <https://docs.github.com/en/rest/reference/repos/releases#upload-a-release-asset>`_
:param file_like: binary file-like object, such as those returned by ``open("file_name", "rb")``. At the very minimum, this object must implement ``read()``.
:param file_size: int, size in bytes of ``file_like``
:param content_type: string
:param name: string
:param label: string
:rtype: :class:`github.GitReleaseAsset.GitReleaseAsset`
"""
assert isinstance(name, str), name
assert isinstance(file_size, int), file_size
assert isinstance(label, str), label
post_parameters = {"label": label, "name": name}
content_type = (
content_type
if content_type is not github.GithubObject.NotSet
else Consts.defaultMediaType
)
headers = {"Content-Type": content_type, "Content-Length": str(file_size)}
resp_headers, data = self._requester.requestMemoryBlobAndCheck(
"POST",
self.upload_url.split("{?")[0],
parameters=post_parameters,
headers=headers,
file_like=file_like,
)
return github.GitReleaseAsset.GitReleaseAsset(
self._requester, resp_headers, data, completed=True
)
def get_assets(self):
"""
:calls: `GET /repos/{owner}/{repo}/releases/{release_id}/assets <https://docs.github.com/en/rest/reference/repos/releases#list-assets-for-a-release>`_
:rtype: :class:`github.PaginatedList.PaginatedList`
"""
return github.PaginatedList.PaginatedList(
github.GitReleaseAsset.GitReleaseAsset,
self._requester,
f"{self.url}/assets",
None,
)
def _initAttributes(self):
self._id = github.GithubObject.NotSet
self._body = github.GithubObject.NotSet
self._title = github.GithubObject.NotSet
self._tag_name = github.GithubObject.NotSet
self._target_commitish = github.GithubObject.NotSet
self._draft = github.GithubObject.NotSet
self._prerelease = github.GithubObject.NotSet
self._author = github.GithubObject.NotSet
self._url = github.GithubObject.NotSet
self._upload_url = github.GithubObject.NotSet
self._html_url = github.GithubObject.NotSet
self._created_at = github.GithubObject.NotSet
self._published_at = github.GithubObject.NotSet
self._tarball_url = github.GithubObject.NotSet
self._zipball_url = github.GithubObject.NotSet
def _useAttributes(self, attributes):
if "id" in attributes:
self._id = self._makeIntAttribute(attributes["id"])
if "body" in attributes:
self._body = self._makeStringAttribute(attributes["body"])
if "name" in attributes:
self._title = self._makeStringAttribute(attributes["name"])
if "tag_name" in attributes:
self._tag_name = self._makeStringAttribute(attributes["tag_name"])
if "target_commitish" in attributes:
self._target_commitish = self._makeStringAttribute(
attributes["target_commitish"]
)
if "draft" in attributes:
self._draft = self._makeBoolAttribute(attributes["draft"])
if "prerelease" in attributes:
self._prerelease = self._makeBoolAttribute(attributes["prerelease"])
if "author" in attributes:
self._author = self._makeClassAttribute(
github.NamedUser.NamedUser, attributes["author"]
)
if "url" in attributes:
self._url = self._makeStringAttribute(attributes["url"])
if "upload_url" in attributes:
self._upload_url = self._makeStringAttribute(attributes["upload_url"])
if "html_url" in attributes:
self._html_url = self._makeStringAttribute(attributes["html_url"])
if "created_at" in attributes:
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
if "published_at" in attributes:
self._published_at = self._makeDatetimeAttribute(attributes["published_at"])
if "tarball_url" in attributes:
self._tarball_url = self._makeStringAttribute(attributes["tarball_url"])
if "zipball_url" in attributes:
self._zipball_url = self._makeStringAttribute(attributes["zipball_url"])
|
