<filename>argv/parsers/descriptive.py
from argv.iterables import peekable
from argv.flags import parse_tokens
from argv.parsers.boolean import BooleanParser, BooleanArgument


class DescriptiveArgument(BooleanArgument):
    # not much more than a named tuple
    def __init__(self, names, default, boolean, positional, help=None):
        # names is a list of strings, which can be anything that doesn't start with a '-'
        self.names = names
        # default can be any value, but defaults to None
        self.default = default
        # boolean is itself a boolean, defaulting to False
        self.boolean = boolean
        # positional is a string if any of the given names were specified without a -x or --flag marker, otherwise None
        self.positional = positional

    def __repr__(self):
        named_attrs = ['default', 'boolean', 'positional', 'help']
        return '%s(%r, %s)' % (self.__class__.__name__, self.names,
            ', '.join(key + '=' + repr(getattr(self, key)) for key in named_attrs))


class DescriptiveParser(BooleanParser):
    def __init__(self, arguments=None):
        self.arguments = arguments or []

    def add(self, *matches, **kw):  # kw=default=None, boolean=False
        '''Add an argument; this is optional, and mostly useful for setting up aliases or setting boolean=True

        See BooleanParser.add for an explanation of the weird options.
        '''
        # python syntax hack
        default = kw.get('default', None)
        boolean = kw.get('boolean', False)
        help = kw.get('help', None)
        del kw
        positional = None
        names = []
        for match in matches:
            if match.startswith('--'):
                names.append(match[2:])
            elif match.startswith('-'):
                names.append(match[1:])
            elif positional:
                # positional has already been filled
                names.append(match)
            else:
                # first positional: becomes canonical positional
                positional = match
                names.append(match)

        argument = DescriptiveArgument(names, default, boolean, positional, help)
        self.arguments.append(argument)

        # chainable
        return self

    def parse(self, complete=True, args=None):
        '''Parse a list of arguments, returning a dict

        See BooleanParser.parse for `args`-related documentation.

        If `complete` is True and there are values in `args` that don't have corresponding arguments,
        or there are required arguments that don't have args, then raise an error.
        '''
        opts = dict()
        positions = [argument.positional for argument in self.arguments if argument.positional]

        if args is None:
            import sys
            # skip over the program name with the [1:] slice
            args = sys.argv[1:]

        # arglist is a tuple of (is_flag, name) pairs
        arglist = peekable(parse_tokens(args))
        for is_flag, name in arglist:
            if is_flag is True:
                argument = self.find_argument(name)

                # .peek will return the default argument iff there are no more entries
                next_is_flag, next_name = arglist.peek(default=(None, None))
                # next_is_flag will be None if there are no more items, but True/False if there is a next item

                # if this argument looks for a subsequent (is set as boolean), and the subsequent is not a flag, consume it
                if argument.boolean is False and next_is_flag is False:
                    opts[name] = next_name
                    # finally, advance our iterator, but since we already have the next values, just discard it
                    next(arglist)
                else:
                    # if there is no next, or the next thing is a flag all the boolean=False's in the world can't save you then
                    opts[name] = True
            else:
                # add positional argument
                if len(positions) > 0:
                    # we pop the positions off from the left
                    position = positions.pop(0)
                    opts[position] = name
                else:
                    # the rest of the args now end up as a list in '_'
                    opts.setdefault('_', []).append(name)

        # propagate aliases and defaults:
        for argument in self.arguments:
            # merge provided value from aliases
            for name in argument.names:
                if name in opts:
                    value = opts[name]
                    # we simply break on the first match.
                    break
            else:
                # if we iterate through all names and fine none in opts, use the default
                value = argument.default

            for name in argument.names:
                opts[name] = value

        return opts

<filename>argv/parsers/descriptive.py
from argv.iterables import peekable
from argv.flags import parse_tokens
from argv.parsers.boolean import BooleanParser, BooleanArgument


class DescriptiveArgument(BooleanArgument):
    # not much more than a named tuple
    def __init__(self, names, default, boolean, positional, help=None):
        # names is a list of strings, which can be anything that doesn't start with a '-'
        self.names = names
        # default can be any value, but defaults to None
        self.default = default
        # boolean is itself a boolean, defaulting to False
        self.boolean = boolean
        # positional is a string if any of the given names were specified without a -x or --flag marker, otherwise None
        self.positional = positional

    def __repr__(self):
        named_attrs = ['default', 'boolean', 'positional', 'help']
        return '%s(%r, %s)' % (self.__class__.__name__, self.names,
            ', '.join(key + '=' + repr(getattr(self, key)) for key in named_attrs))


