Remove deprecated obj.hex, use str(obj.id)

jdavid · jdavid · commit 3a044d89bdc9 · 2024-03-28T09:18:10.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,7 @@
 Breaking changes:
 
 - Remove deprecated `oid.hex`, use `str(oid)`
+- Remove deprecated `object.hex`, use `str(object.id)`
 
 - Remove deprecated `Repository.add_submodule(...)`, use `Repository.submodules.add(...)`
 - Remove deprecated `Repository.lookup_submodule(...)`, use `Repository.submodules[...]`
diff --git a/src/object.c b/src/object.c
@@ -101,17 +101,6 @@ Object_oid__get__(Object *self)
     return Object_id__get__(self);
 }
 
-PyDoc_STRVAR(Object_hex__doc__,
-    "Hexadecimal representation of the object id. This is a shortcut for\n"
-    "Object.id.hex\n"
-    "This attribute is deprecated, please use 'id'\n");
-
-PyObject *
-Object_hex__get__(Object *self)
-{
-    return git_oid_to_py_str(Object__id(self));
-}
-
 
 PyDoc_STRVAR(Object_short_id__doc__,
     "An unambiguous short (abbreviated) hex Oid string for the object.");
@@ -313,7 +302,6 @@ Object_richcompare(PyObject *o1, PyObject *o2, int op)
 PyGetSetDef Object_getseters[] = {
     GETTER(Object, oid),
     GETTER(Object, id),
-    GETTER(Object, hex),
     GETTER(Object, short_id),
     GETTER(Object, type),
     GETTER(Object, type_str),
diff --git a/test/test_blob.py b/test/test_blob.py
@@ -82,7 +82,7 @@
 
 def test_read_blob(testrepo):
     blob = testrepo[BLOB_SHA]
-    assert blob.hex == BLOB_SHA
+    assert str(blob.id) == BLOB_SHA
     assert str(blob.id) == BLOB_SHA
     assert isinstance(blob, pygit2.Blob)
     assert not blob.is_binary
diff --git a/test/test_commit.py b/test/test_commit.py
@@ -90,16 +90,16 @@ def test_new_commit(barerepo):
     commit = repo[sha]
 
     assert ObjectType.COMMIT == commit.type
-    assert '98286caaab3f1fde5bf52c8369b2b0423bad743b' == commit.hex
+    assert '98286caaab3f1fde5bf52c8369b2b0423bad743b' == str(commit.id)
     assert commit.message_encoding is None
     assert message == commit.message
     assert 12346 == commit.commit_time
     assert committer == commit.committer
     assert author == commit.author
-    assert tree == commit.tree.hex
+    assert tree == str(commit.tree.id)
     assert Oid(hex=tree) == commit.tree_id
     assert 1 == len(commit.parents)
-    assert COMMIT_SHA == commit.parents[0].hex
+    assert COMMIT_SHA == str(commit.parents[0].id)
     assert Oid(hex=COMMIT_SHA) == commit.parent_ids[0]
 
 
@@ -124,10 +124,10 @@ def test_new_commit_encoding(barerepo):
     assert 12346 == commit.commit_time
     assert committer == commit.committer
     assert author == commit.author
-    assert tree == commit.tree.hex
+    assert tree == str(commit.tree.id)
     assert Oid(hex=tree) == commit.tree_id
     assert 1 == len(commit.parents)
-    assert COMMIT_SHA == commit.parents[0].hex
+    assert COMMIT_SHA == str(commit.parents[0].id)
     assert Oid(hex=COMMIT_SHA) == commit.parent_ids[0]
 
 
diff --git a/test/test_commit_gpg.py b/test/test_commit_gpg.py
@@ -100,10 +100,10 @@ def test_commit_signing(gpgsigned):
         offset=-480,
     )
     tree = '4b825dc642cb6eb9a060e54bf8d69288fbee4904'
-    parents = ['8496071c1b46c854b31185ea97743be6a8774479']
+    parent = '8496071c1b46c854b31185ea97743be6a8774479'
 
     # create commit string
-    commit_string = repo.create_commit_string(author, committer, message, tree, parents)
+    commit_string = repo.create_commit_string(author, committer, message, tree, [parent])
     assert commit_string == content
 
     # create/retrieve signed commit
