Deprecate IndexEntry.hex

Author: jdavid

CHANGELOG.md

@@ -19,6 +19,10 @@
 - Fix tests on EPEL8 builds for s390x
   [#1283](https://github.com/libgit2/pygit2/pull/1283)
 
+Deprecations:
+
+- Deprecate `IndexEntry.hex`, use `str(IndexEntry.id)`
+
 Breaking changes:
 
 - Remove deprecated `oid.hex`, use `str(oid)`

docs/index_file.rst

@@ -14,7 +14,7 @@ Index read::
 Iterate over all entries of the index::
 
     >>> for entry in index:
-    ...     print(entry.path, entry.hex)
+    ...     print(entry.path, entry.id)
 
 Index write::
 

docs/recipes/git-show.rst

@@ -25,7 +25,7 @@ Show log message
 Show SHA hash
 ======================================================================
 
-    >>> hash = commit.hex
+    >>> hash = str(commit.id)
 
 ======================================================================
 Show diff
@@ -51,7 +51,7 @@ Then you can make your message:
     >>>
     >>> dt      = datetime.fromtimestamp(float(commit.author.time), tzinfo)
     >>> timestr = dt.strftime('%c %z')
-    >>> msg     = '\n'.join([f'commit {commit.tree_id.hex}',
+    >>> msg     = '\n'.join([f'commit {commit.tree_id}',
     ...                      f'Author: {commit.author.name} <{commit.author.email}>',
     ...                      f'Date:   {timestr}',
     ...                      '',

pygit2/index.py

@@ -23,6 +23,7 @@
 # the Free Software Foundation, 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 
+import warnings
 import weakref
 
 # Import from pygit2
@@ -366,14 +367,15 @@ def oid(self):
     @property
     def hex(self):
         """The id of the referenced object as a hex string"""
+        warnings.warn('Use str(entry.id)', DeprecationWarning)
         return str(self.id)
 
     def __str__(self):
-        return f'<path={self.path} id={self.hex} mode={self.mode}>'
+        return f'<path={self.path} id={self.id} mode={self.mode}>'
 
     def __repr__(self):
         t = type(self)
-        return f'<{t.__module__}.{t.__qualname__} path={self.path} id={self.hex} mode={self.mode}>'
+        return f'<{t.__module__}.{t.__qualname__} path={self.path} id={self.id} mode={self.mode}>'
 
     def __eq__(self, other):
         if self is other:

test/test_index.py

@@ -54,9 +54,9 @@ def test_read(testrepo):
 
     sha = 'a520c24d85fbfc815d385957eed41406ca5a860b'
     assert 'hello.txt' in index
-    assert index['hello.txt'].hex == sha
+    assert index['hello.txt'].id == sha
     assert index['hello.txt'].path == 'hello.txt'
-    assert index[1].hex == sha
+    assert index[1].id == sha
 
 
 def test_add(testrepo):
@@ -67,7 +67,7 @@ def test_add(testrepo):
     index.add('bye.txt')
     assert 'bye.txt' in index
     assert len(index) == 3
-    assert index['bye.txt'].hex == sha
+    assert index['bye.txt'].id == sha
 
 
 def test_add_aspath(testrepo):
@@ -90,26 +90,26 @@ def test_add_all(testrepo):
     assert 'bye.txt' in index
     assert 'hello.txt' in index
 
-    assert index['bye.txt'].hex == sha_bye
-    assert index['hello.txt'].hex == sha_hello
+    assert index['bye.txt'].id == sha_bye
+    assert index['hello.txt'].id == sha_hello
 
     clear(testrepo)
 
     index.add_all(['bye.t??', 'hello.*'])
     assert 'bye.txt' in index
     assert 'hello.txt' in index
 
-    assert index['bye.txt'].hex == sha_bye
-    assert index['hello.txt'].hex == sha_hello
+    assert index['bye.txt'].id == sha_bye
+    assert index['hello.txt'].id == sha_hello
 
     clear(testrepo)
 
     index.add_all(['[byehlo]*.txt'])
     assert 'bye.txt' in index
     assert 'hello.txt' in index
 
-    assert index['bye.txt'].hex == sha_bye
-    assert index['hello.txt'].hex == sha_hello
+    assert index['bye.txt'].id == sha_bye
+    assert index['hello.txt'].id == sha_hello
 
 
 def test_add_all_aspath(testrepo):
@@ -163,8 +163,8 @@ def test_iter(testrepo):
     assert len(list(index)) == n
 
     # Compare SHAs, not IndexEntry object identity
-    entries = [index[x].hex for x in range(n)]
-    assert list(x.hex for x in index) == entries
+    entries = [index[x].id for x in range(n)]
+    assert list(x.id for x in index) == entries
 
 
 def test_mode(testrepo):
@@ -179,7 +179,7 @@ def test_mode(testrepo):
 
 def test_bare_index(testrepo):
     index = pygit2.Index(Path(testrepo.path) / 'index')
-    assert [x.hex for x in index] == [x.hex for x in testrepo.index]
+    assert [x.id for x in index] == [x.id for x in testrepo.index]
 
     with pytest.raises(pygit2.GitError):
         index.add('bye.txt')

test/test_refs.py

@@ -410,7 +410,7 @@ def test_references_iterator_invalid_filter(testrepo):
     for _ in range(4):
         curr_ref = repo.references_iterator_next(iter_all, 5)
         if curr_ref:
-            all_refs.append((curr_ref.name, curr_ref.target.hex))
+            all_refs.append((curr_ref.name, curr_ref.target))
 
     assert all_refs == []
 
@@ -420,7 +420,7 @@ def test_references_iterator_invalid_filter_python(testrepo):
     refs = []
     with pytest.raises(ValueError):
         for ref in repo.references.iterator(5):
-            refs.append((ref.name, ref.target.hex))
+            refs.append((ref.name, ref.target))
 
 
 def test_lookup_reference(testrepo):

test/test_revwalk.py

@@ -83,7 +83,7 @@ def test_hide_prefix(testrepo):
 def test_reset(testrepo):
     walker = testrepo.walk(log[0], SortMode.TIME)
     walker.reset()
-    assert [x.hex for x in walker] == []
+    assert list(walker) == []
 
 
 def test_push(testrepo):