Remove deprecated oid.hex, use str(oid)

Author: jdavid

CHANGELOG.md

@@ -16,6 +16,8 @@
 
 Breaking changes:
 
+- Remove deprecated `oid.hex`, use `str(oid)`
+
 - Remove deprecated `Repository.add_submodule(...)`, use `Repository.submodules.add(...)`
 - Remove deprecated `Repository.lookup_submodule(...)`, use `Repository.submodules[...]`
 - Remove deprecated `Repository.init_submodules(...)`, use `Repository.submodules.init(...)`

pygit2/index.py

@@ -366,7 +366,7 @@ def oid(self):
     @property
     def hex(self):
         """The id of the referenced object as a hex string"""
-        return self.id.hex
+        return str(self.id)
 
     def __str__(self):
         return f'<path={self.path} id={self.hex} mode={self.mode}>'

src/oid.c

@@ -254,18 +254,8 @@ Oid_raw__get__(Oid *self)
 }
 
 
-PyDoc_STRVAR(Oid_hex__doc__, "Hex oid, a 40 chars long string (type str).\n"
-    "This attribute is deprecated, please use the built-in str()\n");
-
-PyObject *
-Oid_hex__get__(Oid *self)
-{
-    return Oid__str__(self);
-}
-
 PyGetSetDef Oid_getseters[] = {
     GETTER(Oid, raw),
-    GETTER(Oid, hex),
     {NULL},
 };
 

test/test_blob.py

@@ -83,8 +83,7 @@
 def test_read_blob(testrepo):
     blob = testrepo[BLOB_SHA]
     assert blob.hex == BLOB_SHA
-    sha = blob.id.hex
-    assert sha == BLOB_SHA
+    assert str(blob.id) == BLOB_SHA
     assert isinstance(blob, pygit2.Blob)
     assert not blob.is_binary
     assert ObjectType.BLOB == blob.type
@@ -101,7 +100,7 @@ def test_create_blob(testrepo):
     assert ObjectType.BLOB == blob.type
 
     assert blob_oid == blob.id
-    assert utils.gen_blob_sha1(BLOB_NEW_CONTENT) == blob_oid.hex
+    assert utils.gen_blob_sha1(BLOB_NEW_CONTENT) == str(blob_oid)
 
     assert BLOB_NEW_CONTENT == blob.data
     assert len(BLOB_NEW_CONTENT) == blob.size
@@ -125,7 +124,7 @@ def test_create_blob_fromworkdir(testrepo):
     assert ObjectType.BLOB == blob.type
 
     assert blob_oid == blob.id
-    assert utils.gen_blob_sha1(BLOB_FILE_CONTENT) == blob_oid.hex
+    assert utils.gen_blob_sha1(BLOB_FILE_CONTENT) == str(blob_oid)
 
     assert BLOB_FILE_CONTENT == blob.data
     assert len(BLOB_FILE_CONTENT) == blob.size
@@ -164,7 +163,7 @@ def test_create_blob_fromiobase(testrepo):
     assert ObjectType.BLOB == blob.type
 
     assert blob_oid == blob.id
-    assert BLOB_SHA == blob_oid.hex
+    assert BLOB_SHA == str(blob_oid)
 
 
 def test_diff_blob(testrepo):

test/test_branch.py

@@ -40,10 +40,10 @@
 
 def test_branches_getitem(testrepo):
     branch = testrepo.branches['master']
-    assert branch.target.hex == LAST_COMMIT
+    assert str(branch.target) == LAST_COMMIT
 
     branch = testrepo.branches.local['i18n']
-    assert branch.target.hex == I18N_LAST_COMMIT
+    assert str(branch.target) == I18N_LAST_COMMIT
     assert testrepo.branches.get('not-exists') is None
     with pytest.raises(KeyError):
         testrepo.branches['not-exists']
@@ -59,15 +59,15 @@ def test_branches_create(testrepo):
     reference = testrepo.branches.create('version1', commit)
     assert 'version1' in testrepo.branches
     reference = testrepo.branches['version1']