@@ -118,17 +118,17 @@ def test_commit_signing(gpgsigned):
 
     # perform sanity checks
     assert ObjectType.COMMIT == commit.type
-    assert '6569fdf71dbd99081891154641869c537784a3ba' == commit.hex
+    assert '6569fdf71dbd99081891154641869c537784a3ba' == str(commit.id)
     assert commit.message_encoding is None
     assert message == commit.message
     assert 1358451456 == commit.commit_time
     assert committer == commit.committer
     assert author == commit.author
-    assert tree == commit.tree.hex
+    assert tree == str(commit.tree.id)
     assert Oid(hex=tree) == commit.tree_id
     assert 1 == len(commit.parents)
-    assert parents[0] == commit.parents[0].hex
-    assert Oid(hex=parents[0]) == commit.parent_ids[0]
+    assert parent == str(commit.parents[0].id)
+    assert Oid(hex=parent) == commit.parent_ids[0]
 
 
 def test_get_gpg_signature_when_unsigned(gpgsigned):
diff --git a/test/test_note.py b/test/test_note.py
@@ -46,9 +46,9 @@
 
 
 def test_create_note(barerepo):
-    annotated_id = barerepo.revparse_single('HEAD~3').hex
+    annotated_id = barerepo.revparse_single('HEAD~3').id
     author = committer = Signature('Foo bar', 'foo@bar.com', 12346, 0)
-    note_id = barerepo.create_note(NOTE[1], author, committer, annotated_id)
+    note_id = barerepo.create_note(NOTE[1], author, committer, str(annotated_id))
     assert NOTE[0] == str(note_id)
 
     # check the note blob
diff --git a/test/test_object.py b/test/test_object.py
@@ -136,7 +136,7 @@ def test_obj(obj, msg):
         tree = commit.tree
         test_obj(tree, f'tree#{tree.id}')
         for entry in tree:
-            test_obj(testrepo[entry.hex], f'entry={entry.name}#{entry.hex}')
+            test_obj(testrepo[entry.id], f'entry={entry.name}#{entry.id}')
 
 
 def test_repr(testrepo):
diff --git a/test/test_refs.py b/test/test_refs.py
@@ -60,8 +60,8 @@ def test_refs_list(testrepo):
 
 def test_head(testrepo):
     head = testrepo.head
-    assert LAST_COMMIT == testrepo[head.target].hex
-    assert LAST_COMMIT == testrepo[head.raw_target].hex
+    assert LAST_COMMIT == str(testrepo[head.target].id)
+    assert LAST_COMMIT == str(testrepo[head.raw_target].id)
 
 
 def test_refs_getitem(testrepo):
@@ -484,27 +484,27 @@ def test_resolve_refish(testrepo):
 
     commit, ref = repo.resolve_refish('refs/heads/i18n')
     assert ref.name == 'refs/heads/i18n'
-    assert commit.hex == '5470a671a80ac3789f1a6a8cefbcf43ce7af0563'
+    assert str(commit.id) == '5470a671a80ac3789f1a6a8cefbcf43ce7af0563'
 
     commit, ref = repo.resolve_refish('master')
     assert ref.name == 'refs/heads/master'
-    assert commit.hex == LAST_COMMIT
+    assert str(commit.id) == LAST_COMMIT
 
     commit, ref = repo.resolve_refish('origin/master')
     assert ref.name == 'refs/remotes/origin/master'
-    assert commit.hex == LAST_COMMIT
+    assert str(commit.id) == LAST_COMMIT
 
     commit, ref = repo.resolve_refish('version1')
     assert ref.name == 'refs/tags/version1'
-    assert commit.hex == LAST_COMMIT
+    assert str(commit.id) == LAST_COMMIT
 
     commit, ref = repo.resolve_refish(LAST_COMMIT)
     assert ref is None
-    assert commit.hex == LAST_COMMIT
+    assert str(commit.id) == LAST_COMMIT
 
     commit, ref = repo.resolve_refish('HEAD~1')
     assert ref is None
-    assert commit.hex == '5ebeeebb320790caf276b9fc8b24546d63316533'
+    assert str(commit.id) == '5ebeeebb320790caf276b9fc8b24546d63316533'
 
 
 def test_reference_get_sha(testrepo):
