django-spurl 0.6.8

base

如果您将base参数传递给Spurl，它将解析其内容，并使用此作为基础URL，所有其他参数都将在此URL上操作。如果您没有传递base参数，Spurl将根据您单独传递的组件从头开始生成URL。

scheme

设置URL的方案组件。示例

{% spurl base="http://example.com" scheme="ftp" %}

这将返回ftp://example.com

另请参阅下方的 scheme_from。

主机

设置URL的主机部分。示例

{% spurl base="http://example.com/some/path/" host="google.com" %}

这将返回 http://google.com/some/path/

另请参阅下方的 host_from。

认证

处理HTTP基本认证，用户名和密码可以包含在URL中。示例

{% spurl base="https://example.com" auth="user:pass" %}

这将返回 https://user:pass@example.com

路径

设置URL的路径部分。示例

{% spurl base="http://example.com/some/path/" path="/different/" %}

这将返回 http://example.com/different/

另请参阅下方的 path_from。

添加路径

向现有路径追加路径部分。您可以多次调用 add_path，并将每次的结果合并。示例

{% spurl base=STATIC_URL add_path="javascript" add_path="lib" add_path="jquery.js" %}

这将返回 http://cdn.example.com/javascript/lib/jquery.js （假设 STATIC_URL 设置为 http://cdn.example.com）

另请参阅下方的 add_path_from。

片段

设置URL的片段部分。示例

{% spurl base="http://example.com" fragment="myfragment" %}

这将返回 http://example.com/#myfragment

另请参阅下方的 fragment_from。

端口

设置URL的端口部分。示例

{% spurl base="http://example.com/some/path/" port="8080" %}

这将返回 http://example.com:8080/some/path/

另请参阅下方的 port_from。

查询

设置URL的查询部分。示例

{% spurl base="http://example.com/" query="foo=bar&bar=baz" %}

这将返回 http://example.com/?foo=bar&bar=baz

查询参数也可以是来自您模板上下文的字典。

# views.py
def my_view(request):
    my_query_params = {'foo': 'bar', 'bar': 'baz'}
    return render(request, 'path/to/template.html', {'my_query_params': my_query_params})

<!-- template.html -->
{% spurl base="http://example.com/" query=my_query_params %}

这将返回 http://example.com/?foo=bar&bar=baz

最后，您可以将单个模板变量传递给查询。为此，Spurl使用Django的模板系统。例如

{% spurl base="http://example.com/" query="foo={{ variable_name }}" %}

另请参阅下方的 query_from。

添加查询

向现有查询追加一组参数。如果基本URL可能已经包含查询组件，这将合并现有参数和新的参数。示例

{% spurl base="http://example.com/?foo=bar" add_query="bar=baz" %}

这将返回 http://example.com?foo=bar&bar=baz

您可以多次添加 add_query 调用，并将每次的结果合并。

{% spurl base="http://example.com/" add_query="foo=bar" add_query="bar=baz" %}

这将返回 http://example.com?foo=bar&bar=baz

与上面的 query 参数一样，传递给 add_query 的值也可以是字典，并且它们可以包含Django模板变量。

另请参阅下方的 add_query_from。

设置查询

向现有查询追加一组参数，用同名参数覆盖现有参数。否则使用与 add_query 完全相同的语法。

另请参阅下方的 set_query_from。

切换查询

在两个可能的值之间切换一个或多个查询参数的值。当重新排序列表视图时非常有用。示例

{% spurl base=request.get_full_path toggle_query="sort=ascending,descending" %}

如果 request.get_full_path() 的值没有 sort 参数，将添加一个具有 ascending（列表中的第一个项是默认值）值的参数。如果它已经有一个 sort 参数，并且当前设置为 ascending，则将其设置为 descending。如果它已经设置为 descending，则将其设置为 ascending。

您还可以指定选项为字典，将参数名称映射到包含要切换的值的两个元组。

# views.py

SORT_PARAM = 'sort'
ASCENDING = 'ascending'
DESCENDING = 'descending'

def my_view(request):

    if request.GET.get(SORT_PARAM, ASCENDING) == DESCENDING:
        object_list = MyModel.objects.order_by('-somefield')
    else:
        object_list = MyModel.objects.order_by('somefield')

    return render(request, 'path/to/template.html', {
        'object_list': object_list,
        'sort_params': {SORT_PARAM: (ASCENDING, DESCENDING)},
    })

<!-- template.html -->
<a href="{% spurl base=request.get_full_path toggle_query=sort_params %}">Reverse order</a>

删除查询参数

从现有查询中删除查询参数

{% spurl base="http://example.com/?foo=bar&bar=baz" remove_query_param="foo" %}

这将返回 http://example.com?bar=baz

再次，您可以添加多个 remove_query_param 调用，结果将合并

{% spurl base="http://example.com/?foo=bar&bar=baz" remove_query_param="foo" remove_query_param="bar" %}

这将返回 http://example.com/

您还可以删除具有特定值的参数

{% spurl base="http://example.com/?foo=bar&bar=baz&foo=baz" remove_query_param="foo" remove_query_param="foo=baz" %}

这将返回 http://example.com/?bar=baz

最后，您可以向 remove_query_param 调用传递单个模板变量。为此，Spurl 使用 Django 的模板系统。例如

{% spurl base="http://example.com/?foo=bar&bar=baz" remove_query_param="{{ variable_name }}" %}

secure

控制生成的 URL 是否以 http 或 https 开头。此参数的值可以是布尔值（True 或 False），如果您使用上下文变量。如果您在此处使用字面量参数，它必须是一个引号字符串。字符串 "True" 或 "on"（不区分大小写）将被转换为 True，任何其他字符串将被转换为 False。示例

{% spurl base="http://example.com/" secure="True" %}

这将返回 https://example.com/

autoescape

默认情况下，Spurl 将以与 Django 模板系统相同的方式转义其输出。例如，URL 中的 & 字符将渲染为 &。您可以通过传递一个 autoescape 参数来覆盖此行为，该参数必须是布尔值（如果从模板变量传递）或字符串。字符串 "True" 或 "on"（不区分大小写）将被转换为 True，任何其他字符串将被转换为 False。