Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support SkipParse decorator #408

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 23 additions & 4 deletions fire/core.py
Expand Up @@ -725,7 +725,18 @@ def _MakeParseFn(fn, metadata):
required_kwonly = set(fn_spec.kwonlyargs) - set(fn_spec.kwonlydefaults)

def _ParseFn(args):
"""Parses the list of `args` into (varargs, kwargs), remaining_args."""
"""Parses the list of `args` into (varargs, kwargs), consumed_args, remaining_args."""

skip_parse = metadata.get(decorators.PASS_THROUGH, False)

if skip_parse:
kwargs = {}
remaining_kwargs = []
remaining_args = []
varargs = consumed_args = args[:]
capacity = False
return (varargs, kwargs), consumed_args, remaining_args, capacity

kwargs, remaining_kwargs, remaining_args = _ParseKeywordArgs(args, fn_spec)

# Note: _ParseArgs modifies kwargs.
Expand Down Expand Up @@ -757,8 +768,16 @@ def _ParseFn(args):
varargs = parsed_args + varargs
remaining_args += remaining_kwargs

consumed_args = args[:len(args) - len(remaining_args)]
return (varargs, kwargs), consumed_args, remaining_args, capacity
sorted_remaining_args = []
consumed_args = []
for arg in args:
if arg in remaining_args:
sorted_remaining_args.append(arg)
remaining_args.remove(arg)
else:
consumed_args.append(arg)

return (varargs, kwargs), consumed_args, sorted_remaining_args, capacity

return _ParseFn

Expand Down Expand Up @@ -992,4 +1011,4 @@ def _ParseValue(value, index, arg, metadata):
elif default is not None:
parse_fn = default

return parse_fn(value)
return parse_fn(value)
8 changes: 8 additions & 0 deletions fire/decorators.py
Expand Up @@ -27,6 +27,14 @@
FIRE_METADATA = 'FIRE_METADATA'
FIRE_PARSE_FNS = 'FIRE_PARSE_FNS'
ACCEPTS_POSITIONAL_ARGS = 'ACCEPTS_POSITIONAL_ARGS'
PASS_THROUGH = 'PASS_THROUGH'


def PassThrough(fn):
"""Set a flag to tell Fire to pass original args to decorated fn.
"""
_SetMetadata(fn, PASS_THROUGH, True)
return fn


def SetParseFn(fn, *arguments):
Expand Down
12 changes: 12 additions & 0 deletions fire/decorators_test.py
Expand Up @@ -90,6 +90,13 @@ def example7(self, arg1, arg2=None, *varargs, **kwargs): # pylint: disable=keyw
return arg1, arg2, varargs, kwargs


class PassThroughArgs(object):

@decorators.PassThrough
def example8(self, *args):
return args


class FireDecoratorsTest(testutils.BaseTestCase):

def testSetParseFnsNamedArgs(self):
Expand Down Expand Up @@ -169,6 +176,11 @@ def testSetParseFn(self):
command=['example7', '1', '--arg2=2', '3', '4', '--kwarg=5']),
('1', '2', ('3', '4'), {'kwarg': '5'}))

def testPassThrough(self):
command = ['example8', 'test', '1', '--arg2=2', '3', '4', '--kwarg=5', '--flag']
self.assertEqual(
core.Fire(PassThroughArgs, command=command), tuple(command[1:]))


if __name__ == '__main__':
testutils.main()