-    assert reference.target.hex == LAST_COMMIT
+    assert str(reference.target) == LAST_COMMIT
 
     # try to create existing reference
     with pytest.raises(ValueError):
         testrepo.branches.create('version1', commit)
 
     # try to create existing reference with force
     reference = testrepo.branches.create('version1', commit, True)
-    assert reference.target.hex == LAST_COMMIT
+    assert str(reference.target) == LAST_COMMIT
 
 
 def test_branches_delete(testrepo):
@@ -92,10 +92,10 @@ def test_branches_is_not_head(testrepo):
 
 def test_branches_rename(testrepo):
     new_branch = testrepo.branches['i18n'].rename('new-branch')
-    assert new_branch.target.hex == I18N_LAST_COMMIT
+    assert str(new_branch.target) == I18N_LAST_COMMIT
 
     new_branch_2 = testrepo.branches.get('new-branch')
-    assert new_branch_2.target.hex == I18N_LAST_COMMIT
+    assert str(new_branch_2.target) == I18N_LAST_COMMIT
 
 
 def test_branches_rename_error(testrepo):
@@ -107,7 +107,7 @@ def test_branches_rename_error(testrepo):
 def test_branches_rename_force(testrepo):
     original_branch = testrepo.branches.get('master')
     new_branch = original_branch.rename('i18n', True)
-    assert new_branch.target.hex == LAST_COMMIT
+    assert str(new_branch.target) == LAST_COMMIT
 
 
 def test_branches_rename_invalid(testrepo):
@@ -154,14 +154,14 @@ def test_branches_with_commit(testrepo):
 
 def test_lookup_branch_local(testrepo):
     branch = testrepo.lookup_branch('master')
-    assert branch.target.hex == LAST_COMMIT
+    assert str(branch.target) == LAST_COMMIT
     branch = testrepo.lookup_branch(b'master')
-    assert branch.target.hex == LAST_COMMIT
+    assert str(branch.target) == LAST_COMMIT
 
     branch = testrepo.lookup_branch('i18n', BranchType.LOCAL)
-    assert branch.target.hex == I18N_LAST_COMMIT
+    assert str(branch.target) == I18N_LAST_COMMIT
     branch = testrepo.lookup_branch(b'i18n', BranchType.LOCAL)
-    assert branch.target.hex == I18N_LAST_COMMIT
+    assert str(branch.target) == I18N_LAST_COMMIT
 
     assert testrepo.lookup_branch('not-exists') is None
     assert testrepo.lookup_branch(b'not-exists') is None
@@ -183,17 +183,17 @@ def test_create_branch(testrepo):
     refs = testrepo.listall_branches()
     assert 'version1' in refs
     reference = testrepo.lookup_branch('version1')
-    assert reference.target.hex == LAST_COMMIT
+    assert str(reference.target) == LAST_COMMIT
     reference = testrepo.lookup_branch(b'version1')
-    assert reference.target.hex == LAST_COMMIT
+    assert str(reference.target) == LAST_COMMIT
 
     # try to create existing reference
     with pytest.raises(ValueError):
         testrepo.create_branch('version1', commit)
 
     # try to create existing reference with force
     reference = testrepo.create_branch('version1', commit, True)
-    assert reference.target.hex == LAST_COMMIT
+    assert str(reference.target) == LAST_COMMIT
 
 
 def test_delete(testrepo):
