def test_del_query_param_value_removes_matching_query_parameters(self):
url = URLObject(
'https://github.com/zacharyvoase/urlobject?foo=bar&baz=spam&foo=qux&foo=bar#foo'
)
assert (url.del_query_param_value(
'foo', 'bar'
) == 'https://github.com/zacharyvoase/urlobject?baz=spam&foo=qux#foo')
class SpurlURLBuilder(object):
def __init__(self, args, context, tags, filters):
self.args = args
self.context = context
self.tags = tags
self.filters = filters
self.autoescape = self.context.autoescape
self.url = URLObject()
def build(self):
for argument, value in self.args:
self.handle_argument(argument, value)
self.set_sensible_defaults()
url = six.text_type(self.url)
if self.autoescape:
url = escape(url)
return url
def handle_argument(self, argument, value):
argument = smart_str(argument, 'ascii')
handler_name = 'handle_%s' % argument
handler = getattr(self, handler_name, None)
if handler is not None:
value = value.resolve(self.context)
handler(value)
def handle_base(self, value):
base = self.prepare_value(value)
self.url = URLObject(base)
def handle_auth(self, value):
auth = self.prepare_value(value)
self.url = self.url.with_auth(*auth.split(':', 1))
def handle_secure(self, value):
is_secure = convert_to_boolean(value)
scheme = 'https' if is_secure else 'http'
self.url = self.url.with_scheme(scheme)
def handle_query(self, value):
query = self.prepare_value(value)
if isinstance(query, dict):
query = QueryString().set_params(**query)
self.url = self.url.with_query(QueryString(query))
def handle_query_from(self, value):
url = URLObject(value)
self.url = self.url.with_query(url.query)
def handle_add_query(self, value):
query_to_add = self.prepare_value(value)
if isinstance(query_to_add, six.string_types):
query_to_add = QueryString(query_to_add).dict
self.url = self.url.add_query_params(**query_to_add)
def handle_add_query_from(self, value):
url = URLObject(value)
self.url = self.url.add_query_params(**url.query.dict)
def handle_set_query(self, value):
query_to_set = self.prepare_value(value)
if isinstance(query_to_set, six.string_types):
query_to_set = QueryString(query_to_set).dict
self.url = self.url.set_query_params(**query_to_set)
def handle_set_query_from(self, value):
url = URLObject(value)
self.url = self.url.set_query_params(**url.query.dict)
def handle_remove_query_param(self, value):
query_to_remove = self.prepare_value(value)
if '=' in query_to_remove:
k, v = query_to_remove.split('=', 1)
self.url = self.url.del_query_param_value(k, v)
else:
self.url = self.url.del_query_param(query_to_remove)
def handle_remove_query_params_except(self, value):
params_to_keep = self.prepare_value(value).split(" ")
params_to_remove = [
pair[0] for pair in self.url.query_list
if pair[0] not in params_to_keep
]
self.url = self.url.with_query(
self.url.query.del_params(params_to_remove))
def handle_toggle_query(self, value):
query_to_toggle = self.prepare_value(value)
if isinstance(query_to_toggle, six.string_types):
query_to_toggle = QueryString(query_to_toggle).dict
current_query = self.url.query.dict
for key, value in list(query_to_toggle.items()):
if isinstance(value, six.string_types):
value = value.split(',')
first, second = value
if key in current_query and first in current_query[key]:
self.url = self.url.set_query_param(key, second)
else:
self.url = self.url.set_query_param(key, first)
def handle_scheme(self, value):
self.url = self.url.with_scheme(value)
def handle_scheme_from(self, value):
url = URLObject(value)
self.url = self.url.with_scheme(url.scheme)
def handle_host(self, value):
host = self.prepare_value(value)
self.url = self.url.with_hostname(host)
def handle_host_from(self, value):
url = URLObject(value)
self.url = self.url.with_hostname(url.hostname)
def handle_path(self, value):
path = self.prepare_value(value)
self.url = self.url.with_path(path)
def handle_path_from(self, value):
url = URLObject(value)
self.url = self.url.with_path(url.path)
def handle_add_path(self, value):
path_to_add = self.prepare_value(value)
self.url = self.url.add_path(path_to_add)
def handle_add_path_from(self, value):
url = URLObject(value)
path_to_add = url.path
if path_to_add.startswith('/'):
path_to_add = path_to_add[1:]
self.url = self.url.add_path(path_to_add)
def handle_fragment(self, value):
fragment = self.prepare_value(value)
self.url = self.url.with_fragment(fragment)
def handle_fragment_from(self, value):
url = URLObject(value)
self.url = self.url.with_fragment(url.fragment)
def handle_port(self, value):
self.url = self.url.with_port(int(value))
def handle_port_from(self, value):
url = URLObject(value)
self.url = self.url.with_port(url.port)
def handle_autoescape(self, value):
self.autoescape = convert_to_boolean(value)
def set_sensible_defaults(self):
if self.url.hostname and not self.url.scheme:
self.url = self.url.with_scheme('http')
def prepare_value(self, value):
"""Prepare a value by unescaping embedded template tags
and rendering through Django's template system"""
if isinstance(value, six.string_types):
value = self.render_template(self.unescape_tags(value))
return value
def unescape_tags(self, template_string):
"""Spurl allows the use of templatetags inside templatetags, if
the inner templatetags are escaped - {\% and %\}"""
return template_string.replace('{\%', '{%').replace('%\}', '%}')
def compile_string(self, template_string, origin, template_debug=False):
"""Re-implementation of django.template.base.compile_string
that takes into account the tags and filter of the parser
that rendered the parent template"""
if template_debug is True:
if django.VERSION < (1, 9):
from django.template.debug import DebugLexer, DebugParser
lexer_class, parser_class = DebugLexer, DebugParser
else:
from django.template.base import DebugLexer
lexer_class, parser_class = DebugLexer, Parser
else:
lexer_class, parser_class = Lexer, Parser
if django.VERSION < (1, 9):
lexer = lexer_class(template_string, origin)
else:
lexer = lexer_class(template_string)
parser = parser_class(lexer.tokenize())
# Attach the tags and filters from the parent parser
parser.tags = self.tags
parser.filters = self.filters
return parser.parse()
def render_template(self, template_string):
"""Used to render an "inner" template, ie one which
is passed as an argument to spurl"""
original_autoescape = self.context.autoescape
self.context.autoescape = False
template = Template('')
template_debug = getattr(
settings, 'TEMPLATE_DEBUG',
template.engine.debug if hasattr(template, 'engine') else False)
if template_debug is True:
origin = Origin(template_string)
else:
origin = None
template.nodelist = self.compile_string(template_string, origin,
template_debug)
rendered = template.render(self.context)
self.context.autoescape = original_autoescape
return rendered
def test_del_query_param_value_removes_matching_query_parameters(self):
url = URLObject('https://github.com/zacharyvoase/urlobject?foo=bar&baz=spam&foo=qux&foo=bar#foo')
assert (url.del_query_param_value('foo', 'bar') ==
'https://github.com/zacharyvoase/urlobject?baz=spam&foo=qux#foo')
class SpurlURLBuilder(object):
def __init__(self, args, context, tags, filters):
self.args = args
self.context = context
self.tags = tags
self.filters = filters
self.autoescape = self.context.autoescape
self.url = URLObject()
def build(self):
for argument, value in self.args:
self.handle_argument(argument, value)
self.set_sensible_defaults()
url = six.text_type(self.url)
if self.autoescape:
url = escape(url)
return url
def handle_argument(self, argument, value):
argument = smart_str(argument, 'ascii')
handler_name = 'handle_%s' % argument
handler = getattr(self, handler_name, None)
if handler is not None:
value = value.resolve(self.context)
handler(value)
def handle_base(self, value):
base = self.prepare_value(value)
self.url = URLObject(base)
def handle_auth(self, value):
auth = self.prepare_value(value)
self.url = self.url.with_auth(*auth.split(':', 1))
def handle_secure(self, value):
is_secure = convert_to_boolean(value)
scheme = 'https' if is_secure else 'http'
self.url = self.url.with_scheme(scheme)
def handle_query(self, value):
query = self.prepare_value(value)
if isinstance(query, dict):
query = QueryString().set_params(**query)
self.url = self.url.with_query(QueryString(query))
def handle_query_from(self, value):
url = URLObject(value)
self.url = self.url.with_query(url.query)
def handle_add_query(self, value):
query_to_add = self.prepare_value(value)
if isinstance(query_to_add, six.string_types):
query_to_add = QueryString(query_to_add).dict
self.url = self.url.add_query_params(**query_to_add)
def handle_add_query_from(self, value):
url = URLObject(value)
self.url = self.url.add_query_params(**url.query.dict)
def handle_set_query(self, value):
query_to_set = self.prepare_value(value)
if isinstance(query_to_set, six.string_types):
query_to_set = QueryString(query_to_set).dict
self.url = self.url.set_query_params(**query_to_set)
def handle_set_query_from(self, value):
url = URLObject(value)
self.url = self.url.set_query_params(**url.query.dict)
def handle_remove_query_param(self, value):
query_to_remove = self.prepare_value(value)
if '=' in query_to_remove:
k, v = query_to_remove.split('=', 1)
self.url = self.url.del_query_param_value(k, v)
else:
self.url = self.url.del_query_param(query_to_remove)
def handle_remove_query_params_except(self, value):
params_to_keep = self.prepare_value(value).split(" ")
params_to_remove = [pair[0] for pair in self.url.query_list if pair[0] not in params_to_keep]
self.url = self.url.with_query(self.url.query.del_params(params_to_remove))
def handle_toggle_query(self, value):
query_to_toggle = self.prepare_value(value)
if isinstance(query_to_toggle, six.string_types):
query_to_toggle = QueryString(query_to_toggle).dict
current_query = self.url.query.dict
for key, value in list(query_to_toggle.items()):
if isinstance(value, six.string_types):
value = value.split(',')
first, second = value
if key in current_query and first in current_query[key]:
self.url = self.url.set_query_param(key, second)
else:
self.url = self.url.set_query_param(key, first)
def handle_scheme(self, value):
self.url = self.url.with_scheme(value)
def handle_scheme_from(self, value):
url = URLObject(value)
self.url = self.url.with_scheme(url.scheme)
def handle_host(self, value):
host = self.prepare_value(value)
self.url = self.url.with_hostname(host)
def handle_host_from(self, value):
url = URLObject(value)
self.url = self.url.with_hostname(url.hostname)
def handle_path(self, value):
path = self.prepare_value(value)
self.url = self.url.with_path(path)
def handle_path_from(self, value):
url = URLObject(value)
self.url = self.url.with_path(url.path)
def handle_add_path(self, value):
path_to_add = self.prepare_value(value)
self.url = self.url.add_path(path_to_add)
def handle_add_path_from(self, value):
url = URLObject(value)
path_to_add = url.path
if path_to_add.startswith('/'):
path_to_add = path_to_add[1:]
self.url = self.url.add_path(path_to_add)
def handle_fragment(self, value):
fragment = self.prepare_value(value)
self.url = self.url.with_fragment(fragment)
def handle_fragment_from(self, value):
url = URLObject(value)
self.url = self.url.with_fragment(url.fragment)
def handle_port(self, value):
self.url = self.url.with_port(int(value))
def handle_port_from(self, value):
url = URLObject(value)
self.url = self.url.with_port(url.port)
def handle_autoescape(self, value):
self.autoescape = convert_to_boolean(value)
def set_sensible_defaults(self):
if self.url.hostname and not self.url.scheme:
self.url = self.url.with_scheme('http')
def prepare_value(self, value):
"""Prepare a value by unescaping embedded template tags
and rendering through Django's template system"""
if isinstance(value, six.string_types):
value = self.render_template(self.unescape_tags(value))
return value
def unescape_tags(self, template_string):
"""Spurl allows the use of templatetags inside templatetags, if
the inner templatetags are escaped - {\% and %\}"""
return template_string.replace('{\%', '{%').replace('%\}', '%}')
def compile_string(self, template_string, origin, template_debug=False):
"""Re-implementation of django.template.base.compile_string
that takes into account the tags and filter of the parser
that rendered the parent template"""
if template_debug is True:
if django.VERSION < (1, 9):
from django.template.debug import DebugLexer, DebugParser
lexer_class, parser_class = DebugLexer, DebugParser
else:
from django.template.base import DebugLexer
lexer_class, parser_class = DebugLexer, Parser
else:
lexer_class, parser_class = Lexer, Parser
if django.VERSION < (1, 9):
lexer = lexer_class(template_string, origin)
else:
lexer = lexer_class(template_string)
parser = parser_class(lexer.tokenize())
# Attach the tags and filters from the parent parser
parser.tags = self.tags
parser.filters = self.filters
return parser.parse()
def render_template(self, template_string):
"""Used to render an "inner" template, ie one which
is passed as an argument to spurl"""
original_autoescape = self.context.autoescape
self.context.autoescape = False
template = Template('')
template_debug = getattr(
settings, 'TEMPLATE_DEBUG', template.engine.debug if hasattr(
template, 'engine') else False)
if template_debug is True:
origin = Origin(template_string)
else:
origin = None
template.nodelist = self.compile_string(
template_string, origin, template_debug)
rendered = template.render(self.context)
self.context.autoescape = original_autoescape
return rendered
