如何使用查询参数构造 Django 反向/url？

Question

我的网址类似于 http://example.com/depict?smiles=CO& ;width=200&height=200 （以及其他几个可选参数）

我的 urls.py 包含：

urlpatterns = patterns('',
    (r'^$', 'cansmi.index'),
    (r'^cansmi$', 'cansmi.cansmi'),
    url(r'^depict$', cyclops.django.depict, name="cyclops-depict"),

我可以转到该 URL 并获取构建的 200x200 PNG，所以我知道该部分有效。

在“cansmi.cansmi”响应的模板中，我想在给定一些查询参数的情况下为命名模板“cyclops-depict”构造一个 URL。我以为我能做到

{% url cyclops-depict smiles=input_smiles width=200 height=200 %}

其中“input_smiles”是通过表单提交对模板的输入。在本例中，它是字符串“CO”，我认为它会创建一个像顶部那样的 URL。

此模板失败并出现 TemplateSyntaxError：

渲染时捕获异常：使用参数 '()' 和关键字参数 '{'smiles': u'CO', 'height': 200, 'width': 200}' 反转 'cyclops-depict' 不会找到了。

这是 StackOverflow 和其他地方相当常见的错误消息。在我发现的每种情况下，人们都将它们与 URL 路径正则表达式中的参数一起使用，而我在参数进入查询时的情况并非如此。

这意味着我做错了。我怎样做才正确？也就是说，我想使用模板中的某些内容构建完整的 URL，包括路径和查询参数。

供参考，

% python manage.py shell
Python 2.6.1 (r261:67515, Feb 11 2010, 00:51:29) 
[GCC 4.2.1 (Apple Inc. build 5646)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> from django.core.urlresolvers import reverse
>>> reverse("cyclops-depict", kwargs=dict())
'/depict'
>>> reverse("cyclops-depict", kwargs=dict(smiles="CO"))
Traceback (most recent call last):
  File "<console>", line 1, in <module>
  File "/Library/Python/2.6/site-packages/django/core/urlresolvers.py", line 356, in reverse
    *args, **kwargs)))
  File "/Library/Python/2.6/site-packages/django/core/urlresolvers.py", line 302, in reverse
    "arguments '%s' not found." % (lookup_view_s, args, kwargs))
NoReverseMatch: Reverse for 'cyclops-depict' with arguments '()' and keyword arguments '{'smiles': 'CO'}' not found.

Answer 1

正如某些答案所建议的那样，通过字符串连接构建查询字符串的 url 与通过字符串连接构建 SQL 查询一样糟糕。它很复杂、不优雅，而且对于用户提供的（不受信任的）输入尤其危险。不幸的是，Django 没有提供一种简单的方法来将查询参数传递到 reverse< /a> 函数。

然而，Python 标准 urllib 提供了所需的查询字符串编码功能。

在我的应用程序中，我创建了一个辅助函数：

def url_with_querystring(path, **kwargs):
    return path + '?' + urllib.urlencode(kwargs) # for Python 3, use urllib.parse.urlencode instead

然后我在视图中调用它，如下所示：

quick_add_order_url = url_with_querystring(reverse(order_add),
    responsible=employee.id, scheduled_for=datetime.date.today(),
    subject='hello world!')
# http://localhost/myapp/order/add/?responsible=5&
#     scheduled_for=2011-03-17&subject=hello+world%21

请注意空格和感叹号等特殊字符的正确编码！

Answer 2

您的常规表达式没有占位符（这就是您获得 NoReverseMatch 的原因）：