@@ -233,10 +233,10 @@ def test_branch_is_checked_out_returns_false_if_branch_is_not_checked_out(testre
 def test_branch_rename_succeeds(testrepo):
     original_branch = testrepo.lookup_branch('i18n')
     new_branch = original_branch.rename('new-branch')
-    assert new_branch.target.hex == I18N_LAST_COMMIT
+    assert str(new_branch.target) == I18N_LAST_COMMIT
 
     new_branch_2 = testrepo.lookup_branch('new-branch')
-    assert new_branch_2.target.hex == I18N_LAST_COMMIT
+    assert str(new_branch_2.target) == I18N_LAST_COMMIT
 
 
 def test_branch_rename_fails_if_destination_already_exists(testrepo):
@@ -248,7 +248,7 @@ def test_branch_rename_fails_if_destination_already_exists(testrepo):
 def test_branch_rename_not_fails_if_force_is_true(testrepo):
     original_branch = testrepo.lookup_branch('master')
     new_branch = original_branch.rename('i18n', True)
-    assert new_branch.target.hex == LAST_COMMIT
+    assert str(new_branch.target) == LAST_COMMIT
 
 
 def test_branch_rename_fails_with_invalid_names(testrepo):

test/test_branch_empty.py

@@ -23,7 +23,6 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
-import pygit2
 import pytest
 from pygit2.enums import BranchType
 
@@ -40,7 +39,7 @@ def repo(emptyrepo):
 
 def test_branches_remote_get(repo):
     branch = repo.branches.remote.get('origin/master')
-    assert branch.target.hex == ORIGIN_MASTER_COMMIT
+    assert str(branch.target) == ORIGIN_MASTER_COMMIT
 
     assert repo.branches.remote.get('origin/not-exists') is None
 
@@ -57,7 +56,7 @@ def test_branches_remote_getitem(repo):
 
 def test_branches_upstream(repo):
     remote_master = repo.branches.remote['origin/master']
-    master = repo.branches.create('master', repo[remote_master.target.hex])
+    master = repo.branches.create('master', repo[remote_master.target])
 
     assert master.upstream is None
     master.upstream = remote_master
@@ -75,7 +74,7 @@ def set_bad_upstream():
 
 def test_branches_upstream_name(repo):
     remote_master = repo.branches.remote['origin/master']
-    master = repo.branches.create('master', repo[remote_master.target.hex])
+    master = repo.branches.create('master', repo[remote_master.target])
 
     master.upstream = remote_master
     assert master.upstream_name == 'refs/remotes/origin/master'
@@ -85,10 +84,9 @@ def test_branches_upstream_name(repo):
 # Low level API written in C, repo.remotes call these.
 #
 
-
 def test_lookup_branch_remote(repo):
     branch = repo.lookup_branch('origin/master', BranchType.REMOTE)
-    assert branch.target.hex == ORIGIN_MASTER_COMMIT
+    assert str(branch.target) == ORIGIN_MASTER_COMMIT
 
     assert repo.lookup_branch('origin/not-exists', BranchType.REMOTE) is None
 
@@ -108,7 +106,7 @@ def test_branch_remote_name(repo):
 
 def test_branch_upstream(repo):
     remote_master = repo.lookup_branch('origin/master', BranchType.REMOTE)
-    master = repo.create_branch('master', repo[remote_master.target.hex])
+    master = repo.create_branch('master', repo[remote_master.target])
 
     assert master.upstream is None
     master.upstream = remote_master
@@ -126,7 +124,7 @@ def set_bad_upstream():
 
 def test_branch_upstream_name(repo):
     remote_master = repo.lookup_branch('origin/master', BranchType.REMOTE)
-    master = repo.create_branch('master', repo[remote_master.target.hex])
+    master = repo.create_branch('master', repo[remote_master.target])
 
     master.upstream = remote_master
     assert master.upstream_name == 'refs/remotes/origin/master'

test/test_diff.py

@@ -278,16 +278,16 @@ def test_diff_ids(barerepo):
     commit_b = barerepo[COMMIT_SHA1_2]
     patch = commit_a.tree.diff_to_tree(commit_b.tree)[0]
     delta = patch.delta
-    assert delta.old_file.id.hex == '7f129fd57e31e935c6d60a0c794efe4e6927664b'
-    assert delta.new_file.id.hex == 'af431f20fc541ed6d5afede3e2dc7160f6f01f16'
+    assert str(delta.old_file.id) == '7f129fd57e31e935c6d60a0c794efe4e6927664b'
+    assert str(delta.new_file.id) == 'af431f20fc541ed6d5afede3e2dc7160f6f01f16'
 
 
 def test_diff_patchid(barerepo):
     commit_a = barerepo[COMMIT_SHA1_1]
     commit_b = barerepo[COMMIT_SHA1_2]
     diff = commit_a.tree.diff_to_tree(commit_b.tree)
     assert diff.patch == PATCH
-    assert diff.patchid.hex == PATCHID
+    assert str(diff.patchid) == PATCHID
 
 
 def test_hunk_content(barerepo):

test/test_index.py

@@ -148,15 +148,15 @@ def test_read_tree(testrepo):
     assert len(index) == 1
     # Test read-write returns the same oid
     oid = index.write_tree()
-    assert oid.hex == tree_oid
+    assert str(oid) == tree_oid
     # Test the index is only modified in memory
     index.read()
     assert len(index) == 2
 
 
 def test_write_tree(testrepo):
     oid = testrepo.index.write_tree()
-    assert oid.hex == 'fd937514cb799514d4b81bb24c5fcfeb6472b245'
+    assert str(oid) == 'fd937514cb799514d4b81bb24c5fcfeb6472b245'
 
 
 def test_iter(testrepo):

test/test_note.py

@@ -49,32 +49,31 @@ def test_create_note(barerepo):
     annotated_id = barerepo.revparse_single('HEAD~3').hex
     author = committer = Signature('Foo bar', '[email protected]', 12346, 0)
     note_id = barerepo.create_note(NOTE[1], author, committer, annotated_id)
-    assert NOTE[0] == note_id.hex
+    assert NOTE[0] == str(note_id)
 
     # check the note blob
     assert NOTE[1].encode() == barerepo[note_id].data
 
 
 def test_lookup_note(barerepo):
-    annotated_id = barerepo.head.target.hex
+    annotated_id = str(barerepo.head.target)
     note = barerepo.lookup_note(annotated_id)
-    assert NOTES[0][0] == note.id.hex
+    assert NOTES[0][0] == str(note.id)
     assert NOTES[0][1] == note.message
 
 
 def test_remove_note(barerepo):
     head = barerepo.head
-    note = barerepo.lookup_note(head.target.hex)
+    note = barerepo.lookup_note(str(head.target))
     author = committer = Signature('Foo bar', '[email protected]', 12346, 0)
     note.remove(author, committer)
     with pytest.raises(KeyError):
-        barerepo.lookup_note(head.target.hex)
+        barerepo.lookup_note(str(head.target))
 
 
 def test_iterate_notes(barerepo):
     for i, note in enumerate(barerepo.notes()):
-        entry = (note.id.hex, note.message, note.annotated_id.hex)
-        assert NOTES[i] == entry
+        assert NOTES[i] == (str(note.id), note.message, str(note.annotated_id))
 
 
 def test_iterate_non_existing_ref(barerepo):

test/test_object.py

@@ -123,21 +123,21 @@ def test_short_id(testrepo):
 
     def test_obj(obj, msg):
         short_id = obj.short_id
-        msg = msg + ' short_id=' + short_id
+        msg = msg + f' short_id={short_id}'
         already = seen.get(short_id)
         if already:
-            assert already == obj.id.hex
+            assert already == str(obj.id)
         else:
-            seen[short_id] = obj.id.hex
+            seen[short_id] = str(obj.id)
             lookup = testrepo[short_id]
             assert obj.id == lookup.id
 
     for commit in testrepo.walk(testrepo.head.target):
-        test_obj(commit, 'commit#' + commit.id.hex)
+        test_obj(commit, f'commit#{commit.id}')
         tree = commit.tree
-        test_obj(tree, 'tree#' + tree.id.hex)
+        test_obj(tree, f'tree#{tree.id}')
         for entry in tree:
-            test_obj(testrepo[entry.hex], 'entry=' + entry.name + '#' + entry.hex)
+            test_obj(testrepo[entry.hex], f'entry={entry.name}#{entry.hex}')
 
 
 def test_repr(testrepo):