( )⚙ D4790 wireprotov2: derive "required" from presence of default value

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D4790

wireprotov2: derive "required" from presence of default value
ClosedPublic

Authored by indygreg on Sep 28 2018, 8:18 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG582676acaf6d: wireprotov2: derive "required" from presence of default value
Summary

If we define a default value for all optional arguments, we no
longer need to explicitly declare whether the argument is required.
Instead, we can derive it from the presence of a default value
callable.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Revision Contents
Changeset List

PathPackages
Mmercurial/wireprotov2server.py (22 lines)

Diff 11473

mercurial/wireprotov2server.py

The argument data type. Must be one of the following string The argument data type. Must be one of the following string
literals: ``bytes``, ``int``, ``list``, ``dict``, ``set``, literals: ``bytes``, ``int``, ``list``, ``dict``, ``set``,
or ``bool``. or ``bool``.
``default`` ``default``
A callable returning the default value for this argument. If not A callable returning the default value for this argument. If not
specified, ``None`` will be the default value. specified, ``None`` will be the default value.
``required``
Bool indicating whether the argument is required.
``example`` ``example``
An example value for this argument. An example value for this argument.
``validvalues`` ``validvalues``
Set of recognized values for this argument. Set of recognized values for this argument.
``permission`` defines the permission type needed to run this command. ``permission`` defines the permission type needed to run this command.
Can be ``push`` or ``pull``. These roughly map to read-write and read-only, Can be ``push`` or ``pull``. These roughly map to read-write and read-only,
raise error.ProgrammingError('%s argument for command %s has ' raise error.ProgrammingError('%s argument for command %s has '
'illegal type: %s' % (arg, name, 'illegal type: %s' % (arg, name,
meta['type'])) meta['type']))
if 'example' not in meta: if 'example' not in meta:
raise error.ProgrammingError('%s argument for command %s does not ' raise error.ProgrammingError('%s argument for command %s does not '
'declare example field' % (arg, name)) 'declare example field' % (arg, name))
if 'default' in meta and meta.get('required'): meta['required'] = 'default' not in meta
raise error.ProgrammingError('%s argument for command %s is marked '
'as required but has a default value' %
(arg, name))
meta.setdefault('default', lambda: None) meta.setdefault('default', lambda: None)
meta.setdefault('required', False)
meta.setdefault('validvalues', None) meta.setdefault('validvalues', None)
def register(func): def register(func):
if name in COMMANDS: if name in COMMANDS:
raise error.ProgrammingError('%s command already registered ' raise error.ProgrammingError('%s command already registered '
'for version 2' % name) 'for version 2' % name)
COMMANDS[name] = wireprototypes.commandentry( COMMANDS[name] = wireprototypes.commandentry(
def capabilitiesv2(repo, proto): def capabilitiesv2(repo, proto):
yield _capabilitiesv2(repo, proto) yield _capabilitiesv2(repo, proto)
@wireprotocommand( @wireprotocommand(
'changesetdata', 'changesetdata',
args={ args={
'noderange': { 'noderange': {
'type': 'list', 'type': 'list',
'default': lambda: None,
'example': [[b'0123456...'], [b'abcdef...']], 'example': [[b'0123456...'], [b'abcdef...']],
}, },
'nodes': { 'nodes': {
'type': 'list', 'type': 'list',
'default': lambda: None,
'example': [b'0123456...'], 'example': [b'0123456...'],
}, },
'nodesdepth': { 'nodesdepth': {
'type': 'int', 'type': 'int',
'default': lambda: None,
'example': 10, 'example': 10,
}, },
'fields': { 'fields': {
'type': 'set', 'type': 'set',
'default': set, 'default': set,
'example': {b'parents', b'revision'}, 'example': {b'parents', b'revision'},
'validvalues': {b'bookmarks', b'parents', b'phase', b'revision'}, 'validvalues': {b'bookmarks', b'parents', b'phase', b'revision'},
}, },
args={ args={
'haveparents': { 'haveparents': {
'type': 'bool', 'type': 'bool',
'default': lambda: False, 'default': lambda: False,
'example': True, 'example': True,
}, },
'nodes': { 'nodes': {
'type': 'list', 'type': 'list',
'required': True,
'example': [b'0123456...'], 'example': [b'0123456...'],
}, },
'fields': { 'fields': {
'type': 'set', 'type': 'set',
'default': set, 'default': set,
'example': {b'parents', b'revision'}, 'example': {b'parents', b'revision'},
'validvalues': {b'parents', b'revision'}, 'validvalues': {b'parents', b'revision'},
}, },
'path': { 'path': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': b'foo.txt', 'example': b'foo.txt',
} }
}, },
permission='pull', permission='pull',
# TODO censoring a file revision won't invalidate the cache. # TODO censoring a file revision won't invalidate the cache.
# Figure out a way to take censoring into account when deriving # Figure out a way to take censoring into account when deriving
# the cache key. # the cache key.
cachekeyfn=makecommandcachekeyfn('filedata', 1, allargs=True)) cachekeyfn=makecommandcachekeyfn('filedata', 1, allargs=True))
result = b''.join(b'1' if n else b'0' for n in repo.known(nodes)) result = b''.join(b'1' if n else b'0' for n in repo.known(nodes))
yield result yield result
@wireprotocommand( @wireprotocommand(
'listkeys', 'listkeys',
args={ args={
'namespace': { 'namespace': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': b'ns', 'example': b'ns',
}, },
}, },
permission='pull') permission='pull')
def listkeysv2(repo, proto, namespace): def listkeysv2(repo, proto, namespace):
keys = repo.listkeys(encoding.tolocal(namespace)) keys = repo.listkeys(encoding.tolocal(namespace))
keys = {encoding.fromlocal(k): encoding.fromlocal(v) keys = {encoding.fromlocal(k): encoding.fromlocal(v)
for k, v in keys.iteritems()} for k, v in keys.iteritems()}
yield keys yield keys
@wireprotocommand( @wireprotocommand(
'lookup', 'lookup',
args={ args={
'key': { 'key': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': b'foo', 'example': b'foo',
}, },
}, },
permission='pull') permission='pull')
def lookupv2(repo, proto, key): def lookupv2(repo, proto, key):
key = encoding.tolocal(key) key = encoding.tolocal(key)
# TODO handle exception. # TODO handle exception.
node = repo.lookup(key) node = repo.lookup(key)
yield node yield node
@wireprotocommand( @wireprotocommand(
'manifestdata', 'manifestdata',
args={ args={
'nodes': { 'nodes': {
'type': 'list', 'type': 'list',
'required': True,
'example': [b'0123456...'], 'example': [b'0123456...'],
}, },
'haveparents': { 'haveparents': {
'type': 'bool', 'type': 'bool',
'default': lambda: False, 'default': lambda: False,
'example': True, 'example': True,
}, },
'fields': { 'fields': {
'type': 'set', 'type': 'set',
'default': set, 'default': set,
'example': {b'parents', b'revision'}, 'example': {b'parents', b'revision'},
'validvalues': {b'parents', b'revision'}, 'validvalues': {b'parents', b'revision'},
}, },
'tree': { 'tree': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': b'', 'example': b'',
}, },
}, },
permission='pull', permission='pull',
cachekeyfn=makecommandcachekeyfn('manifestdata', 1, allargs=True)) cachekeyfn=makecommandcachekeyfn('manifestdata', 1, allargs=True))
def manifestdata(repo, proto, haveparents, nodes, fields, tree): def manifestdata(repo, proto, haveparents, nodes, fields, tree):
store = repo.manifestlog.getstorage(tree) store = repo.manifestlog.getstorage(tree)
for extra in followingdata: for extra in followingdata:
yield extra yield extra
@wireprotocommand( @wireprotocommand(
'pushkey', 'pushkey',
args={ args={
'namespace': { 'namespace': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': b'ns', 'example': b'ns',
}, },
'key': { 'key': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': b'key', 'example': b'key',
}, },
'old': { 'old': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': b'old', 'example': b'old',
}, },
'new': { 'new': {
'type': 'bytes', 'type': 'bytes',
'required': True,
'example': 'new', 'example': 'new',
}, },
}, },
permission='push') permission='push')
def pushkeyv2(repo, proto, namespace, key, old, new): def pushkeyv2(repo, proto, namespace, key, old, new):
# TODO handle ui output redirection # TODO handle ui output redirection
yield repo.pushkey(encoding.tolocal(namespace), yield repo.pushkey(encoding.tolocal(namespace),
encoding.tolocal(key), encoding.tolocal(key),
encoding.tolocal(old), encoding.tolocal(old),
encoding.tolocal(new)) encoding.tolocal(new))