This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2935

fancyopts: fix rendering of customopt defaults in help text
ClosedPublic

Authored by dploch on Mar 22 2018, 8:10 PM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHG979c8ce9022d: fancyopts: fix rendering of customopt defaults in help text
Summary

Also make a getdefaultvalue() function to prevent unwanted mutation.

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

dploch created this revision.Mar 22 2018, 8:10 PM
dploch added a subscriber: yuja.Mar 22 2018, 8:16 PM
yuja requested changes to this revision.Mar 23 2018, 10:17 AM

Looks good, but can you split this to two patches?

https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist

This revision now requires changes to proceed.Mar 23 2018, 10:17 AM
dploch added a comment.Mar 23 2018, 2:24 PM
In D2935#47329, @yuja wrote:

Looks good, but can you split this to two patches?
https://www.mercurial-scm.org/wiki/ContributingChanges#Submission_checklist

Done, sorry.

getdefaultvalue() change is now in D2937

yuja accepted this revision.Mar 23 2018, 10:54 PM
This revision is now accepted and ready to land.Mar 23 2018, 10:54 PM
yuja added a comment.Mar 23 2018, 10:55 PM

Moved test-help.t change back to this patch, and queued, thanks.

Closed by commit rHG979c8ce9022d: fancyopts: fix rendering of customopt defaults in help text (authored by dploch). · Explain WhyMar 23 2018, 11:07 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/help.py (6 lines)
Mtests/test-help.t (26 lines)

Diff 7263

mercurial/help.py

_, _,
gettext, gettext,
) )
from . import ( from . import (
cmdutil, cmdutil,
encoding, encoding,
error, error,
extensions, extensions,
fancyopts,
filemerge, filemerge,
fileset, fileset,
minirst, minirst,
pycompat, pycompat,
revset, revset,
templatefilters, templatefilters,
templatefuncs, templatefuncs,
templatekw, templatekw,
if not verbose and any(w in desc for w in _exclkeywords): if not verbose and any(w in desc for w in _exclkeywords):
continue continue
so = '' so = ''
if shortopt: if shortopt:
so = '-' + shortopt so = '-' + shortopt
lo = '--' + longopt lo = '--' + longopt
if default:
if isinstance(default, fancyopts.customopt):
default = default.defaultvalue
if default and not callable(default):
# default is of unknown type, and in Python 2 we abused # default is of unknown type, and in Python 2 we abused
# the %s-shows-repr property to handle integers etc. To # the %s-shows-repr property to handle integers etc. To
# match that behavior on Python 3, we do str(default) and # match that behavior on Python 3, we do str(default) and
# then convert it to bytes. # then convert it to bytes.
desc += _(" (default: %s)") % pycompat.bytestr(default) desc += _(" (default: %s)") % pycompat.bytestr(default)
if isinstance(default, list): if isinstance(default, list):
lo += " %s [+]" % optlabel lo += " %s [+]" % optlabel

tests/test-help.t

[255] [255]
$ hg pu.lh $ hg pu.lh
hg: unknown command 'pu.lh' hg: unknown command 'pu.lh'
(did you mean one of pull, push?) (did you mean one of pull, push?)
[255] [255]
$ cat > helpext.py <<EOF $ cat > helpext.py <<EOF
> import os > import os
> from mercurial import commands, registrar > from mercurial import commands, fancyopts, registrar
> >
> def func(arg):
> return '%sfoo' % arg
> class customopt(fancyopts.customopt):
> def newstate(self, oldstate, newparam, abort):
> return '%sbar' % oldstate
> cmdtable = {} > cmdtable = {}
> command = registrar.command(cmdtable) > command = registrar.command(cmdtable)
> >
> @command(b'nohelp', > @command(b'nohelp',
> [(b'', b'longdesc', 3, b'x'*90), > [(b'', b'longdesc', 3, b'x'*67),
> (b'n', b'', None, b'normal desc'), > (b'n', b'', None, b'normal desc'),
> (b'', b'newline', b'', b'line1\nline2')], > (b'', b'newline', b'', b'line1\nline2'),
> (b'', b'callableopt', func, b'adds foo'),
> (b'', b'customopt', customopt(''), b'adds bar'),
> (b'', b'customopt-withdefault', customopt('foo'), b'adds bar')],
> b'hg nohelp', > b'hg nohelp',
> norepo=True) > norepo=True)
> @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')]) > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
> @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')]) > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
> @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')]) > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
> def nohelp(ui, *args, **kwargs): > def nohelp(ui, *args, **kwargs):
> pass > pass
> >
$ hg help nohelp $ hg help nohelp
hg nohelp hg nohelp
(no help text available) (no help text available)
options: options:
--longdesc VALUE xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx --longdesc VALUE
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (default: 3) xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxx (default: 3)
-n -- normal desc -n -- normal desc
--newline VALUE line1 line2 --newline VALUE line1 line2
--callableopt VALUE adds foo
--customopt VALUE adds bar
--customopt-withdefault VALUE adds bar (default: foo)
(some details hidden, use --verbose to show complete help) (some details hidden, use --verbose to show complete help)
$ hg help -k nohelp $ hg help -k nohelp
Commands: Commands:
nohelp hg nohelp nohelp hg nohelp