This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1694

debugcommands: replace opts.get('foo') by opts['foo']
AbandonedPublic

Authored by martinvonz on Dec 14 2017, 6:35 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

martinvonz created this revision.Dec 14 2017, 6:35 PM
yuja added a subscriber: yuja.Dec 15 2017, 8:29 AM

Queued the first three patches, but I'm not certain about this. Sometimes we
do the reverse change for ease of calling command function as a plain function.

durin42 added a subscriber: durin42.Jan 10 2018, 5:40 PM
In D1694#29072, @yuja wrote:

Queued the first three patches, but I'm not certain about this. Sometimes we
do the reverse change for ease of calling command function as a plain function.

I think it's probably okay for debug commands, those are pretty rare to use as a function aren't they?

yuja added a comment.Jan 12 2018, 7:17 AM
In D1694#31044, @durin42 wrote:

I think it's probably okay for debug commands, those are pretty rare to use as a function aren't they?

Yeah, it's okay, but why do we apply a different rule to debug commands?

If we take this, I'd rather replace .get() by [] everywhere to blame third-party
tools which don't pass all options.

durin42 added a comment.Jan 18 2018, 3:09 PM

I don't feel strongly either. Martin, if you want to pursue this (which seems fine to me) why not make ocmmands.py consistent as well?

pulkit added a subscriber: pulkit.Jun 14 2018, 3:51 PM

@martinvonz do you want to pursue this or can this be mark as abandoned? (Trying to close differentials which are no longer required)

martinvonz abandoned this revision.Jun 14 2018, 6:02 PM
pulkit added a comment.EditedNov 30 2018, 11:37 AM
In D1694#29072, @yuja wrote:

Sometimes we do the reverse change for ease of calling command function as a plain function.

Just for record, today I hit the problem where some command is using opts[''] instead of opts.get() and I was calling command function as plain function leading me to KeyError.

lothiraldan added a subscriber: lothiraldan.Dec 1 2018, 7:15 AM
In D1694#79416, @pulkit wrote:
In D1694#29072, @yuja wrote:

Sometimes we do the reverse change for ease of calling command function as a plain function.

Just for record, today I hit the problem where some command is using opts[''] instead of opts.get() and I was calling command function as plain function leading me to KeyError.

It would be nice to have some official API to call a command as a function. Such function would do the same processing as the dispatch logic to validate input and install default value.

Revision Contents
Changeset List

Diff 4443

mercurial/debugcommands.py