diff --git a/test/test_repository.py b/test/test_repository.py
@@ -85,7 +85,7 @@ def test_checkout_ref(testrepo):
 
     head = testrepo.head
     head = testrepo[head.target]
-    assert head.hex == str(ref_i18n.target)
+    assert head.id == ref_i18n.target
     assert 'new' in head.tree
     assert 'bye.txt' not in testrepo.status()
 
@@ -180,7 +180,7 @@ def test_checkout_branch(testrepo):
 
     head = testrepo.head
     head = testrepo[head.target]
-    assert head.hex == str(branch_i18n.target)
+    assert head.id == branch_i18n.target
     assert 'new' in head.tree
     assert 'bye.txt' not in testrepo.status()
 
diff --git a/test/test_repository_bare.py b/test/test_repository_bare.py
@@ -115,24 +115,24 @@ def test_iterable(barerepo):
 def test_lookup_blob(barerepo):
     with pytest.raises(TypeError):
         barerepo[123]
-    assert barerepo[BLOB_OID].hex == BLOB_HEX
+    assert str(barerepo[BLOB_OID].id) == BLOB_HEX
     a = barerepo[BLOB_HEX]
     assert b'a contents\n' == a.read_raw()
-    assert BLOB_HEX == a.hex
+    assert BLOB_HEX == str(a.id)
     assert ObjectType.BLOB == a.type
 
 
 def test_lookup_blob_prefix(barerepo):
     a = barerepo[BLOB_HEX[:5]]
     assert b'a contents\n' == a.read_raw()
-    assert BLOB_HEX == a.hex
+    assert BLOB_HEX == str(a.id)
     assert ObjectType.BLOB == a.type
 
 
 def test_lookup_commit(barerepo):
     commit_sha = '5fe808e8953c12735680c257f56600cb0de44b10'
     commit = barerepo[commit_sha]