url(r'^depict
您可以这样做：
{% url cyclops-depict %}?smiles=CO&width=200&height=200

 URLconf 搜索不包含 GET 或 POST 参数
或者，如果您希望使用 {% url %} 标记，您应该将 url 模式重构为类似这样的
r'^depict/(?P<width>\d+)/(?P<height>\d+)/(?P<smiles>\w+)
内容你可以做类似
{% url cyclops-depict 200 200 "CO" %}


后续：
自定义标签的简单示例：
from django.core.urlresolvers import reverse
from django import template
register = template.Library()

@register.tag(name="myurl")
def myurl(parser, token):
    tokens = token.split_contents()
    return MyUrlNode(tokens[1:])

class MyUrlNode(template.Node):
    def __init__(self, tokens):
        self.tokens = tokens
    def render(self, context):
        url = reverse('cyclops-depict')
        qs = '&'.join([t for t in self.tokens])
        return '?'.join((url,qs))

你可以在模板中使用此标签，如下所示：
{% myurl width=200 height=200 name=SomeName %}

并希望它应该输出类似的内容
/depict?width=200&height=200&name=SomeName

, cyclops.django.depict, name="cyclops-depict"),

您可以这样做：

 URLconf 搜索不包含 GET 或 POST 参数
或者，如果您希望使用 {% url %} 标记，您应该将 url 模式重构为类似这样的

内容你可以做类似


后续：
自定义标签的简单示例：

你可以在模板中使用此标签，如下所示：

并希望它应该输出类似的内容

 

内容你可以做类似

---

后续：

自定义标签的简单示例：

你可以在模板中使用此标签，如下所示：

并希望它应该输出类似的内容

, cyclops.django.depict, name="cyclops-depict"),

您可以这样做：

URLconf 搜索不包含 GET 或 POST 参数

或者，如果您希望使用 {% url %} 标记，您应该将 url 模式重构为类似这样的

内容你可以做类似

---

后续：

自定义标签的简单示例：

你可以在模板中使用此标签，如下所示：

并希望它应该输出类似的内容

Answer 3

我建议使用内置 django 的 QueryDict。它还可以正确处理列表。 End 自动转义一些特殊字符（例如 =、?、/、'#'）：

from django.http import QueryDict
from django.core.urlresolvers import reverse

q = QueryDict('', mutable=True)
q['some_key'] = 'some_value'
q.setlist('some_list', [1,2,3])
'%s?%s' % (reverse('some_view_name'), q.urlencode())
# '/some_url/?some_list=1&some_list=2&some_list=3&some_key=some_value'

q.appendlist('some_list', 4)
q['value_with_special_chars'] = 'hello=w#rld?'
'%s?%s' % (reverse('some_view_name'), q.urlencode())
# '/some_url/?value_with_special_chars=hello%3Dw%23rld%3F&some_list=1&some_list=2&some_list=3&some_list=4&some_key=some_value'

要在模板中使用它，您需要创建自定义模板标签

Answer 4

以前的答案的工作变化以及我处理这些东西的经验。

from django.urls import reverse
from django.utils.http import urlencode

def build_url(*args, **kwargs):
    params = kwargs.pop('params', {})
    url = reverse(*args, **kwargs)
    if params:
        url += '?' + urlencode(params)
    return url

使用方法：

>>> build_url('products-detail', kwargs={'pk': 1}, params={'category_id': 2})
'/api/v1/shop/products/1/?category_id=2'

Answer 5

使用 urllib 的答案确实很好，但是当它试图避免字符串连接时，它在 path + '?' 中使用了它+ urllib.urlencode(kwargs)。我相信当 path 已经有一些查询参数时，这可能会产生问题。

修改后的函数如下所示：

def url_with_querystring(url, **kwargs):
    url_parts = list(urlparse.urlparse(url))
    query = dict(urlparse.parse_qsl(url_parts[4]))
    query.update(kwargs)
    url_parts[4] = urllib.urlencode(query)
    return urlparse.urlunparse(url_parts)

Answer 6

两个原始答案都没有解决解决视图代码中 URL 的相关问题。对于未来的搜索者，如果您尝试执行此操作，请使用 kwargs，例如：

reverse('myviewname', kwargs={'pk': value})