( )⚙ D6809 revlog: return sidedata map from `_revisiondata`

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6809

revlog: return sidedata map from `_revisiondata`
ClosedPublic

Authored by marmoute on Sep 7 2019, 5:28 AM.

Details

Reviewers
yuja
durin42
indygreg
Group Reviewers
hg-reviewers
Commits
rHG35ab2c1a58aa: revlog: return sidedata map from `_revisiondata`
Summary

Nothing extra any side data yet. However, it will happens in the future. So we
better prepare the callers of the _revisiondata to deal with it.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

marmoute created this revision.Sep 7 2019, 5:28 AM
marmoute updated this revision to Diff 16475.Sep 9 2019, 5:23 PM
durin42 accepted this revision.Sep 17 2019, 2:08 PM
This revision is now accepted and ready to land.Sep 17 2019, 2:08 PM
marmoute added a commit: rHG35ab2c1a58aa: revlog: return sidedata map from `_revisiondata`.Sep 27 2019, 11:05 AM
Closed by commit rHG35ab2c1a58aa: revlog: return sidedata map from `_revisiondata` (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/revlog.py (15 lines)

Diff 16475

mercurial/revlog.py

raw - an optional argument specifying if the revision data is to be raw - an optional argument specifying if the revision data is to be
treated as raw data when applying flag transforms. 'raw' should be set treated as raw data when applying flag transforms. 'raw' should be set
to True when generating changegroups or in debug commands. to True when generating changegroups or in debug commands.
""" """
if raw: if raw:
msg = ('revlog.revision(..., raw=True) is deprecated, ' msg = ('revlog.revision(..., raw=True) is deprecated, '
'use revlog.rawdata(...)') 'use revlog.rawdata(...)')
util.nouideprecwarn(msg, '5.2', stacklevel=2) util.nouideprecwarn(msg, '5.2', stacklevel=2)
return self._revisiondata(nodeorrev, _df, raw=raw) return self._revisiondata(nodeorrev, _df, raw=raw)[0]
def sidedata(self, nodeorrev, _df=None): def sidedata(self, nodeorrev, _df=None):
"""a map of extra data related to the changeset but not part of the hash """a map of extra data related to the changeset but not part of the hash
This function currently return a dictionary. However, more advanced This function currently return a dictionary. However, more advanced
mapping object will likely be used in the future for a more mapping object will likely be used in the future for a more
efficient/lazy code. efficient/lazy code.
""" """
# XXX will actualy return data once storage is implemented. # XXX will actualy return data once storage is implemented.
return {} return {}
def _revisiondata(self, nodeorrev, _df=None, raw=False): def _revisiondata(self, nodeorrev, _df=None, raw=False):
# deal with <nodeorrev> argument type # deal with <nodeorrev> argument type
if isinstance(nodeorrev, int): if isinstance(nodeorrev, int):
rev = nodeorrev rev = nodeorrev
node = self.node(rev) node = self.node(rev)
else: else:
node = nodeorrev node = nodeorrev
rev = None rev = None
# fast path the special `nullid` rev # fast path the special `nullid` rev
if node == nullid: if node == nullid:
return "" return "", {}
# The text as stored inside the revlog. Might be the revision or might # The text as stored inside the revlog. Might be the revision or might
# need to be processed to retrieve the revision. # need to be processed to retrieve the revision.
rawtext = None rawtext = None
rev, rawtext, validated = self._rawtext(node, rev, _df=_df) rev, rawtext, validated = self._rawtext(node, rev, _df=_df)
if raw and validated: if raw and validated:
# if we don't want to process the raw text and that raw # if we don't want to process the raw text and that raw
# text is cached, we can exit early. # text is cached, we can exit early.
return rawtext return rawtext, {}
if rev is None: if rev is None:
rev = self.rev(node) rev = self.rev(node)
# the revlog's flag for this revision # the revlog's flag for this revision
# (usually alter its state or content) # (usually alter its state or content)
flags = self.flags(rev) flags = self.flags(rev)
if validated and flags == REVIDX_DEFAULT_FLAGS: if validated and flags == REVIDX_DEFAULT_FLAGS:
# no extra flags set, no flag processor runs, text = rawtext # no extra flags set, no flag processor runs, text = rawtext
return rawtext return rawtext, {}
sidedata = {}
if raw: if raw:
validatehash = self._processflagsraw(rawtext, flags) validatehash = self._processflagsraw(rawtext, flags)
text = rawtext text = rawtext
else: else:
text, validatehash = self._processflagsread(rawtext, flags) text, validatehash = self._processflagsread(rawtext, flags)
if validatehash: if validatehash:
self.checkhash(text, node, rev=rev) self.checkhash(text, node, rev=rev)
if not validated: if not validated:
self._revisioncache = (node, rev, rawtext) self._revisioncache = (node, rev, rawtext)
return text return text, sidedata
def _rawtext(self, node, rev, _df=None): def _rawtext(self, node, rev, _df=None):
"""return the possibly unvalidated rawtext for a revision """return the possibly unvalidated rawtext for a revision
returns (rev, rawtext, validated) returns (rev, rawtext, validated)
""" """
# revision in the cache (could be useful to apply delta) # revision in the cache (could be useful to apply delta)
del basetext # let us have a chance to free memory early del basetext # let us have a chance to free memory early
return (rev, rawtext, False) return (rev, rawtext, False)
def rawdata(self, nodeorrev, _df=None): def rawdata(self, nodeorrev, _df=None):
"""return an uncompressed raw data of a given node or revision number. """return an uncompressed raw data of a given node or revision number.
_df - an existing file handle to read from. (internal-only) _df - an existing file handle to read from. (internal-only)
""" """
return self._revisiondata(nodeorrev, _df, raw=True) return self._revisiondata(nodeorrev, _df, raw=True)[0]
def hash(self, text, p1, p2): def hash(self, text, p1, p2):
"""Compute a node hash. """Compute a node hash.
Available as a function so that subclasses can replace the hash Available as a function so that subclasses can replace the hash
as needed. as needed.
""" """
return storageutil.hashrevisionsha1(text, p1, p2) return storageutil.hashrevisionsha1(text, p1, p2)