-    assert commit_sha == commit.hex
+    assert commit_sha == str(commit.id)
     assert ObjectType.COMMIT == commit.type
     assert commit.message == (
         'Second test data commit.\n\n' 'This commit has some additional text.\n'
@@ -144,7 +144,7 @@ def test_lookup_commit_prefix(barerepo):
     commit_sha_prefix = commit_sha[:7]
     too_short_prefix = commit_sha[:3]
     commit = barerepo[commit_sha_prefix]
-    assert commit_sha == commit.hex
+    assert commit_sha == str(commit.id)
     assert ObjectType.COMMIT == commit.type
     assert (
         'Second test data commit.\n\n'
@@ -183,7 +183,7 @@ def test_get_workdir(barerepo):
 
 def test_revparse_single(barerepo):
     parent = barerepo.revparse_single('HEAD^')
-    assert parent.hex == PARENT_SHA
+    assert str(parent.id) == PARENT_SHA
 
 
 def test_hash(barerepo):
diff --git a/test/test_revparse.py b/test/test_revparse.py
@@ -35,47 +35,47 @@
 
 def test_revparse_single(testrepo):
     o = testrepo.revparse_single('HEAD')
-    assert o.hex == HEAD_SHA
+    assert str(o.id) == HEAD_SHA
 
     o = testrepo.revparse_single('HEAD^')
-    assert o.hex == PARENT_SHA
+    assert str(o.id) == PARENT_SHA
 
     o = testrepo.revparse_single('@{-1}')
-    assert o.hex == '5470a671a80ac3789f1a6a8cefbcf43ce7af0563'
+    assert str(o.id) == '5470a671a80ac3789f1a6a8cefbcf43ce7af0563'
 
 
 def test_revparse_ext(testrepo):
     o, r = testrepo.revparse_ext('master')
-    assert o.hex == HEAD_SHA
+    assert str(o.id) == HEAD_SHA
     assert r == testrepo.references['refs/heads/master']
 
     o, r = testrepo.revparse_ext('HEAD^')
-    assert o.hex == PARENT_SHA
+    assert str(o.id) == PARENT_SHA
     assert r is None
 
     o, r = testrepo.revparse_ext('i18n')
-    assert o.hex.startswith('5470a67')
+    assert str(o.id).startswith('5470a67')
     assert r == testrepo.references['refs/heads/i18n']
 
 
 def test_revparse_1(testrepo):
     s = testrepo.revparse('master')
-    assert s.from_object.hex == HEAD_SHA
+    assert str(s.from_object.id) == HEAD_SHA
     assert s.to_object is None
     assert s.flags == RevSpecFlag.SINGLE
 
 
 def test_revparse_range_1(testrepo):
     s = testrepo.revparse('HEAD^1..acecd5e')
-    assert s.from_object.hex == PARENT_SHA
-    assert s.to_object.hex.startswith('acecd5e')
+    assert str(s.from_object.id) == PARENT_SHA
+    assert str(s.to_object.id).startswith('acecd5e')
     assert s.flags == RevSpecFlag.RANGE
 
 
 def test_revparse_range_2(testrepo):
     s = testrepo.revparse('HEAD...i18n')
-    assert s.from_object.hex.startswith('2be5719')
-    assert s.to_object.hex.startswith('5470a67')
+    assert str(s.from_object.id).startswith('2be5719')
+    assert str(s.to_object.id).startswith('5470a67')
     assert s.flags == RevSpecFlag.RANGE | RevSpecFlag.MERGE_BASE
     assert testrepo.merge_base(s.from_object.id, s.to_object.id) is not None
 
diff --git a/test/test_revwalk.py b/test/test_revwalk.py
@@ -60,12 +60,12 @@ def test_log(testrepo):
 
 def test_walk(testrepo):
     walker = testrepo.walk(log[0], SortMode.TIME)
-    assert [x.hex for x in walker] == log
+    assert [str(x.id) for x in walker] == log
 
 
 def test_reverse(testrepo):
     walker = testrepo.walk(log[0], SortMode.TIME | SortMode.REVERSE)
-    assert [x.hex for x in walker] == list(reversed(log))
+    assert [str(x.id) for x in walker] == list(reversed(log))
 
 
 def test_hide(testrepo):
@@ -88,16 +88,16 @@ def test_reset(testrepo):
 
 def test_push(testrepo):
     walker = testrepo.walk(log[-1], SortMode.TIME)
-    assert [x.hex for x in walker] == log[-1:]
+    assert [str(x.id) for x in walker] == log[-1:]
     walker.reset()
     walker.push(log[0])
-    assert [x.hex for x in walker] == log
+    assert [str(x.id) for x in walker] == log
 
 
 def test_sort(testrepo):
     walker = testrepo.walk(log[0], SortMode.TIME)
     walker.sort(SortMode.TIME | SortMode.REVERSE)
-    assert [x.hex for x in walker] == list(reversed(log))
+    assert [str(x.id) for x in walker] == list(reversed(log))
 
 
 def test_simplify_first_parent(testrepo):
diff --git a/test/test_tag.py b/test/test_tag.py
@@ -63,12 +63,12 @@ def test_new_tag(barerepo):
     sha = barerepo.create_tag(name, target_prefix, ObjectType.BLOB, tagger, message)
     tag = barerepo[sha]
 
-    assert '3ee44658fd11660e828dfc96b9b5c5f38d5b49bb' == tag.hex
+    assert '3ee44658fd11660e828dfc96b9b5c5f38d5b49bb' == str(tag.id)
     assert name == tag.name
     assert target == str(tag.target)
     assert tagger == tag.tagger
     assert message == tag.message
-    assert name == barerepo[tag.hex].name
+    assert name == barerepo[tag.id].name
 
 
 def test_modify_tag(barerepo):
diff --git a/test/test_tree.py b/test/test_tree.py
@@ -37,7 +37,7 @@
 
 
 def assertTreeEntryEqual(entry, sha, name, filemode):
-    assert entry.hex == sha
+    assert str(entry.id) == sha
     assert entry.name == name
     assert entry.filemode == filemode
     assert entry.raw_name == name.encode('utf-8')
diff --git a/test/test_treebuilder.py b/test/test_treebuilder.py
@@ -55,7 +55,7 @@ def test_rebuild_treebuilder(barerepo):
     for entry in tree:
         name = entry.name
         assert bld.get(name) is None
-        bld.insert(name, entry.hex, entry.filemode)
+        bld.insert(name, entry.id, entry.filemode)
         assert bld.get(name).id == entry.id
     result = bld.write()
 
