This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2937

fancyopts: prevent mutation of the default value in customopts
ClosedPublic

Authored by dploch on Mar 23 2018, 2:23 PM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHGef6215df2402: fancyopts: prevent mutation of the default value in customopts
Summary

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 23 2018, 2:23 PM
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
Closed by commit rHGef6215df2402: fancyopts: prevent mutation of the default value in customopts (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/fancyopts.py (16 lines)
Mmercurial/help.py (2 lines)

Diff 7264

mercurial/fancyopts.py

return parsedopts, parsedargs return parsedopts, parsedargs
class customopt(object): class customopt(object):
"""Manage defaults and mutations for any type of opt.""" """Manage defaults and mutations for any type of opt."""
__metaclass__ = abc.ABCMeta __metaclass__ = abc.ABCMeta
def __init__(self, defaultvalue): def __init__(self, defaultvalue):
self.defaultvalue = defaultvalue self._defaultvalue = defaultvalue
def _isboolopt(self): def _isboolopt(self):
return False return False
def getdefaultvalue(self):
"""Returns the default value for this opt.
Subclasses should override this to return a new value if the value type
is mutable."""
return self._defaultvalue
@abc.abstractmethod @abc.abstractmethod
def newstate(self, oldstate, newparam, abort): def newstate(self, oldstate, newparam, abort):
"""Adds newparam to oldstate and returns the new state. """Adds newparam to oldstate and returns the new state.
On failure, abort can be called with a string error message.""" On failure, abort can be called with a string error message."""
class _simpleopt(customopt): class _simpleopt(customopt):
def _isboolopt(self): def _isboolopt(self):
return isinstance(self.defaultvalue, (bool, type(None))) return isinstance(self._defaultvalue, (bool, type(None)))
def newstate(self, oldstate, newparam, abort): def newstate(self, oldstate, newparam, abort):
return newparam return newparam
class _callableopt(customopt): class _callableopt(customopt):
def __init__(self, callablefn): def __init__(self, callablefn):
self.callablefn = callablefn self.callablefn = callablefn
super(_callableopt, self).__init__(None) super(_callableopt, self).__init__(None)
def newstate(self, oldstate, newparam, abort): def newstate(self, oldstate, newparam, abort):
return self.callablefn(newparam) return self.callablefn(newparam)
class _listopt(customopt): class _listopt(customopt):
def getdefaultvalue(self):
return self._defaultvalue[:]
def newstate(self, oldstate, newparam, abort): def newstate(self, oldstate, newparam, abort):
oldstate.append(newparam) oldstate.append(newparam)
return oldstate return oldstate
class _intopt(customopt): class _intopt(customopt):
def newstate(self, oldstate, newparam, abort): def newstate(self, oldstate, newparam, abort):
try: try:
return int(newparam) return int(newparam)
name = name.replace('-', '_') name = name.replace('-', '_')
argmap['-' + short] = name argmap['-' + short] = name
for n in onames: for n in onames:
argmap['--' + n] = name argmap['--' + n] = name
defmap[name] = _defaultopt(default) defmap[name] = _defaultopt(default)
# copy defaults to state # copy defaults to state
state[name] = defmap[name].defaultvalue state[name] = defmap[name].getdefaultvalue()
# does it take a parameter? # does it take a parameter?
if not defmap[name]._isboolopt(): if not defmap[name]._isboolopt():
if short: if short:
short += ':' short += ':'
onames = [n + '=' for n in onames] onames = [n + '=' for n in onames]
elif name not in nevernegate: elif name not in nevernegate:
for n in onames: for n in onames:

mercurial/help.py

continue continue
so = '' so = ''
if shortopt: if shortopt:
so = '-' + shortopt so = '-' + shortopt
lo = '--' + longopt lo = '--' + longopt
if isinstance(default, fancyopts.customopt): if isinstance(default, fancyopts.customopt):
default = default.defaultvalue default = default.getdefaultvalue()
if default and not callable(default): 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):