FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

object: renamed id attribute to sha as it in fact is always being rew… · pythonthings/GitPython@3cb5ba1 · GitHub

  1. pythonthings
  2. GitPython

Repository navigation

Commit 3cb5ba1

Browse files
Byron
committed
object: renamed id attribute to sha as it in fact is always being rewritten as sha, even if the passed in id was a ref. This is done to assure objects are uniquely identified and will compare correctly
1 parent dbc18b9 commit 3cb5ba1

16 files changed

Lines changed: 69 additions & 76 deletions

File tree

‎TODO‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,6 @@ Object
2727
It would be good to improve things there as cat-file keeps all the data in a buffer
2828
before it writes it. Hence it does not write to a stream directly, which can be
2929
bad if files are large, say 1GB :).
30-
* Effectively Objects only store hexsha's in their id attributes, so in fact
31-
it should be renamed to 'sha'. There was a time when references where allowed as
32-
well, but now objects will be 'baked' to the actual sha to assure comparisons work.
33-
34-
Commit
35-
------
36-
* message is stipped during parsing, which is wrong unless we parse from
37-
rev-list output. In fact we don't know that, and can't really tell either.
38-
Currently we strip away white space that might actually belong to the message
3930

4031
Config
4132
------
@@ -115,7 +106,9 @@ Repo
115106
* Blame: Read the blame format making assumptions about its structure,
116107
currently regex are used a lot although we can deduct what will be next.
117108
- Read data from a stream directly from git command
118-
* Figure out how to implement a proper merge API
109+
* Figure out how to implement a proper merge API. It should be index based, but provide
110+
all necessary information to the ones willing to ask for it. The index implementation
111+
actually provides this already, but some real use-cases would be great to have a least.
119112
* repo.checkout should be added that does everything HEAD.reset does, but in addition
120113
it allows to checkout heads beforehand, hence its more like a repo.head.reference = other_head.
121114