raise error.Abort(error) raise error.Abort(error)
@command('debugcolor', @command('debugcolor',
[('', 'style', None, _('show all configured styles'))], [('', 'style', None, _('show all configured styles'))],
'hg debugcolor') 'hg debugcolor')
def debugcolor(ui, repo, **opts): def debugcolor(ui, repo, **opts):
"""show available color, effects or style""" """show available color, effects or style"""
ui.write(('color mode: %s\n') % ui._colormode) ui.write(('color mode: %s\n') % ui._colormode)
if opts.get(r'style'): if opts[r'style']:
return _debugdisplaystyle(ui) return _debugdisplaystyle(ui)
else: else:
return _debugdisplaycolor(ui) return _debugdisplaycolor(ui)
def _debugdisplaycolor(ui): def _debugdisplaycolor(ui):
ui = ui.copy() ui = ui.copy()
ui._styles.clear() ui._styles.clear()
for effect in color._activeeffects(ui).keys(): for effect in color._activeeffects(ui).keys():
def debugdag(ui, repo, file_=None, *revs, **opts): def debugdag(ui, repo, file_=None, *revs, **opts):
"""format the changelog or an index DAG as a concise textual description """format the changelog or an index DAG as a concise textual description
If you pass a revlog index, the revlog's DAG is emitted. If you list If you pass a revlog index, the revlog's DAG is emitted. If you list
revision numbers, they get labeled in the output as rN. revision numbers, they get labeled in the output as rN.
Otherwise, the changelog DAG of the current repo is emitted. Otherwise, the changelog DAG of the current repo is emitted.
""" """
spaces = opts.get(r'spaces') spaces = opts[r'spaces']
dots = opts.get(r'dots') dots = opts[r'dots']
if file_: if file_:
rlog = revlog.revlog(vfsmod.vfs(pycompat.getcwd(), audit=False), rlog = revlog.revlog(vfsmod.vfs(pycompat.getcwd(), audit=False),
file_) file_)
revs = set((int(r) for r in revs)) revs = set((int(r) for r in revs))
def events(): def events():
for r in rlog: for r in rlog:
yield 'n', (r, list(p for p in rlog.parentrevs(r) yield 'n', (r, list(p for p in rlog.parentrevs(r)
if p != -1)) if p != -1))
if r in revs: if r in revs:
yield 'l', (r, "r%i" % r) yield 'l', (r, "r%i" % r)
elif repo: elif repo:
cl = repo.changelog cl = repo.changelog
tags = opts.get(r'tags') tags = opts[r'tags']
branches = opts.get(r'branches') branches = opts[r'branches']
if tags: if tags:
labels = {} labels = {}
for l, n in repo.tags().items(): for l, n in repo.tags().items():
labels.setdefault(cl.rev(n), []).append(l) labels.setdefault(cl.rev(n), []).append(l)
def events(): def events():
b = "default" b = "default"
for r in cl: for r in cl:
if branches: if branches:
maxlinewidth=70): maxlinewidth=70):
ui.write(line) ui.write(line)
ui.write("\n") ui.write("\n")
@command('debugdata', cmdutil.debugrevlogopts, _('-c|-m|FILE REV')) @command('debugdata', cmdutil.debugrevlogopts, _('-c|-m|FILE REV'))
def debugdata(ui, repo, file_, rev=None, **opts): def debugdata(ui, repo, file_, rev=None, **opts):
"""dump the contents of a data file revision""" """dump the contents of a data file revision"""
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
if opts.get('changelog') or opts.get('manifest') or opts.get('dir'): if opts['changelog'] or opts['manifest'] or opts['dir']:
if rev is not None: if rev is not None:
raise error.CommandError('debugdata', _('invalid arguments')) raise error.CommandError('debugdata', _('invalid arguments'))
file_, rev = None, file_ file_, rev = None, file_
elif rev is None: elif rev is None:
raise error.CommandError('debugdata', _('invalid arguments')) raise error.CommandError('debugdata', _('invalid arguments'))
r = cmdutil.openrevlog(repo, 'debugdata', file_, opts) r = cmdutil.openrevlog(repo, 'debugdata', file_, opts)
try: try:
ui.write(r.revision(r.lookup(rev), raw=True)) ui.write(r.revision(r.lookup(rev), raw=True))
@command('debugdirstate|debugstate', @command('debugdirstate|debugstate',
[('', 'nodates', None, _('do not display the saved mtime')), [('', 'nodates', None, _('do not display the saved mtime')),
('', 'datesort', None, _('sort by saved mtime'))], ('', 'datesort', None, _('sort by saved mtime'))],
_('[OPTION]...')) _('[OPTION]...'))
def debugstate(ui, repo, **opts): def debugstate(ui, repo, **opts):
"""show the contents of the current dirstate""" """show the contents of the current dirstate"""
nodates = opts.get(r'nodates') nodates = opts[r'nodates']
datesort = opts.get(r'datesort') datesort = opts[r'datesort']
timestr = "" timestr = ""
if datesort: if datesort:
keyfunc = lambda x: (x[1][3], x[0]) # sort by mtime, then by filename keyfunc = lambda x: (x[1][3], x[0]) # sort by mtime, then by filename
else: else:
keyfunc = None # sort by filename keyfunc = None # sort by filename
for file_, ent in sorted(repo.dirstate._map.iteritems(), key=keyfunc): for file_, ent in sorted(repo.dirstate._map.iteritems(), key=keyfunc):
if ent[3] == -1: if ent[3] == -1:
remoteurl, branches = hg.parseurl(ui.expandpath(remoteurl)) remoteurl, branches = hg.parseurl(ui.expandpath(remoteurl))
remote = hg.peer(repo, opts, remoteurl) remote = hg.peer(repo, opts, remoteurl)
ui.status(_('comparing with %s\n') % util.hidepassword(remoteurl)) ui.status(_('comparing with %s\n') % util.hidepassword(remoteurl))
# make sure tests are repeatable # make sure tests are repeatable
random.seed(12323) random.seed(12323)
def doit(pushedrevs, remoteheads, remote=remote): def doit(pushedrevs, remoteheads, remote=remote):
if opts.get('old'): if opts['old']:
if not util.safehasattr(remote, 'branches'): if not util.safehasattr(remote, 'branches'):
# enable in-client legacy support # enable in-client legacy support
remote = localrepo.locallegacypeer(remote.local()) remote = localrepo.locallegacypeer(remote.local())
common, _in, hds = treediscovery.findcommonincoming(repo, remote, common, _in, hds = treediscovery.findcommonincoming(repo, remote,
force=True) force=True)
common = set(common) common = set(common)
if not opts.get('nonheads'): if not opts['nonheads']:
ui.write(("unpruned common: %s\n") % ui.write(("unpruned common: %s\n") %
" ".join(sorted(short(n) for n in common))) " ".join(sorted(short(n) for n in common)))
dag = dagutil.revlogdag(repo.changelog) dag = dagutil.revlogdag(repo.changelog)
all = dag.ancestorset(dag.internalizeall(common)) all = dag.ancestorset(dag.internalizeall(common))
common = dag.externalizeall(dag.headsetofconnecteds(all)) common = dag.externalizeall(dag.headsetofconnecteds(all))
else: else:
nodes = None nodes = None
if pushedrevs: if pushedrevs:
fm.end() fm.end()
@command('debugfileset', @command('debugfileset',
[('r', 'rev', '', _('apply the filespec on this revision'), _('REV'))], [('r', 'rev', '', _('apply the filespec on this revision'), _('REV'))],
_('[-r REV] FILESPEC')) _('[-r REV] FILESPEC'))
def debugfileset(ui, repo, expr, **opts): def debugfileset(ui, repo, expr, **opts):
'''parse and apply a fileset specification''' '''parse and apply a fileset specification'''
ctx = scmutil.revsingle(repo, opts.get(r'rev'), None) ctx = scmutil.revsingle(repo, opts[r'rev'], None)
if ui.verbose: if ui.verbose:
tree = fileset.parse(expr) tree = fileset.parse(expr)
ui.note(fileset.prettyformat(tree), "\n") ui.note(fileset.prettyformat(tree), "\n")
for f in ctx.getfileset(expr): for f in ctx.getfileset(expr):
ui.write("%s\n" % f) ui.write("%s\n" % f)
@command('debugformat', @command('debugformat',
Setting a lock will prevent other commands from changing the data. Setting a lock will prevent other commands from changing the data.
The command will wait until an interruption (SIGINT, SIGTERM, ...) occurs. The command will wait until an interruption (SIGINT, SIGTERM, ...) occurs.
The set locks are removed when the command exits. The set locks are removed when the command exits.
Returns 0 if no locks are held. Returns 0 if no locks are held.
""" """
if opts.get(r'force_lock'): if opts[r'force_lock']:
repo.svfs.unlink('lock') repo.svfs.unlink('lock')
if opts.get(r'force_wlock'): if opts[r'force_wlock']:
repo.vfs.unlink('wlock') repo.vfs.unlink('wlock')
if opts.get(r'force_lock') or opts.get(r'force_wlock'): if opts[r'force_lock'] or opts[r'force_wlock']:
return 0 return 0
locks = [] locks = []
try: try:
if opts.get(r'set_wlock'): if opts[r'set_wlock']:
try: try:
locks.append(repo.wlock(False)) locks.append(repo.wlock(False))
except error.LockHeld: except error.LockHeld:
raise error.Abort(_('wlock is already held')) raise error.Abort(_('wlock is already held'))
if opts.get(r'set_lock'): if opts[r'set_lock']:
try: try:
locks.append(repo.lock(False)) locks.append(repo.lock(False))
except error.LockHeld: except error.LockHeld:
raise error.Abort(_('lock is already held')) raise error.Abort(_('lock is already held'))
if len(locks): if len(locks):
ui.promptchoice(_("ready to release the lock (y)? $$ &Yes")) ui.promptchoice(_("ready to release the lock (y)? $$ &Yes"))
return 0 return 0
finally: finally:
n = bin(s) n = bin(s)
if len(n) != len(nullid): if len(n) != len(nullid):
raise TypeError() raise TypeError()
return n return n
except TypeError: except TypeError:
raise error.Abort('changeset references must be full hexadecimal ' raise error.Abort('changeset references must be full hexadecimal '
'node identifiers') 'node identifiers')
if opts.get('delete'): if opts['delete']:
indices = [] indices = []
for v in opts.get('delete'): for v in opts['delete']:
try: try:
indices.append(int(v)) indices.append(int(v))
except ValueError: except ValueError:
raise error.Abort(_('invalid index value: %r') % v, raise error.Abort(_('invalid index value: %r') % v,
hint=_('use integers for indices')) hint=_('use integers for indices'))
if repo.currenttransaction(): if repo.currenttransaction():
raise error.Abort(_('cannot delete obsmarkers in the middle ' raise error.Abort(_('cannot delete obsmarkers in the middle '
raise error.Abort('cannot select revision when creating marker') raise error.Abort('cannot select revision when creating marker')
metadata = {} metadata = {}
metadata['user'] = opts['user'] or ui.username() metadata['user'] = opts['user'] or ui.username()
succs = tuple(parsenodeid(succ) for succ in successors) succs = tuple(parsenodeid(succ) for succ in successors)
l = repo.lock() l = repo.lock()
try: try:
tr = repo.transaction('debugobsolete') tr = repo.transaction('debugobsolete')
try: try:
date = opts.get('date') date = opts['date']
if date: if date:
date = util.parsedate(date) date = util.parsedate(date)
else: else:
date = None date = None
prec = parsenodeid(precursor) prec = parsenodeid(precursor)
parents = None parents = None
if opts['record_parents']: if opts['record_parents']:
if prec not in repo.unfiltered(): if prec not in repo.unfiltered():
markers = list(obsutil.getmarkers(repo, nodes=nodes, markers = list(obsutil.getmarkers(repo, nodes=nodes,
exclusive=opts['exclusive'])) exclusive=opts['exclusive']))
markers.sort(key=lambda x: x._data) markers.sort(key=lambda x: x._data)
else: else:
markers = obsutil.getmarkers(repo) markers = obsutil.getmarkers(repo)
markerstoiter = markers markerstoiter = markers
isrelevant = lambda m: True isrelevant = lambda m: True
if opts.get('rev') and opts.get('index'): if opts['rev'] and opts['index']:
markerstoiter = obsutil.getmarkers(repo) markerstoiter = obsutil.getmarkers(repo)
markerset = set(markers) markerset = set(markers)
isrelevant = lambda m: m in markerset isrelevant = lambda m: m in markerset
fm = ui.formatter('debugobsolete', opts) fm = ui.formatter('debugobsolete', opts)
for i, m in enumerate(markerstoiter): for i, m in enumerate(markerstoiter):
if not isrelevant(m): if not isrelevant(m):
# marker can be irrelevant when we're iterating over a set # marker can be irrelevant when we're iterating over a set
# of markers (markerstoiter) which is bigger than the set # of markers (markerstoiter) which is bigger than the set
# of markers we want to display (markers) # of markers we want to display (markers)
# this can happen if both --index and --rev options are # this can happen if both --index and --rev options are
# provided and thus we need to iterate over all of the markers # provided and thus we need to iterate over all of the markers
# to get the correct indices, but only display the ones that # to get the correct indices, but only display the ones that
# are relevant to --rev value # are relevant to --rev value
continue continue
fm.startitem() fm.startitem()
ind = i if opts.get('index') else None ind = i if opts['index'] else None
cmdutil.showmarker(fm, m, index=ind) cmdutil.showmarker(fm, m, index=ind)
fm.end() fm.end()
@command('debugpathcomplete', @command('debugpathcomplete',
[('f', 'full', None, _('complete an entire path')), [('f', 'full', None, _('complete an entire path')),
('n', 'normal', None, _('show only normal files')), ('n', 'normal', None, _('show only normal files')),
('a', 'added', None, _('show only added files')), ('a', 'added', None, _('show only added files')),
('r', 'removed', None, _('show only removed files'))], ('r', 'removed', None, _('show only removed files'))],
with ui.configoverride(overrides, 'debugmergepatterns'): with ui.configoverride(overrides, 'debugmergepatterns'):
hgmerge = encoding.environ.get("HGMERGE") hgmerge = encoding.environ.get("HGMERGE")
if hgmerge is not None: if hgmerge is not None:
ui.note(('with HGMERGE=%r\n') % (hgmerge)) ui.note(('with HGMERGE=%r\n') % (hgmerge))
uimerge = ui.config("ui", "merge") uimerge = ui.config("ui", "merge")
if uimerge: if uimerge:
ui.note(('with ui.merge=%r\n') % (uimerge)) ui.note(('with ui.merge=%r\n') % (uimerge))
ctx = scmutil.revsingle(repo, opts.get('rev')) ctx = scmutil.revsingle(repo, opts['rev'])
m = scmutil.match(ctx, pats, opts) m = scmutil.match(ctx, pats, opts)
changedelete = opts['changedelete'] changedelete = opts['changedelete']
for path in ctx.walk(m): for path in ctx.walk(m):
fctx = ctx[path] fctx = ctx[path]
try: try:
if not ui.debugflag: if not ui.debugflag:
ui.pushbuffer(error=True) ui.pushbuffer(error=True)
tool, toolpath = filemerge._picktool(repo, ui, path, tool, toolpath = filemerge._picktool(repo, ui, path,
One use of this command is to make the next :hg:`status` invocation One use of this command is to make the next :hg:`status` invocation
check the actual file content. check the actual file content.
""" """
ctx = scmutil.revsingle(repo, rev) ctx = scmutil.revsingle(repo, rev)
with repo.wlock(): with repo.wlock():
dirstate = repo.dirstate dirstate = repo.dirstate
changedfiles = None changedfiles = None
# See command doc for what minimal does. # See command doc for what minimal does.
if opts.get(r'minimal'): if opts[r'minimal']:
manifestfiles = set(ctx.manifest().keys()) manifestfiles = set(ctx.manifest().keys())
dirstatefiles = set(dirstate) dirstatefiles = set(dirstate)
manifestonly = manifestfiles - dirstatefiles manifestonly = manifestfiles - dirstatefiles
dsonly = dirstatefiles - manifestfiles dsonly = dirstatefiles - manifestfiles
dsnotadded = set(f for f in dsonly if dirstate[f] != 'a') dsnotadded = set(f for f in dsonly if dirstate[f] != 'a')
changedfiles = manifestonly | dsnotadded changedfiles = manifestonly | dsnotadded
dirstate.rebuild(ctx.node(), ctx.manifest(), changedfiles) dirstate.rebuild(ctx.node(), ctx.manifest(), changedfiles)
@command('debugrebuildfncache', [], '') @command('debugrebuildfncache', [], '')
def debugrebuildfncache(ui, repo): def debugrebuildfncache(ui, repo):
"""rebuild the fncache file""" """rebuild the fncache file"""
repair.rebuildfncache(ui, repo) repair.rebuildfncache(ui, repo)
@command('debugrename', @command('debugrename',
[('r', 'rev', '', _('revision to debug'), _('REV'))], [('r', 'rev', '', _('revision to debug'), _('REV'))],
_('[-r REV] FILE')) _('[-r REV] FILE'))
def debugrename(ui, repo, file1, *pats, **opts): def debugrename(ui, repo, file1, *pats, **opts):
"""dump rename information""" """dump rename information"""
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
ctx = scmutil.revsingle(repo, opts.get('rev')) ctx = scmutil.revsingle(repo, opts['rev'])
m = scmutil.match(ctx, (file1,) + pats, opts) m = scmutil.match(ctx, (file1,) + pats, opts)
for abs in ctx.walk(m): for abs in ctx.walk(m):
fctx = ctx[abs] fctx = ctx[abs]
o = fctx.filelog().renamed(fctx.filenode()) o = fctx.filelog().renamed(fctx.filenode())
rel = m.rel(abs) rel = m.rel(abs)
if o: if o:
ui.write(_("%s renamed from %s:%s\n") % (rel, o[0], hex(o[1]))) ui.write(_("%s renamed from %s:%s\n") % (rel, o[0], hex(o[1])))
else: else:
ui.write(_("%s not renamed\n") % rel) ui.write(_("%s not renamed\n") % rel)
@command('debugrevlog', cmdutil.debugrevlogopts + @command('debugrevlog', cmdutil.debugrevlogopts +
[('d', 'dump', False, _('dump index data'))], [('d', 'dump', False, _('dump index data'))],
_('-c|-m|FILE'), _('-c|-m|FILE'),
optionalrepo=True) optionalrepo=True)
def debugrevlog(ui, repo, file_=None, **opts): def debugrevlog(ui, repo, file_=None, **opts):
"""show data and statistics about a revlog""" """show data and statistics about a revlog"""
opts = pycompat.byteskwargs(opts) opts = pycompat.byteskwargs(opts)
r = cmdutil.openrevlog(repo, 'debugrevlog', file_, opts) r = cmdutil.openrevlog(repo, 'debugrevlog', file_, opts)
if opts.get("dump"): if opts["dump"]:
numrevs = len(r) numrevs = len(r)
ui.write(("# rev p1rev p2rev start end deltastart base p1 p2" ui.write(("# rev p1rev p2rev start end deltastart base p1 p2"
" rawsize totalsize compression heads chainlen\n")) " rawsize totalsize compression heads chainlen\n"))
ts = 0 ts = 0
heads = set() heads = set()
for rev in xrange(numrevs): for rev in xrange(numrevs):
dbase = r.deltaparent(rev) dbase = r.deltaparent(rev)