Patchwork D10793: revlog: add a function to build index entry tuple

login
register
mail settings
Submitter phabricator
Date May 30, 2021, 5:29 p.m.
Message ID <differential-rev-PHID-DREV-4lovabfexyligmkykwqc-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/49111/
State Superseded
Headers show

Comments

phabricator - May 30, 2021, 5:29 p.m.
marmoute created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  Keeping index entry as tuple make sense for performance reason, however it does
  not means we need to manually build that tuple for all piece of python code that
  are not performance critical.
  
  So we add a nice function responsible to build the tuple using argument using
  explicit keyword argument.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D10793

AFFECTED FILES
  mercurial/revlogutils/__init__.py
  mercurial/revlogutils/constants.py

CHANGE DETAILS




To: marmoute, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/mercurial/revlogutils/constants.py b/mercurial/revlogutils/constants.py
--- a/mercurial/revlogutils/constants.py
+++ b/mercurial/revlogutils/constants.py
@@ -12,6 +12,7 @@ 
 import struct
 
 from ..interfaces import repository
+from .. import revlogutils
 
 ### Internal utily constants
 
@@ -227,7 +228,7 @@ 
 
 # Chunk use a compression mode stored "inline" at the start of the chunk
 # itself.  This is the mode always used for revlog version "0" and "1"
-COMP_MODE_INLINE = 2
+COMP_MODE_INLINE = revlogutils.COMP_MODE_INLINE
 
 SUPPORTED_FLAGS = {
     REVLOGV0: REVLOGV0_FLAGS,
diff --git a/mercurial/revlogutils/__init__.py b/mercurial/revlogutils/__init__.py
--- a/mercurial/revlogutils/__init__.py
+++ b/mercurial/revlogutils/__init__.py
@@ -9,8 +9,50 @@ 
 
 from ..interfaces import repository
 
+# See mercurial.revlogutils.constants for doc
+COMP_MODE_INLINE = 2
+
 
 def offset_type(offset, type):
     if (type & ~repository.REVISION_FLAGS_KNOWN) != 0:
         raise ValueError(b'unknown revlog index flags: %d' % type)
     return int(int(offset) << 16 | type)
+
+
+def entry(
+    data_offset,
+    data_compressed_length,
+    data_delta_base,
+    link_rev,
+    parent_rev_1,
+    parent_rev_2,
+    node_id,
+    flags=0,
+    data_uncompressed_length=-1,
+    data_compression_mode=COMP_MODE_INLINE,
+    sidedata_offset=0,
+    sidedata_compressed_length=0,
+    sidedata_compression_mode=COMP_MODE_INLINE,
+):
+    """Build one entry from symbolic name
+
+    This is useful to abstract the actual detail of how we build the entry
+    tuple for caller who don't care about it.
+
+    This should always be called using keyword arguments. Some arguments have
+    default value, this match the value used by index version that does not store such data.
+    """
+    return (
+        offset_type(data_offset, flags),
+        data_compressed_length,
+        data_uncompressed_length,
+        data_delta_base,
+        link_rev,
+        parent_rev_1,
+        parent_rev_2,
+        node_id,
+        sidedata_offset,
+        sidedata_compressed_length,
+        data_compression_mode,
+        sidedata_compression_mode,
+    )