( )⚙ D3197 context: add deprecation warnings for deprecated types of changeids

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3197

context: add deprecation warnings for deprecated types of changeids
ClosedPublic

Authored by martinvonz on Apr 8 2018, 1:04 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG8475c9bf096d: context: add deprecation warnings for deprecated types of changeids
Summary

It's close to code freeze, and dropping support for repo['123'] and
repo ['my-bookmark'] and repo['deadbeef'] is pretty dispruptive, so
this just adds deprecation warnings so extensions can easily find the
places they need to fix.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

martinvonz created this revision.Apr 8 2018, 1:04 PM
martinvonz added a comment.Apr 8 2018, 1:06 PM

I finally got this done enough to send. I'll be away for five days now, but hopefully this is close enough that I can do any polish after I get back but still before the freeze.

Closed by commit rHG8475c9bf096d: context: add deprecation warnings for deprecated types of changeids (authored by martinvonz). · Explain WhyApr 11 2018, 8:32 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/context.py (27 lines)

Diff 7889

mercurial/context.py

for rfiles, sfiles in zip(r, s): for rfiles, sfiles in zip(r, s):
rfiles.extend("%s/%s" % (subpath, f) for f in sfiles) rfiles.extend("%s/%s" % (subpath, f) for f in sfiles)
for l in r: for l in r:
l.sort() l.sort()
return r return r
def changectxdeprecwarn(repo):
# changectx's constructor will soon lose support for these forms of
# changeids:
# * stringinfied ints
# * bookmarks, tags, branches, and other namespace identifiers
# * hex nodeid prefixes
#
# Depending on your use case, replace repo[x] by one of these:
# * If you want to support general revsets, use scmutil.revsingle(x)
# * If you know that "x" is a stringified int, use repo[int(x)]
# * If you know that "x" is a bookmark, use repo._bookmarks.changectx(x)
# * If you know that "x" is a tag, use repo[repo.tags()[x]]
# * If you know that "x" is a branch or in some other namespace,
# use the appropriate mechanism for that namespace
# * If you know that "x" is a hex nodeid prefix, use
# repo[scmutil.resolvepartialhexnodeid(repo, x)]
# * If "x" is a string that can be any of the above, but you don't want
# to allow general revsets (perhaps because "x" may come from a remote
# user and the revset may be too costly), use scmutil.revsymbol(repo, x)
# * If "x" can be a mix of the above, you'll have to figure it out
# yourself
repo.ui.deprecwarn("changectx.__init__ is getting more limited, see source "
"for details", "4.6")
class changectx(basectx): class changectx(basectx):
"""A changecontext object makes access to data related to a particular """A changecontext object makes access to data related to a particular
changeset convenient. It represents a read-only context already present in changeset convenient. It represents a read-only context already present in
the repo.""" the repo."""
def __init__(self, repo, changeid='.'): def __init__(self, repo, changeid='.'):
"""changeid is a revision number, node, or tag""" """changeid is a revision number, node, or tag"""
super(changectx, self).__init__(repo) super(changectx, self).__init__(repo)
raise ValueError raise ValueError
l = len(repo.changelog) l = len(repo.changelog)
if r < 0: if r < 0:
r += l r += l
if r < 0 or r >= l and r != wdirrev: if r < 0 or r >= l and r != wdirrev:
raise ValueError raise ValueError
self._rev = r self._rev = r
self._node = repo.changelog.node(r) self._node = repo.changelog.node(r)
changectxdeprecwarn(repo)
return return
except error.FilteredIndexError: except error.FilteredIndexError:
raise raise
except (ValueError, OverflowError, IndexError): except (ValueError, OverflowError, IndexError):
pass pass
if len(changeid) == 40: if len(changeid) == 40:
try: try:
self._node = bin(changeid) self._node = bin(changeid)
self._rev = repo.changelog.rev(self._node) self._rev = repo.changelog.rev(self._node)
return return
except error.FilteredLookupError: except error.FilteredLookupError:
raise raise
except (TypeError, LookupError): except (TypeError, LookupError):
pass pass
# lookup bookmarks through the name interface # lookup bookmarks through the name interface
try: try:
self._node = repo.names.singlenode(repo, changeid) self._node = repo.names.singlenode(repo, changeid)
self._rev = repo.changelog.rev(self._node) self._rev = repo.changelog.rev(self._node)
changectxdeprecwarn(repo)
return return
except KeyError: except KeyError:
pass pass
self._node = scmutil.resolvepartialhexnodeid(repo, changeid) self._node = scmutil.resolvepartialhexnodeid(repo, changeid)
if self._node is not None: if self._node is not None:
self._rev = repo.changelog.rev(self._node) self._rev = repo.changelog.rev(self._node)
changectxdeprecwarn(repo)
return return
# lookup failed # lookup failed
# check if it might have come from damaged dirstate # check if it might have come from damaged dirstate
# #
# XXX we could avoid the unfiltered if we had a recognizable # XXX we could avoid the unfiltered if we had a recognizable
# exception for filtered changeset access # exception for filtered changeset access
if (repo.local() if (repo.local()