‎lib/git/diff.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,11 +186,11 @@ def __init__(self, repo, a_path, b_path, a_blob_id, b_blob_id, a_mode,
186186
if not a_blob_id or self.re_is_null_hexsha.search(a_blob_id):
187187
self.a_blob = None
188188
else:
189-
self.a_blob = blob.Blob(repo, id=a_blob_id, mode=a_mode, path=a_path)
189+
self.a_blob = blob.Blob(repo, a_blob_id, mode=a_mode, path=a_path)
190190
if not b_blob_id or self.re_is_null_hexsha.search(b_blob_id):
191191
self.b_blob = None
192192
else:
193-
self.b_blob = blob.Blob(repo, id=b_blob_id, mode=b_mode, path=b_path)
193+
self.b_blob = blob.Blob(repo, b_blob_id, mode=b_mode, path=b_path)
194194

195195
self.a_mode = a_mode
196196
self.b_mode = b_mode

‎lib/git/index.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def from_blob(cls, blob, stage = 0):
9292
Returns
9393
Fully equipped BaseIndexEntry at the given stage
9494
"""
95-
return cls((blob.mode, blob.id, stage, blob.path))
95+
return cls((blob.mode, blob.sha, stage, blob.path))
9696

9797

9898
class IndexEntry(BaseIndexEntry):
@@ -165,7 +165,7 @@ def from_blob(cls, blob):
165165
Minimal entry resembling the given blob objecft
166166
"""
167167
time = struct.pack(">LL", 0, 0)
168-
return IndexEntry((blob.mode, blob.id, 0, blob.path, time, time, 0, 0, 0, 0, blob.size))
168+
return IndexEntry((blob.mode, blob.sha, 0, blob.path, time, time, 0, 0, 0, 0, blob.size))
169169

170170

171171
def clear_cache(func):

‎lib/git/objects/base.py‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ class Object(LazyMixin):
1616
This Object also serves as a constructor for instances of the correct type::
1717
1818
inst = Object.new(repo,id)
19-
inst.id # objects sha in hex
19+
inst.sha # objects sha in hex
2020
inst.size # objects uncompressed data size
2121
inst.data # byte string containing the whole data of the object
2222
"""
2323
NULL_HEX_SHA = '0'*40
2424
TYPES = ("blob", "tree", "commit", "tag")
25-
__slots__ = ("repo", "id", "size", "data" )
25+
__slots__ = ("repo", "sha", "size", "data" )
2626
type = None # to be set by subclass
2727

2828
def __init__(self, repo, id):
@@ -38,7 +38,7 @@ def __init__(self, repo, id):
3838
"""
3939
super(Object,self).__init__()
4040
self.repo = repo
41-
self.id = id
41+
self.sha = id
4242

4343
@classmethod
4444
def new(cls, repo, id):
@@ -76,11 +76,11 @@ def _set_cache_(self, attr):
7676
Retrieve object information
7777
"""
7878
if attr == "size":
79-
hexsha, typename, self.size = self.repo.git.get_object_header(self.id)
80-
assert typename == self.type, _assertion_msg_format % (self.id, typename, self.type)
79+
hexsha, typename, self.size = self.repo.git.get_object_header(self.sha)
80+
assert typename == self.type, _assertion_msg_format % (self.sha, typename, self.type)
8181
elif attr == "data":
82-
hexsha, typename, self.size, self.data = self.repo.git.get_object_data(self.id)
83-
assert typename == self.type, _assertion_msg_format % (self.id, typename, self.type)
82+
hexsha, typename, self.size, self.data = self.repo.git.get_object_data(self.sha)
83+
assert typename == self.type, _assertion_msg_format % (self.sha, typename, self.type)
8484
else:
8585
super(Object,self)._set_cache_(attr)
8686

@@ -89,43 +89,43 @@ def __eq__(self, other):
8989
Returns
9090
True if the objects have the same SHA1
9191
"""
92-
return self.id == other.id
92+
return self.sha == other.sha
9393

9494
def __ne__(self, other):
9595
"""
9696
Returns
9797
True if the objects do not have the same SHA1
9898
"""
99-
return self.id != other.id
99+
return self.sha != other.sha
100100

101101
def __hash__(self):
102102
"""
103103
Returns
104104
Hash of our id allowing objects to be used in dicts and sets
105105
"""
106-
return hash(self.id)
106+
return hash(self.sha)
107107

108108
def __str__(self):
109109
"""
110110
Returns
111111
string of our SHA1 as understood by all git commands
112112
"""
113-
return self.id
113+
return self.sha
114114

115115
def __repr__(self):
116116
"""
117117
Returns
118118
string with pythonic representation of our object
119119
"""
120-
return '<git.%s "%s">' % (self.__class__.__name__, self.id)
120+
return '<git.%s "%s">' % (self.__class__.__name__, self.sha)
121121

122122
@property
123123
def data_stream(self):
124124
"""
125125
Returns
126126
File Object compatible stream to the uncompressed raw data of the object
127127
"""
128-
proc = self.repo.git.cat_file(self.type, self.id, as_process=True)
128+
proc = self.repo.git.cat_file(self.type, self.sha, as_process=True)
129129
return utils.ProcessStreamAdapter(proc, "stdout")
130130

131131
def stream_data(self, ostream):
@@ -138,7 +138,7 @@ def stream_data(self, ostream):
138138
Returns
139139
self
140140
"""
141-
self.repo.git.cat_file(self.type, self.id, output_stream=ostream)
141+
self.repo.git.cat_file(self.type, self.sha, output_stream=ostream)
142142
return self
143143

144144
class IndexObject(Object):
@@ -148,13 +148,13 @@ class IndexObject(Object):
148148
"""
149149
__slots__ = ("path", "mode")
150150

151-
def __init__(self, repo, id, mode=None, path=None):
151+
def __init__(self, repo, sha, mode=None, path=None):
152152
"""
153153
Initialize a newly instanced IndexObject
154154
``repo``
155155
is the Repo we are located in
156156
157-
``id`` : string
157+
``sha`` : string
158158
is the git object id as hex sha
159159
160160
``mode`` : int
@@ -168,7 +168,7 @@ def __init__(self, repo, id, mode=None, path=None):
168168
Path may not be set of the index object has been created directly as it cannot
169169
be retrieved without knowing the parent tree.
170170
"""
171-
super(IndexObject, self).__init__(repo, id)
171+
super(IndexObject, self).__init__(repo, sha)
172172
self._set_self_from_args_(locals())
173173
if isinstance(mode, basestring):
174174
self.mode = self._mode_str_to_int(mode)

‎lib/git/objects/blob.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ def mime_type(self):
3333

3434

3535
def __repr__(self):
36-
return '<git.Blob "%s">' % self.id
36+
return '<git.Blob "%s">' % self.sha

‎lib/git/objects/commit.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ class Commit(base.Object, Iterable, diff.Diffable):
2323
type = "commit"
2424
__slots__ = ("tree", "author", "authored_date", "committer", "committed_date",
2525
"message", "parents")
26-
_id_attribute_ = "id"
26+
_id_attribute_ = "sha"
2727

28-
def __init__(self, repo, id, tree=None, author=None, authored_date=None,
28+
def __init__(self, repo, sha, tree=None, author=None, authored_date=None,
2929
committer=None, committed_date=None, message=None, parents=None):
3030
"""
3131
Instantiate a new Commit. All keyword arguments taking None as default will
3232
be implicitly set if id names a valid sha.
3333
3434
The parameter documentation indicates the type of the argument after a colon ':'.
3535
36-
``id``
36+
``sha``
3737
is the sha id of the commit or a ref
3838
3939
``parents`` : tuple( Commit, ... )
@@ -62,15 +62,15 @@ def __init__(self, repo, id, tree=None, author=None, authored_date=None,
6262
Returns
6363
git.Commit
6464
"""
65-
super(Commit,self).__init__(repo, id)
65+
super(Commit,self).__init__(repo, sha)
6666
self._set_self_from_args_(locals())
6767

6868
if parents is not None:
6969
self.parents = tuple( self.__class__(repo, p) for p in parents )
7070
# END for each parent to convert
7171

72-
if self.id and tree is not None:
73-
self.tree = Tree(repo, id=tree, path='')
72+
if self.sha and tree is not None:
73+
self.tree = Tree(repo, tree, path='')
7474
# END id to tree conversion
7575

7676
def _set_cache_(self, attr):
@@ -82,7 +82,7 @@ def _set_cache_(self, attr):
8282
if attr in Commit.__slots__:
8383
# prepare our data lines to match rev-list
8484
data_lines = self.data.splitlines()
85-
data_lines.insert(0, "commit %s" % self.id)
85+
data_lines.insert(0, "commit %s" % self.sha)
8686
temp = self._iter_from_process_or_stream(self.repo, iter(data_lines), False).next()
8787
self.parents = temp.parents
8888
self.tree = temp.tree
@@ -116,7 +116,7 @@ def count(self, paths='', **kwargs):
116116
Returns
117117
int
118118
"""
119-
return len(self.repo.git.rev_list(self.id, '--', paths, **kwargs).strip().splitlines())
119+
return len(self.repo.git.rev_list(self.sha, '--', paths, **kwargs).strip().splitlines())
120120

121121
@property
122122
def name_rev(self):
@@ -189,14 +189,14 @@ def stats(self):
189189
git.Stats
190190
"""
191191
if not self.parents:
192-
text = self.repo.git.diff_tree(self.id, '--', numstat=True, root=True)
192+
text = self.repo.git.diff_tree(self.sha, '--', numstat=True, root=True)
193193
text2 = ""
194194
for line in text.splitlines()[1:]:
195195
(insertions, deletions, filename) = line.split("\t")
196196
text2 += "%s\t%s\t%s\n" % (insertions, deletions, filename)
197197
text = text2
198198
else:
199-
text = self.repo.git.diff(self.parents[0].id, self.id, '--', numstat=True)
199+
text = self.repo.git.diff(self.parents[0].sha, self.sha, '--', numstat=True)
200200
return stats.Stats._list_from_string(self.repo, text)
201201

202202
@classmethod
@@ -259,15 +259,15 @@ def _iter_from_process_or_stream(cls, repo, proc_or_stream, from_rev_list):
259259
# END message parsing
260260
message = '\n'.join(message_lines)
261261

262-
yield Commit(repo, id=id, parents=tuple(parents), tree=tree, author=author, authored_date=authored_date,
262+
yield Commit(repo, id, parents=tuple(parents), tree=tree, author=author, authored_date=authored_date,
263263
committer=committer, committed_date=committed_date, message=message)
264264
# END for each line in stream
265265

266266

267267
def __str__(self):
268268
""" Convert commit to string which is SHA1 """
269-
return self.id
269+
return self.sha
270270

271271
def __repr__(self):
272-
return '<git.Commit "%s">' % self.id
272+
return '<git.Commit "%s">' % self.sha
273273

‎lib/git/objects/tag.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ class TagObject(base.Object):
1717
type = "tag"
1818
__slots__ = ( "object", "tag", "tagger", "tagged_date", "message" )
1919

20-
def __init__(self, repo, id, object=None, tag=None,
20+
def __init__(self, repo, sha, object=None, tag=None,
2121
tagger=None, tagged_date=None, message=None):
2222
"""
2323
Initialize a tag object with additional data
2424
2525
``repo``
2626
repository this object is located in
2727
28-
``id``
28+
``sha``
2929
SHA1 or ref suitable for git-rev-parse
3030
3131
``object``
@@ -41,7 +41,7 @@ def __init__(self, repo, id, object=None, tag=None,
4141
is the DateTime of the tag creation - use time.gmtime to convert
4242
it into a different format
4343
"""
44-
super(TagObject, self).__init__(repo, id )
44+
super(TagObject, self).__init__(repo, sha )
4545
self._set_self_from_args_(locals())
4646

4747
def _set_cache_(self, attr):

‎lib/git/objects/tree.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ class Tree(base.IndexObject, diff.Diffable):
4343
tree_id = 040
4444

4545

46-
def __init__(self, repo, id, mode=0, path=None):
47-
super(Tree, self).__init__(repo, id, mode, path)
46+
def __init__(self, repo, sha, mode=0, path=None):
47+
super(Tree, self).__init__(repo, sha, mode, path)
4848

4949
def _set_cache_(self, attr):
5050
if attr == "_cache":
@@ -150,7 +150,7 @@ def __div__(self, file):
150150

151151

152152
def __repr__(self):
153-
return '<git.Tree "%s">' % self.id
153+
return '<git.Tree "%s">' % self.sha
154154

155155
@classmethod
156156
def _iter_recursive(cls, repo, tree, cur_depth, max_depth, predicate, prune ):

‎lib/git/refs.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -312,17 +312,17 @@ def _set_reference(self, ref):
312312
if isinstance(ref, Head):
313313
write_value = "ref: %s" % ref.path
314314
elif isinstance(ref, Commit):
315-
write_value = ref.id
315+
write_value = ref.sha
316316
else:
317317
try:
318-
write_value = ref.commit.id
318+
write_value = ref.commit.sha
319319
except AttributeError:
320320
sha = str(ref)
321321
try:
322322
obj = Object.new(self.repo, sha)
323323
if obj.type != "commit":
324324
raise TypeError("Invalid object type behind sha: %s" % sha)
325-
write_value = obj.id
325+
write_value = obj.sha
326326
except Exception:
327327
raise ValueError("Could not extract object from %s" % ref)
328328
# END end try string
@@ -428,7 +428,7 @@ class Head(Reference):
428428
>>> head.commit
429429
<git.Commit "1c09f116cbc2cb4100fb6935bb162daa4723f455">
430430
431-
>>> head.commit.id
431+
>>> head.commit.sha
432432
'1c09f116cbc2cb4100fb6935bb162daa4723f455'
433433
"""
434434
_common_path_default = "refs/heads"

‎lib/git/repo.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,7 @@ def blame(self, rev, file):
622622
sha = info['id']
623623
c = commits.get(sha)
624624
if c is None:
625-
c = Commit( self, id=sha,
625+
c = Commit( self, sha,
626626
author=Actor._from_string(info['author'] + ' ' + info['author_email']),
627627
authored_date=info['author_date'],
628628
committer=Actor._from_string(info['committer'] + ' ' + info['committer_email']),

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL