Repository navigation
Expand file tree
/
Copy pathgit.py
More file actions
441 lines (300 loc) · 11.9 KB
/
Copy pathgit.py
File metadata and controls
441 lines (300 loc) · 11.9 KB
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
# -*- coding: utf-8 -*-
"""
This module contains all the classes relating to Git Data.
See also: http://developer.github.com/v3/git/
"""
from __future__ import unicode_literals
import base64
import warnings
from json import dumps
from . import models
from .decorators import requires_auth
class Blob(models.GitHubCore):
"""This object provides an interface to the API representation of a blob.
See also: http://developer.github.com/v3/git/blobs/
.. versionchanged:: 1.0.0
- The :attr:`content` is no longer forcibly coerced to bytes.
- The :attr:`decoded` is deprecated in favor of :meth:`decode_content`.
This object has the following atributes
.. attribute:: content
The raw content of the blob. This may be base64 encoded text. Use
:meth:`decode_content` to receive the non-encoded text.
.. attribute:: encoding
The encoding that GitHub reports for this blob's content.
.. attribute:: size
The size of this blob's content in bytes.
.. attribute:: sha
The SHA1 of this blob's content.
"""
def _update_attributes(self, blob):
self._api = blob['url']
self.content = blob['content']
self.encoding = blob['encoding']
self.size = blob['size']
self.sha = blob['sha']
def _repr(self):
return '<Blob [{0:.10}]>'.format(self.sha)
@property
def decoded(self):
"""Compatibility shim for the deprecated attribute."""
warnings.warn('The decoded attribute is deprecated. Use decode_content'
' instead.', DeprecationWarning)
return self.decode_content()
def decode_content(self):
"""Return the unencoded content of this blob.
If the content is base64 encoded, this will properly decode it.
Otherwise, it will return the content as returned by the API.
:returns:
Decoded content as text
:rtype:
unicode
"""
if self.encoding == 'base64' and self.content:
return base64.b64decode(
self.content.encode('utf-8')
).decode('utf-8')
return self.content
class _Commit(models.GitHubCore):
class_name = '_Commit'
def _update_attributes(self, commit):
self._api = commit['url']
self.author = commit['author']
if self.author.get('name'):
self._author_name = self.author['name']
self.committer = commit['committer']
if self.committer:
self._commit_name = self.committer.get('name')
self.message = commit['message']
self.tree = CommitTree(commit['tree'], self)
def _repr(self):
return '<{0} [{1}]>'.format(self.class_name, self.sha)
class Commit(_Commit):
"""This represents a commit as returned by the git API.
This is distinct from :class:`~github3.repos.commit.RepoCommit`.
Primarily this object represents the commit data stored by git and
it has no relationship to the repository on GitHub.
See also: http://developer.github.com/v3/git/commits/
This object has all of the attributes of a
:class:`~github3.git.ShortCommit` as well as the following attributes:
.. attribute:: parents
The list of commits that are the parents of this commit. This may be
empty if this is the initial commit, or it may have several if it is
the result of an octopus merge. Each parent is represented as a
dictionary with the API URL and SHA1.
.. attribute:: sha
The unique SHA1 which identifies this commit.
.. attribute:: verification
The GPG verification data about this commit. See
https://developer.github.com/v3/git/commits/#commit-signature-verification
for more information.
"""
class_name = 'Commit'
def _update_attributes(self, commit):
super(Commit, self)._update_attributes(commit)
self.parents = commit['parents']
self.sha = commit['sha']
if not self.sha:
i = self._api.rfind('/')
self.sha = self._api[i + 1:]
self._uniq = self.sha
self.verification = commit['verification']
class ShortCommit(_Commit):
"""This represents a commit as returned by the git API.
This is distinct from :class:`~github3.repos.commit.RepoCommit`.
Primarily this object represents the commit data stored by git. This
shorter representation of a Commit is most often found on a
:class:`~github3.repos.commit.RepoCommit` to represent the git data
associated with it.
See also: http://developer.github.com/v3/git/commits/
This object has the following attributes:
.. attribute:: author
This is a dictionary with at least the name and email of the author
of this commit as well as the date it was authored.
.. attribute:: committer
This is a dictionary with at least the name and email of the committer
of this commit as well as the date it was committed.
.. attribute:: message
The commit message that describes the changes as written by the author
and committer.
.. attribute:: tree
The git tree object this commit points to.
"""
class_name = 'ShortCommit'
_refresh_to = Commit
class Reference(models.GitHubCore):
"""Object representing a git reference associated with a repository.
This represents a reference (or ref) created on a repository via git.
See also: http://developer.github.com/v3/git/refs/
This object has the following attributes:
.. attribute:: object
A :class:`~github3.git.GitObject` that this reference points to.
.. attribute:: ref
The string path to the reference, e.g., ``'refs/heads/sc/feature-a'``.
"""
def _update_attributes(self, ref):
self._api = ref['url']
self.object = GitObject(ref['object'], self)
self.ref = ref['ref']
def _repr(self):
return '<Reference [{0}]>'.format(self.ref)
@requires_auth
def delete(self):
"""Delete this reference.
:returns:
True if successful, False otherwise
:rtype:
bool
"""
return self._boolean(self._delete(self._api), 204, 404)
@requires_auth
def update(self, sha, force=False):
"""Update this reference.
:param str sha:
(required), sha of the reference
:param bool force:
(optional), force the update or not
:returns:
True if successful, False otherwise
:rtype:
bool
"""
data = {'sha': sha, 'force': force}
json = self._json(self._patch(self._api, data=dumps(data)), 200)
if json:
self._update_attributes(json)
return True
return False
class GitObject(models.GitHubCore):
"""This object represents an arbitrary 'object' in git.
This object is intended to be versatile and is usually found on one of the
following:
- :class:`~github3.git.Reference`
- :class:`~github3.git.Tag`
This object has the following attributes:
.. attribute:: sha
The SHA1 of the object this is representing.
.. attribute:: type
The name of the type of object this is representing.
"""
def _update_attributes(self, obj):
self._api = obj['url']
self.sha = obj['sha']
self.type = obj['type']
def _repr(self):
return '<Git Object [{0}]>'.format(self.sha)
class Tag(models.GitHubCore):
"""This represents an annotated tag.
Tags are a special kind of git reference and annotated tags have more
information than lightweight tags.
See also: http://developer.github.com/v3/git/tags/
This object has the following attributes:
.. attribute:: message
This is the message that was written to accompany the creation of the
annotated tag.
.. attribute:: object
A :class:`~github3.git.GitObject` that represents the underlying git
object.
.. attribute:: sha
The SHA1 of this tag in the git repository.
.. attribute:: tag
The "lightweight" tag (or reference) that backs this annotated tag.
.. attribute:: tagger
The person who created this tag.
"""
def _update_attributes(self, tag):
self._api = tag['url']
self.message = tag['message']
self.object = GitObject(tag['object'], self)
self.sha = tag['sha']
self.tag = tag['tag']
self.tagger = tag['tagger']
def _repr(self):
return '<Tag [{0}]>'.format(self.tag)
class CommitTree(models.GitHubCore):
"""This object represents the abbreviated tree data in a commit.
The API returns different representations of different objects. When
representing a :class:`~github3.git.ShortCommit` or
:class:`~github3.git.Commit`, the API returns an abbreviated
representation of a git tree.
This object has the following attributes:
.. attribute:: sha
The SHA1 of this tree in the git repository.
"""
def _update_attributes(self, tree):
self._api = tree['url']
self.sha = tree['sha']
def _repr(self):
return '<CommitTree [{0}]>'.format(self.sha)
def to_tree(self):
"""Retrieve a full Tree object for this CommitTree.
:returns:
The full git data about this tree
:rtype:
:class:`~github3.git.Tree`
"""
json = self._json(self._get(self._api), 200)
return self._instance_or_null(Tree, json)
refresh = to_tree
class Tree(models.GitHubCore):
"""This represents a tree object from a git repository.
Trees tend to represent directories and subdirectories.
See also: http://developer.github.com/v3/git/trees/
This object has the following attributes:
.. attribute:: sha
The SHA1 of this tree in the git repository.
.. attribute:: tree
A list that represents the nodes in the tree. If this list has members
it will have instances of :class:`~github3.git.Hash`.
"""
def _update_attributes(self, tree):
self._api = tree['url']
self.sha = tree['sha']
self.tree = tree['tree']
if self.tree:
self.tree = [Hash(t, self) for t in self.tree]
def _repr(self):
return '<Tree [{0}]>'.format(self.sha)
def __eq__(self, other):
return self.as_dict() == other.as_dict()
def __ne__(self, other):
return self.as_dict() != other.as_dict()
def recurse(self):
"""Recurse into this tree.
:returns:
A new tree
:rtype:
:class:`~github3.git.Tree`
"""
json = self._json(self._get(self._api, params={'recursive': '1'}),
200)
return self._instance_or_null(Tree, json)
class Hash(models.GitHubCore):
"""This is used to represent the elements of a tree.
This provides the path to the object and the type of object it is. For
a brief explanation of what these types are and represent, this
StackOverflow question answers some of that:
https://stackoverflow.com/a/18605496/1953283
See also: http://developer.github.com/v3/git/trees/#create-a-tree
This object has the following attributes:
.. attribute:: mode
The mode of the file, directory, or link.
.. attribute:: path
The path to the file, directory, or link.
.. attribute:: sha
The SHA1 for this hash.
.. attribute:: size
This attribute is only not ``None`` if the :attr:`type` is not a tree.
.. attribute:: type
The type of git object this is representing, e.g., tree, blob, etc.
"""
def _update_attributes(self, info):
self._api = info['url']
self.mode = info['mode']
self.path = info['path']
self.sha = info['sha']
self.size = None
self.type = info['type']
if self.type != 'tree':
self.size = info['size']
def _repr(self):
return '<Hash [{0}]>'.format(self.sha)