( )⚙ D10157 command: clarify `postincoming` return and that return handling

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10157

command: clarify `postincoming` return and that return handling
ClosedPublic

Authored by marmoute on Mar 11 2021, 11:52 AM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG052ab8d0a538: command: clarify `postincoming` return and that return handling
Summary

The command should return None or a return code. The previous code was returning
boolean directly relying on the fact that True → 1 and False → 0. This is a
good road to troubles, so lets be explicit about that return.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

marmoute created this revision.Mar 11 2021, 11:52 AM
Alphare accepted this revision.Mar 16 2021, 5:42 AM
marmoute added a commit: rHG052ab8d0a538: command: clarify `postincoming` return and that return handling.Mar 16 2021, 5:55 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG052ab8d0a538: command: clarify `postincoming` return and that return handling (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/commands.py (18 lines)

Diff 26444

mercurial/commands.py

"""Run after a changegroup has been added via pull/unbundle """Run after a changegroup has been added via pull/unbundle
This takes arguments below: This takes arguments below:
:modheads: change of heads by pull/unbundle :modheads: change of heads by pull/unbundle
:optupdate: updating working directory is needed or not :optupdate: updating working directory is needed or not
:checkout: update destination revision (or None to default destination) :checkout: update destination revision (or None to default destination)
:brev: a name, which might be a bookmark to be activated after updating :brev: a name, which might be a bookmark to be activated after updating
return True if update raise any conflict, False otherwise.
""" """
if modheads == 0: if modheads == 0:
return return False
if optupdate: if optupdate:
try: try:
return hg.updatetotally(ui, repo, checkout, brev) return hg.updatetotally(ui, repo, checkout, brev)
except error.UpdateAbort as inst: except error.UpdateAbort as inst:
msg = _(b"not updating: %s") % stringutil.forcebytestr(inst) msg = _(b"not updating: %s") % stringutil.forcebytestr(inst)
hint = inst.hint hint = inst.hint
raise error.UpdateAbort(msg, hint=hint) raise error.UpdateAbort(msg, hint=hint)
if modheads is not None and modheads > 1: if modheads is not None and modheads > 1:
currentbranchheads = len(repo.branchheads()) currentbranchheads = len(repo.branchheads())
if currentbranchheads == modheads: if currentbranchheads == modheads:
ui.status( ui.status(
_(b"(run 'hg heads' to see heads, 'hg merge' to merge)\n") _(b"(run 'hg heads' to see heads, 'hg merge' to merge)\n")
) )
elif currentbranchheads > 1: elif currentbranchheads > 1:
ui.status( ui.status(
_(b"(run 'hg heads .' to see heads, 'hg merge' to merge)\n") _(b"(run 'hg heads .' to see heads, 'hg merge' to merge)\n")
) )
else: else:
ui.status(_(b"(run 'hg heads' to see heads)\n")) ui.status(_(b"(run 'hg heads' to see heads)\n"))
elif not ui.configbool(b'commands', b'update.requiredest'): elif not ui.configbool(b'commands', b'update.requiredest'):
ui.status(_(b"(run 'hg update' to get a working copy)\n")) ui.status(_(b"(run 'hg update' to get a working copy)\n"))
return False
@command( @command(
b'pull', b'pull',
[ [
( (
b'u', b'u',
b'update', b'update',
msg = _(b'update destination required by configuration') msg = _(b'update destination required by configuration')
hint = _(b'use hg pull followed by hg update DEST') hint = _(b'use hg pull followed by hg update DEST')
raise error.InputError(msg, hint=hint) raise error.InputError(msg, hint=hint)
source, branches = hg.parseurl(ui.expandpath(source), opts.get(b'branch')) source, branches = hg.parseurl(ui.expandpath(source), opts.get(b'branch'))
ui.status(_(b'pulling from %s\n') % util.hidepassword(source)) ui.status(_(b'pulling from %s\n') % util.hidepassword(source))
ui.flush() ui.flush()
other = hg.peer(repo, opts, source) other = hg.peer(repo, opts, source)
update_conflict = None
try: try:
revs, checkout = hg.addbranchrevs( revs, checkout = hg.addbranchrevs(
repo, other, branches, opts.get(b'rev') repo, other, branches, opts.get(b'rev')
) )
pullopargs = {} pullopargs = {}
nodes = None nodes = None
if opts.get(b'rev'): if opts.get(b'rev'):
brev = opts[b'rev'][0] brev = opts[b'rev'][0]
elif opts.get(b'branch'): elif opts.get(b'branch'):
brev = opts[b'branch'][0] brev = opts[b'branch'][0]
else: else:
brev = branches[0] brev = branches[0]
repo._subtoppath = source repo._subtoppath = source
try: try:
ret = postincoming( update_conflict = postincoming(
ui, repo, modheads, opts.get(b'update'), checkout, brev ui, repo, modheads, opts.get(b'update'), checkout, brev
) )
except error.FilteredRepoLookupError as exc: except error.FilteredRepoLookupError as exc:
msg = _(b'cannot update to target: %s') % exc.args[0] msg = _(b'cannot update to target: %s') % exc.args[0]
exc.args = (msg,) + exc.args[1:] exc.args = (msg,) + exc.args[1:]
raise raise
finally: finally:
del repo._subtoppath del repo._subtoppath
finally: finally:
other.close() other.close()
return ret if update_conflict:
return 1
else:
return 0
@command( @command(
b'purge|clean', b'purge|clean',
[ [
(b'a', b'abort-on-err', None, _(b'abort if an error occurs')), (b'a', b'abort-on-err', None, _(b'abort if an error occurs')),
(b'', b'all', None, _(b'purge ignored files too')), (b'', b'all', None, _(b'purge ignored files too')),
(b'i', b'ignored', None, _(b'purge only ignored files')), (b'i', b'ignored', None, _(b'purge only ignored files')),
hint=_( hint=_(
b"see https://mercurial-scm.org/" b"see https://mercurial-scm.org/"
b"wiki/BundleFeature for more " b"wiki/BundleFeature for more "
b"information" b"information"
), ),
) )
modheads = bundle2.combinechangegroupresults(op) modheads = bundle2.combinechangegroupresults(op)
return postincoming(ui, repo, modheads, opts.get('update'), None, None) if postincoming(ui, repo, modheads, opts.get('update'), None, None):
return 1
else:
return 0
@command( @command(
b'unshelve', b'unshelve',
[ [
(b'a', b'abort', None, _(b'abort an incomplete unshelve operation')), (b'a', b'abort', None, _(b'abort an incomplete unshelve operation')),
( (
b'c', b'c',