D6501: state: created new class statecheck to handle unfinishedstates
taapas1128 (Taapas Agrawal)
phabricator at mercurial-scm.org
Sat Jun 8 20:58:39 UTC 2019
taapas1128 created this revision.
Herald added a reviewer: durin42.
Herald added subscribers: mercurial-devel, mjpieters.
Herald added a reviewer: martinvonz.
Herald added a reviewer: hg-reviewers.
REVISION SUMMARY
For the purpose of handling states for various multistep operations like
`hg graft`, `hg histedit`, `hg bisect` et al a new class called statecheck
is created .This will help in having a unified approach towards these commands
and handle them with ease.
The class takes in 4 basic arguments which include the name of the command, the
name of the state file associated with it , clearable flag , allowcommit flag.
This also also adds the support of`checkunfinished()` and
`clearunfinished()` to the class.
Tests remain unchanged.
REPOSITORY
rHG Mercurial
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,43 +88,96 @@
"""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 will to deal 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):
+ """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 .`
+ allowcommit boolean decides whether commit is allowed during interrupted
+ state or not.
+ stopflag is a boolean that determines whether or not a command supports
+ --stop flag
+ """
+ self.cmdname = cmdname
+ self.fname = fname
+ self.clearable = clearable
+ self.allowcommit = allowcommit
+
+ def hint(self):
+ """returns the hint message corresponding to the command"""
+ if self.cmdname == 'graft':
+ msg = _("use 'hg graft --continue' or 'hg graft --stop' to stop")
+ elif self.cmdname == 'update':
+ msg = _("use 'hg update' to get a consistent checkout")
+ elif self.cmdname == 'transplant':
+ msg = _("use 'hg transplant --continue' or 'hg update' to abort")
+ else:
+ msg = (_("use 'hg %s --continue' or 'hg %s --abort'") %
+ (self.cmdname,self.cmdname))
+ return msg
+
+ def msg(self):
+ """returns the status message corresponding to the command"""
+ if self.cmdname == 'update':
+ return _('last update was interrupted')
+ elif self.cmdname == 'unshelve':
+ return _('unshelve already in progress')
+ else:
+ return _('%s in progress') % (self.cmdname)
+
+ def isunfinished(self, repo, mergecheck=False):
+ """determines whether a multi-step operation is in progress
+ or not
+ mergecheck flag helps in determining state specifically for merge
+ """
+ if self.cmdname == 'merge' or mergecheck:
+ return len(repo[None].parents()) > 1
+ else:
+ return repo.vfs.exists(self.fname)
+
+unfinishedstates=[]
+unfinishedstates.append(statecheck('graft','graftstate', clearable=True,
+ allowcommit=False))
+unfinishedstates.append(statecheck('update', 'updatestate', clearable=True,
+ allowcommit=False))
def checkunfinished(repo, commit=False):
'''Look for an unfinished multistep operation, like graft, and abort
if found. It's probably good to check this right before
bailifchanged().
'''
# 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,8 @@
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")])
+ statemod.unfinishedstates.append(statemod.statecheck('transplant',
+ 'transplant/journal', clearable=True, allowcommit=False))
# 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,8 @@
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'")])
+ statemod.unfinishedstates.append(statemod.statecheck('unshelve',
+ shelvedstate._filename, clearable=False, allowcommit=False))
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,7 @@
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'")])
+ statemod.unfinishedstates.append(statemod.statecheck('rebase',
+ 'rebasestate', clearable=False, allowcommit=False))
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,7 @@
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'")])
+ statemod.unfinishedstates.append(statemod.statecheck('histedit',
+ 'histedit-state', clearable=False, allowcommit=True))
cmdutil.afterresolvedstates.append(
['histedit-state', _('hg histedit --continue')])
To: taapas1128, durin42, martinvonz, #hg-reviewers
Cc: mjpieters, mercurial-devel
More information about the Mercurial-devel
mailing list