从表单导出数据

Question

我需要一个用户输入一些日期，以便使用这些日期对数据库进行查询，因此我遵循了这些步骤，现在正在正常工作。我想要的是，除了显示响应中的数据之外，还可以将数据导出到文件中。要做到这一点，我已经做了一个表格，但我不知道如何继续。

我的问题是，我可以在哪里查阅有关如何从表单导出的文档？

视图

from django.shortcuts import render
from .forms import ContactForm

def filter_contracts(request):
    form = ContractForm(request.POST or None)
    contracts = None

    if request.method == 'POST':
        if form.is_valid():
                contracts = Contract.objects.filter(person__is_doctor=False,
                type_contract=Contract.FC,
                starting_date__gte=form.cleaned_data.get('starting_date'),
                ending_date__lte=form.cleaned_data.get('ending_date'))

    return render(request, 'your_template.html', {'form': form,
        'contracts': contracts})

窗体

class ContractForm(forms.Form):

    starting_date    = forms.DateField()
    ending_date       = forms.DateField()

模板

{% extends "admin/base_site.html" %}
{% load i18n admin_urls admin_static admin_modify %}

{% block content %}
<form action="." enctype="db_personal/x-www-form-urlencoded" method="POST">>
    <ul>
        {{ form.as_ul }}
    </ul>
    {% csrf_token %}
    <button type="submit">Search</button>
    <br> 
    <hr>
    {% if contracts %}
    <table border ="1" cellspacing="0">
        <th>Person</th>
        <th>Contract type</th>
        <th>Starting date</th>
        <th>Ending date</th>
        {% for contract in contracts %}
        <tr>
            <td>{{ contract.person }}</td>
            <td>{{ contract.type_contract }}</td>
            <td>{{ contract.starting_date }}</td>
            <td>{{ contract.ending_date }}</td>
        </tr>
        {% endfor %}
    </table>
    {% endif %}
</form>
{% endblock %}

Answer 1

如果您想将查询集结果作为HTML以外的内容返回，只需让您的视图以您选择的适当格式返回数据--这可能是csv、xml、json、yaml或纯文本。

参见Django文档中关于如何导出csv数据的示例：

• 用Django输出CSV

Django文档还有一个如何导出PDF的页面：

• 用Django输出PDF

在您的视图中--在处理表单和查询数据库之后--您应该设置响应的内容类型，这样浏览器就会知道它所期望的数据类型。格式化的数据将进入响应体。大多数浏览器只能显示HTML或纯文本，也可能是XML，但任何其他浏览器都可以作为文件下载到用户的计算机上。

处理“下载”按钮的示例代码

步骤1

在forms.py中，添加一个额外的表单来处理“下载”按钮：

from django import forms

class ContractForm(forms.Form):
    starting_date    = forms.DateField()
    ending_date       = forms.DateField()

class DownloadForm(forms.Form):
    starting_date = forms.CharField(widget=forms.HiddenInput)
    ending_date = forms.CharField(widget=forms.HiddenInput)

此表单包含两个隐藏字段--用于starting_date和ending_date。我们将根据初始的搜索查询参数填充这些字段。

步骤2

在views.py中，添加代码以呈现DownloadForm (作为按钮)：

from django.shortcuts import render
from .forms import ContractForm, DownloadForm

def filter_contracts(request):
    form = ContractForm(request.POST or None)
    contracts = None
    download_form = None

    if request.method == 'POST':
        if form.is_valid():
            starting_date = form.cleaned_data.get('starting_date')
            ending_date = form.cleaned_data.get('ending_date')
            contracts = Contract.objects.filter(person__is_doctor=False,
                                                type_contract=Contract.FC,
                                                starting_date__gte=starting_date,
                                                ending_date__lte=ending_date)
            # Create the DownloadForm instance here so you can pass it in the
            # context dict.
            download_form = DownloadForm(initial={
                'starting_date': starting_date,
                'ending_date': ending_date
            })

    return render(request, 'your_template.html',
                  {
                      'form': form,
                      'contracts': contracts,
                      'download_form': download_form
                  })

当实例化DownloadForm时，视图将starting_date和ending_date设置为表单的初始参数，因此当模板呈现它时，它将在隐藏字段中包含查询参数。(您可以使用浏览器来确认这一点。)

步骤3

