D6501: state: created new class statecheck to handle unfinishedstates
taapas1128 (Taapas Agrawal)
phabricator at mercurial-scm.org
Sat Jun 15 06:40:38 EDT 2019
taapas1128 edited the summary of this revision.
taapas1128 updated this revision to Diff 15527.
REPOSITORY
rHG Mercurial
CHANGES SINCE LAST UPDATE
https://phab.mercurial-scm.org/D6501?vs=15514&id=15527
CHANGES SINCE LAST ACTION
https://phab.mercurial-scm.org/D6501/new/
REVISION DETAIL
https://phab.mercurial-scm.org/D6501
AFFECTED FILES
hgext/histedit.py
hgext/rebase.py
hgext/shelve.py
hgext/transplant.py
mercurial/state.py
CHANGE DETAILS
diff --git a/mercurial/state.py b/mercurial/state.py
--- a/mercurial/state.py
+++ b/mercurial/state.py
@@ -88,16 +88,82 @@
"""check whether the state file exists or not"""
return self._repo.vfs.exists(self.fname)
-# A list of state files kept by multistep operations like graft.
-# Since graft cannot be aborted, it is considered 'clearable' by update.
-# note: bisect is intentionally excluded
-# (state file, clearable, allowcommit, error, hint)
-unfinishedstates = [
- ('graftstate', True, False, _('graft in progress'),
- _("use 'hg graft --continue' or 'hg graft --stop' to stop")),
- ('updatestate', True, False, _('last update was interrupted'),
- _("use 'hg update' to get a consistent checkout"))
- ]
+class statecheck(object):
+ """a utility class that deals with multistep operations like graft,
+ histedit, bisect, update etc and check whether such commands
+ are in an unfinished conditition of not and return appropriate message
+ and hint.
+ It also has the ability to register and determine the states of any new
+ multistep operation or multistep command extension.
+ """
+
+ def __init__(self, cmdname, fname, clearable=False, allowcommit=False,
+ cmdmsg="", cmdhint=""):
+ """cmdname is the name the command
+ fname is the file name in which data should be stored in .hg directory.
+ It is None for merge command.
+ clearable boolean determines whether or not interrupted states can be
+ cleared by running `hg update -C .` which in turn deletes the
+ state file.
+ allowcommit boolean decides whether commit is allowed during interrupted
+ state or not.
+ cmdmsg is used to pass a different status message in case standard
+ message of the format "abort: cmdname in progress" is not required.
+ cmdhint is used to pass a different hint message in case standard
+ message of the format use 'hg cmdname --continue' or
+ 'hg cmdname --abort'" is not required.
+ """
+ self._cmdname = cmdname
+ self._fname = fname
+ self._clearable = clearable
+ self._allowcommit = allowcommit
+ self._cmdhint = cmdhint
+ self._cmdmsg = cmdmsg
+
+ def hint(self):
+ """returns the hint message corresponding to the command"""
+ if not self._cmdhint:
+ return (_("use 'hg %s --continue' or 'hg %s --abort'") %
+ (self._cmdname, self._cmdname))
+ return self._cmdhint
+
+ def msg(self):
+ """returns the status message corresponding to the command"""
+ if not self._cmdmsg:
+ return _('%s in progress') % (self._cmdname)
+ return self._cmdmsg
+
+ def isunfinished(self, repo):
+ """determines whether a multi-step operation is in progress or not"""
+ return repo.vfs.exists(self._fname)
+
+# A list of statecheck objects for multistep operations like graft.
+unfinishedstates = []
+
+def addunfinished(cmddata):
+ """this accepts a dict having command data, makes a statecheck object and
+ adds it to the unfinishedstate object list
+ """
+ statecheckobj = statecheck(**cmddata)
+ unfinishedstates.append(statecheckobj)
+
+graftdata = {
+ 'cmdname': 'graft',
+ 'fname': 'graftstate',
+ 'clearable': True,
+ 'allowcommit': False,
+ 'cmdhint': _("use 'hg graft --continue' or 'hg graft --stop' to stop")
+}
+addunfinished(graftdata)
+updatedata = {
+ 'cmdname': 'update',
+ 'fname': 'updatestate',
+ 'clearable': True,
+ 'allowcommit':False,
+ 'cmdmsg': _('last update was interrupted'),
+ 'cmdhint':_("use 'hg update' to get a consistent checkout")
+}
+addunfinished(updatedata)
def checkunfinished(repo, commit=False):
'''Look for an unfinished multistep operation, like graft, and abort
@@ -106,25 +172,26 @@
'''
# Check for non-clearable states first, so things like rebase will take
# precedence over update.
- for f, clearable, allowcommit, msg, hint in unfinishedstates:
- if clearable or (commit and allowcommit):
+ for state in unfinishedstates:
+ if state._clearable or (commit and state._allowcommit):
continue
- if repo.vfs.exists(f):
- raise error.Abort(msg, hint=hint)
+ if state.isunfinished(repo):
+ raise error.Abort(state.msg(), hint=state.hint())
- for f, clearable, allowcommit, msg, hint in unfinishedstates:
- if not clearable or (commit and allowcommit):
+ for s in unfinishedstates:
+ if not s._clearable or (commit and s._allowcommit):
continue
- if repo.vfs.exists(f):
- raise error.Abort(msg, hint=hint)
+ if s.isunfinished(repo):
+ raise error.Abort(s.msg(), hint=s.hint())
def clearunfinished(repo):
'''Check for unfinished operations (as above), and clear the ones
that are clearable.
'''
- for f, clearable, allowcommit, msg, hint in unfinishedstates:
- if not clearable and repo.vfs.exists(f):
- raise error.Abort(msg, hint=hint)
- for f, clearable, allowcommit, msg, hint in unfinishedstates:
- if clearable and repo.vfs.exists(f):
- util.unlink(repo.vfs.join(f))
+ for state in unfinishedstates:
+ if not state._clearable and state.isunfinished(repo):
+ raise error.Abort(state.msg(), hint=state.hint())
+
+ for s in unfinishedstates:
+ if s._clearable and s.isunfinished(repo):
+ util.unlink(repo.vfs.join(s._fname))
diff --git a/hgext/transplant.py b/hgext/transplant.py
--- a/hgext/transplant.py
+++ b/hgext/transplant.py
@@ -758,9 +758,14 @@
return n and nodemod.hex(n) or ''
def extsetup(ui):
- statemod.unfinishedstates.append(
- ['transplant/journal', True, False, _('transplant in progress'),
- _("use 'hg transplant --continue' or 'hg update' to abort")])
+ transplantdata = {
+ 'cmdname': 'transplant',
+ 'fname': 'transplant/journal',
+ 'clearable': True,
+ 'allowcommit': False,
+ 'cmdhint': _("use 'hg transplant --continue' or 'hg update' to abort")
+ }
+ statemod.addunfinished(transplantdata)
# tell hggettext to extract docstrings from these functions:
i18nfunctions = [revsettransplanted, kwtransplanted]
diff --git a/hgext/shelve.py b/hgext/shelve.py
--- a/hgext/shelve.py
+++ b/hgext/shelve.py
@@ -1140,10 +1140,13 @@
return createcmd(ui, repo, pats, opts)
def extsetup(ui):
- statemod.unfinishedstates.append(
- [shelvedstate._filename, False, False,
- _('unshelve already in progress'),
- _("use 'hg unshelve --continue' or 'hg unshelve --abort'")])
+ unshelvedata = {
+ 'cmdname': 'unshelve',
+ 'fname': shelvedstate._filename,
+ 'clearable': False,
+ 'allowcommit': False,
+ 'cmdmsg': _('unshelve already in progress')
+ }
+ statemod.addunfinished(unshelvedata)
cmdutil.afterresolvedstates.append(
[shelvedstate._filename, _('hg unshelve --continue')])
-
diff --git a/hgext/rebase.py b/hgext/rebase.py
--- a/hgext/rebase.py
+++ b/hgext/rebase.py
@@ -1947,8 +1947,12 @@
entry[1].append(('t', 'tool', '',
_("specify merge tool for rebase")))
cmdutil.summaryhooks.add('rebase', summaryhook)
- statemod.unfinishedstates.append(
- ['rebasestate', False, False, _('rebase in progress'),
- _("use 'hg rebase --continue' or 'hg rebase --abort'")])
+ rebasedata = {
+ 'cmdname': 'rebase',
+ 'fname': 'rebasestate',
+ 'clearable': False,
+ 'allowcommit': False
+ }
+ statemod.addunfinished(rebasedata)
cmdutil.afterresolvedstates.append(
['rebasestate', _('hg rebase --continue')])
diff --git a/hgext/histedit.py b/hgext/histedit.py
--- a/hgext/histedit.py
+++ b/hgext/histedit.py
@@ -2288,8 +2288,12 @@
def extsetup(ui):
cmdutil.summaryhooks.add('histedit', summaryhook)
- statemod.unfinishedstates.append(
- ['histedit-state', False, True, _('histedit in progress'),
- _("use 'hg histedit --continue' or 'hg histedit --abort'")])
+ histeditdata = {
+ 'cmdname': 'histedit',
+ 'fname': 'histedit-state',
+ 'clearable': False,
+ 'allowcommit': True
+ }
+ statemod.addunfinished(histeditdata)
cmdutil.afterresolvedstates.append(
['histedit-state', _('hg histedit --continue')])
To: taapas1128, durin42, martinvonz, #hg-reviewers
Cc: pulkit, mjpieters, mercurial-devel
More information about the Mercurial-devel
mailing list