管理员¶
有关如何使用此模块中的模型和mixins的说明,请参阅:ref:admin-integration。
- class import_export.admin.ExportActionMixin(*args, **kwargs)¶
实现为管理员操作的带有导出功能的Mixin。
- change_form_template = 'admin/import_export/change_form.html'¶
变更表单模板
- export_admin_action(request, queryset)¶
操作在来自实例操作菜单的POST上运行(如果启用)。
- get_actions(request)¶
将导出操作添加到可用操作列表中。
- show_change_form_export = True¶
标记以指示是否在更改表单上显示“导出”按钮
- class import_export.admin.ExportActionModelAdmin(*args, **kwargs)¶
具有导出功能的ModelAdmin子类,作为管理操作实现。
- class import_export.admin.ExportMixin(*args, **kwargs)¶
导出 mixin。
这是为了与 ModelAdmin 混合使用而设计的。
- export_action(request)¶
处理导出表单和将数据导出到文件的默认工作流程。
- export_form_class¶
表单类用于初始导出步骤。若需禁用可选字段功能,请赋值给
ExportForm。
- export_template_name = 'admin/import_export/export.html'¶
导出视图模板
- get_export_data(file_format, request, queryset, **kwargs)¶
返回给定queryset的file_format表示。
- get_export_form_class()¶
获取用于读取导出格式的表单类。
- get_export_queryset(request)¶
返回导出的查询集。该查询集通过调用ModelAdmin的`get_queryset() <https://docs.djangoproject.com/en/dev/ref/contrib/admin/#django.contrib.admin.ModelAdmin.get_queryset>`_方法获得。
默认实现遵循应用的搜索和筛选条件。
- get_valid_export_item_pks(request)¶
已弃用:此方法已弃用,将在未来版本中移除。请改用 get_queryset() 或 get_export_queryset()。
返回一个有效的pks列表以供导出。此功能用于验证从Admin UI的“action”下拉菜单触发导出时哪些对象可以被导出。出于性能和/或安全原因,可以重写此功能以筛选返回的pks。
- 参数:
request -- 请求对象。
- 返回:
有效的pk列表(默认为表中所有pk)。
- has_export_permission(request)¶
返回请求是否具有导出权限。
- import_export_change_list_template = 'admin/import_export/change_list_export.html'¶
变更列表视图的模板
- to_encoding = None¶
导出数据编码
- class import_export.admin.ImportExportActionModelAdmin(*args, **kwargs)¶
ExportActionModelAdmin 的子类,具有导入/导出功能。导出功能以管理员操作的形式实现。
- class import_export.admin.ImportExportMixin(*args, **kwargs)¶
导入和导出mixin。
- import_export_change_list_template = 'admin/import_export/change_list_import_export.html'¶
变更列表视图的模板
- class import_export.admin.ImportExportModelAdmin(*args, **kwargs)¶
具有导入/导出功能的 ModelAdmin 子类。
- class import_export.admin.ImportMixin(*args, **kwargs)¶
导入 mixin。
这是为了与 django.contrib.admin.ModelAdmin 混合使用 https://docs.djangoproject.com/en/dev/ref/contrib/admin/
- confirm_form_class¶
用于确认导入步骤的form类
- create_confirm_form(request, import_form=None)¶
Added in version 3.0.
返回用于“确认”导入步骤的表单实例。此方法可扩展以在表单实例化后对表单进行动态更新。您也可以考虑覆盖以下内容:
- create_import_form(request)¶
Added in version 3.0.
返回一个表单实例用于'initial'导入步骤。该方法可以被扩展以在表单实例化后对表单进行动态更新。您也可以考虑重写以下内容:
- from_encoding = 'utf-8-sig'¶
导入数据编码
- get_confirm_form_class(request)¶
Added in version 3.0.
返回用于“确认”导入步骤的表单类。如果只有一个自定义表单类,可以设置``confirm_form_class``属性来为子类更改此项。
- get_confirm_form_initial(request, import_form)¶
Added in version 3.0.
返回一个初始字段值的字典,提供给'confirm'表单。
- get_confirm_form_kwargs(request, import_form=None)¶
Added in version 3.0.
返回用于初始化'confirm'表单的值的字典(包括由:meth:`~import_export.admin.ImportMixin.get_confirm_form_initial`返回的初始值)。
- get_import_data_kwargs(**kwargs)¶
为import_data准备kwargs。
- get_import_form_class(request)¶
Added in version 3.0.
返回用于'import'步骤的表单类。如果只有一个自定义表单类,可以设置``import_form_class``属性来为子类更改此项。
- get_import_form_initial(request)¶
Added in version 3.0.
返回一个初始字段值的字典,提供给'import'表单。
- get_import_form_kwargs(request)¶
Added in version 3.0.
返回用于初始化'import'表单的值的字典(包括由:meth:`~import_export.admin.ImportMixin.get_import_form_initial`返回的初始值)。
- get_tmp_storage_class_kwargs()¶
重写此方法以向临时存储类提供额外的 kwargs。
- has_import_permission(request)¶
返回请求是否具有导入权限。
- import_action(request, **kwargs)¶
执行导入的dry_run以确保导入不会导致错误。如果没有错误,将用户上传的文件保存到本地临时文件,该文件将被'process_import'用于实际导入。
- import_error_display = ('message',)¶
控制导入错误显示时出现的UI元素。可用选项:'message'、'row'、'traceback'
- import_export_change_list_template = 'admin/import_export/change_list_import.html'¶
变更列表视图的模板
- import_form_class¶
表单类用于初始导入步骤
ImportForm的别名
- import_template_name = 'admin/import_export/import.html'¶
导入视图的模板
- process_import(request, **kwargs)¶
执行实际的导入操作(在用户确认导入后)