现在，修改模板以添加Download按钮表单(这是您在上面步骤中添加到视图中的DownloadForm实例)：

{% extends "admin/base_site.html" %}
{% load i18n admin_urls admin_static admin_modify %}

{% block content %}

<form action="." enctype="db_personal/x-www-form-urlencoded" method="POST">
    <ul>
        {{ form.as_ul }}
    </ul>
    {% csrf_token %}
    <button type="submit">Search</button>
    <br> 
    <hr>
    {% if contracts %}
    <table border ="1" cellspacing="0">
        <th>Person</th>
        <th>Contract type</th>
        <th>Starting date</th>
        <th>Ending date</th>
        {% for contract in contracts %}
        <tr>
            <td>{{ contract.person }}</td>
            <td>{{ contract.type_contract }}</td>
            <td>{{ contract.starting_date }}</td>
            <td>{{ contract.ending_date }}</td>
        </tr>
        {% endfor %}
    </table>
    {% endif %}
</form>

{% if download_form %}
<form action="{% url 'download_data' %}"  method="POST">
    {% csrf_token %}
    {{ download_form.as_p }}
    <p>
        <input type="submit" class="btn" name="submit" value="Download" />
    </p>
</form>
{% endif %}

{% endblock %}

注意，下载按钮的表单action使用名为download_data的url。您必须向urls.py中添加一个新的url规则来处理下载表单提交(请参阅下一步)。

步骤4

向urls.py添加新规则以处理下载表单提交。这将映射到我们将要创建的一个新视图，以以CSV格式返回请求的数据：

from django.conf.urls import patterns, url

from .views import filter_contracts, download_data

urls = patterns(
    # url prefix
    '',

    # view to render search form
    url(r'^contracts/$', filter_contracts, name='search_contracts'),

    # view to handle data download
    url(r'^contracts/download/$', download_data, name='download_data')
)

您必须根据您已经设置的内容调整url配置规则。以上只是一个指南和例子。

步骤5

现在，在views.py中添加几个新视图来处理下载按钮提交和数据获取：

def get_csv_data(starting_date, ending_date):
    """
    Prepare data in csv format for download.
    * This is called by ``download_data`` to perform the query.
    * Do your query here and format the results as CSV using a csv
      writer or manually.
    * For this example, we're using some dummy data.
    """
    data = []
    num = 10
    for n in xrange(num):
        person = 'Person {}'.format(n + 1)
        type_contract = 'Some contract'
        start_date = starting_date
        end_date = ending_date
        data.append(', '.join([start_date, end_date, person, type_contract]))
    return '\n'.join(data)

def download_data(request):
    """
    Process a request to download data.
    * POST must contain 'starting_date' and 'ending_date'.
    """
    from django.http import HttpResponse

    try:
        assert request.method == 'POST'
        form = DownloadForm(request.POST)
        assert form.is_valid()
        starting_date = form.cleaned_data.get('starting_date')
        ending_date = form.cleaned_data.get('ending_date')
        assert starting_date and ending_date
        contracts = get_csv_data(starting_date, ending_date)
        assert contracts
    except AssertionError:
        error = 'Your request has some problems.'
        contracts = error

    attachment = 'contract_data.csv'
    response = HttpResponse(content_type='text/csv')
    response['Content-Disposition'] = 'attachment;filename="{}"'.format(attachment)
    response.write(contracts)
    return response

上面的get_csv_data函数只是为测试准备一些虚拟数据的一个例子。您应该将数据库查询代码放在那里，以获取所需的查询集，然后将数据格式化为CSV。(示例函数手动格式化虚拟数据，但是您应该使用csv模块来准备数据--请参阅这个答案开头的Django示例以获得链接)。

摘要

其基本思想是：

• 当呈现来自查询的契约搜索结果时，只需向页面添加一个额外的DownloadForm实例。这只显示为一个Download按钮，但它包含了starting_date和ending_date的隐藏字段。
• 当用户单击Download按钮时，表单将提交到一个名为download_data的新视图，该视图检查request.POST dict并提取starting_date和ending_date。然后，它准备查询集数据并以CSV格式呈现。
• 然后，download_data视图将响应作为带有内容类型text/csv的附件返回。用户的浏览器将自动将其作为下载文件处理。

代码中有最小的错误和安全检查，但这将使您开始工作。