from django import template from django.core.exceptions import ImproperlyConfigured from classytags.exceptions import InvalidFlag from classytags.utils import NULL from classytags.utils import TemplateConstant from classytags.utils import mixin from classytags.values import ChoiceValue from classytags.values import DictValue from classytags.values import IntegerValue from classytags.values import ListValue from classytags.values import StrictStringValue from classytags.values import StringValue class Argument(object): """ A basic single value argument. """ value_class = StringValue def __init__(self, name, default=None, required=True, resolve=True): self.name = name self.default = default self.required = required self.resolve = resolve def __repr__(self): # pragma: no cover return '<%s: %s>' % (self.__class__.__name__, self.name) def get_default(self): """ Get the default value """ return TemplateConstant(self.default) def parse_token(self, parser, token): if self.resolve: return parser.compile_filter(token) else: return TemplateConstant(token) def parse(self, parser, token, tagname, kwargs): """ Parse a token. """ if self.name in kwargs: return False else: value = self.parse_token(parser, token) kwargs[self.name] = self.value_class(value) return True class StringArgument(Argument): value_class = StrictStringValue class KeywordArgument(Argument): """ A single 'key=value' argument """ wrapper_class = DictValue def __init__(self, name, default=None, required=True, resolve=True, defaultkey=None, splitter='='): super(KeywordArgument, self).__init__(name, default, required, resolve) self.defaultkey = defaultkey self.splitter = splitter def get_default(self): if self.defaultkey: return self.wrapper_class({ self.defaultkey: TemplateConstant(self.default) }) else: return self.wrapper_class({}) def parse_token(self, parser, token): if self.splitter in token: key, raw_value = token.split(self.splitter, 1) value = super(KeywordArgument, self).parse_token(parser, raw_value) else: key = self.defaultkey value = super(KeywordArgument, self).parse_token(parser, token) return key, self.value_class(value) def parse(self, parser, token, tagname, kwargs): if self.name in kwargs: # pragma: no cover return False else: key, value = self.parse_token(parser, token) kwargs[self.name] = self.wrapper_class({ key: value }) return True class IntegerArgument(Argument): """ Same as Argument but converts the value to integers. """ value_class = IntegerValue class ChoiceArgument(Argument): """ An Argument which checks if it's value is in a predefined list of choices. """ def __init__(self, name, choices, default=None, required=True, resolve=True): super(ChoiceArgument, self).__init__(name, default, required, resolve) if default or not required: value_on_error = default else: value_on_error = choices[0] self.value_class = mixin( self.value_class, ChoiceValue, attrs={ 'choices': choices, 'value_on_error': value_on_error, } ) class MultiValueArgument(Argument): """ An argument which allows multiple values. """ sequence_class = ListValue value_class = StringValue def __init__(self, name, default=NULL, required=True, max_values=None, resolve=True): self.max_values = max_values if default is NULL: default = [] else: required = False super(MultiValueArgument, self).__init__(name, default, required, resolve) def parse(self, parser, token, tagname, kwargs): """ Parse a token. """ value = self.value_class(self.parse_token(parser, token)) if self.name in kwargs: if self.max_values and len(kwargs[self.name]) == self.max_values: return False kwargs[self.name].append(value) else: kwargs[self.name] = self.sequence_class(value) return True class MultiKeywordArgument(KeywordArgument): def __init__(self, name, default=None, required=True, resolve=True, max_values=None, splitter='='): if not default: default = {} else: default = dict(default) super(MultiKeywordArgument, self).__init__(name, default, required, resolve, NULL, splitter) self.max_values = max_values def get_default(self): items = self.default.items() return self.wrapper_class( dict([(key, TemplateConstant(value)) for key, value in items]) ) def parse(self, parser, token, tagname, kwargs): key, value = self.parse_token(parser, token) if key is NULL: raise template.TemplateSyntaxError( "MultiKeywordArgument arguments require key=value pairs" ) if self.name in kwargs: if self.max_values and len(kwargs[self.name]) == self.max_values: return False kwargs[self.name][key] = value else: kwargs[self.name] = self.wrapper_class({ key: value }) return True class Flag(Argument): """ A boolean flag """ def __init__(self, name, default=NULL, true_values=None, false_values=None, case_sensitive=False): if default is not NULL: required = False else: required = True super(Flag, self).__init__(name, default, required) if true_values is None: true_values = [] if false_values is None: false_values = [] if case_sensitive: self.mod = lambda x: x else: self.mod = lambda x: str(x).lower() self.true_values = [self.mod(tv) for tv in true_values] self.false_values = [self.mod(fv) for fv in false_values] if not any([self.true_values, self.false_values]): raise ImproperlyConfigured( "Flag must specify either true_values and/or false_values" ) def parse(self, parser, token, tagname, kwargs): """ Parse a token. """ ltoken = self.mod(token) if self.name in kwargs: return False if self.true_values and ltoken in self.true_values: kwargs[self.name] = TemplateConstant(True) elif self.false_values and ltoken in self.false_values: kwargs[self.name] = TemplateConstant(False) elif self.default is NULL: allowed_values = [] if self.true_values: allowed_values += self.true_values if self.false_values: allowed_values += self.false_values raise InvalidFlag(self.name, token, allowed_values, tagname) else: kwargs[self.name] = self.get_default() return True