class DescriptiveParser(BooleanParser):
    def __init__(self, arguments=None):
        self.arguments = arguments or []

    def add(self, *matches, **kw):  # kw=default=None, boolean=False
        '''Add an argument; this is optional, and mostly useful for setting up aliases or setting boolean=True

        See BooleanParser.add for an explanation of the weird options.
        '''
        # python syntax hack
        default = kw.get('default', None)
        boolean = kw.get('boolean', False)
        help = kw.get('help', None)
        del kw
        positional = None
        names = []
        for match in matches:
            if match.startswith('--'):
                names.append(match[2:])
            elif match.startswith('-'):
                names.append(match[1:])
            elif positional:
                # positional has already been filled
                names.append(match)
            else:
                # first positional: becomes canonical positional
                positional = match
                names.append(match)

        argument = DescriptiveArgument(names, default, boolean, positional, help)
        self.arguments.append(argument)

        # chainable
        return self

    def parse(self, complete=True, args=None):
        '''Parse a list of arguments, returning a dict

        See BooleanParser.parse for `args`-related documentation.

        If `complete` is True and there are values in `args` that don't have corresponding arguments,
        or there are required arguments that don't have args, then raise an error.
        '''
        opts = dict()
        positions = [argument.positional for argument in self.arguments if argument.positional]

        if args is None:
            import sys
            # skip over the program name with the [1:] slice
            args = sys.argv[1:]

        # arglist is a tuple of (is_flag, name) pairs
        arglist = peekable(parse_tokens(args))
        for is_flag, name in arglist:
            if is_flag is True:
                argument = self.find_argument(name)

                # .peek will return the default argument iff there are no more entries
                next_is_flag, next_name = arglist.peek(default=(None, None))
                # next_is_flag will be None if there are no more items, but True/False if there is a next item

                # if this argument looks for a subsequent (is set as boolean), and the subsequent is not a flag, consume it
                if argument.boolean is False and next_is_flag is False:
                    opts[name] = next_name
                    # finally, advance our iterator, but since we already have the next values, just discard it
                    next(arglist)
                else:
                    # if there is no next, or the next thing is a flag all the boolean=False's in the world can't save you then
                    opts[name] = True
            else:
                # add positional argument
                if len(positions) > 0:
                    # we pop the positions off from the left
                    position = positions.pop(0)
                    opts[position] = name
                else:
                    # the rest of the args now end up as a list in '_'
                    opts.setdefault('_', []).append(name)

        # propagate aliases and defaults:
        for argument in self.arguments:
            # merge provided value from aliases
            for name in argument.names:
                if name in opts:
                    value = opts[name]
                    # we simply break on the first match.
                    break
            else:
                # if we iterate through all names and fine none in opts, use the default
                value = argument.default

            for name in argument.names:
                opts[name] = value

        return opts

# not much more than a named tuple # names is a list of strings, which can be anything that doesn't start with a '-' # default can be any value, but defaults to None # boolean is itself a boolean, defaulting to False # positional is a string if any of the given names were specified without a -x or --flag marker, otherwise None # kw=default=None, boolean=False Add an argument; this is optional, and mostly useful for setting up aliases or setting boolean=True          See BooleanParser.add for an explanation of the weird options. # python syntax hack # positional has already been filled # first positional: becomes canonical positional # chainable Parse a list of arguments, returning a dict          See BooleanParser.parse for `args`-related documentation.          If `complete` is True and there are values in `args` that don't have corresponding arguments,         or there are required arguments that don't have args, then raise an error. # skip over the program name with the [1:] slice # arglist is a tuple of (is_flag, name) pairs # .peek will return the default argument iff there are no more entries # next_is_flag will be None if there are no more items, but True/False if there is a next item # if this argument looks for a subsequent (is set as boolean), and the subsequent is not a flag, consume it # finally, advance our iterator, but since we already have the next values, just discard it # if there is no next, or the next thing is a flag all the boolean=False's in the world can't save you then # add positional argument # we pop the positions off from the left # the rest of the args now end up as a list in '_' # propagate aliases and defaults: # merge provided value from aliases # we simply break on the first match. # if we iterate through all names and fine none in opts, use the default