标签： django

很多人对Django自带的管理后台admin是又爱又恨，优点是几行代码配置就可以撸出一个功能性强的管理后台，缺点就是不怎么美观，感觉拿不出手。在所有的Django后台美化插件中，SimpleUI处于第一阵营，非常符合国人的审美观。本文将手把手教你如何配置使用Simple UI, 包括自定义菜单和控制面板等高级使用技巧.

安装

第一步 pip安装并加入INSTALLED_APPS

 pip install django-simpleui

修改settings.py, 将simpleui加入到INSTALLED_APPS里去，放在第一行，也就是django自带admin的前面。

 INSTALLED_APPS = [
       'simpleui', # 注意这里
       'django.contrib.admin',
       'django.contrib.auth',
       'django.contrib.contenttypes',
       'django.contrib.sessions',
       'django.contrib.messages',
       'django.contrib.staticfiles',
       ...     
 ]

第二步 测试是否安装成功

使用python manage.py runserver命令启动本地测试服务器, 访问/admin/, 如果你能看到如下页面说明安装成功。

登录后你还将看到如下用户界面：

注意：如果你在生成环境中使用SimpleUI，还需要使用python manage.py collectstatic命令收集静态文件，否则样式无法正常显示。

常用配置

设置语言, 去Logo和管理后台名字

当你看到以上界面时，首先你想改动的一定是语言，去掉SimpleUI的默认logo，并把Django administration改成比如某某管理后台的名字。

修改settings.py， 添加如下代码：

 # 更改默认语言为中文
 LANGUAGE_CODE = 'zh-hans'
 
 # 去掉默认Logo或换成自己Logo链接
 SIMPLEUI_LOGO = 'https://th.bing.com/th/id/R2411a2b340731d67dfa0d84503e915e3?rik=zmYce%2fLys72JVQ&pid=ImgRaw'

修改管理后台的名称和标题要稍微复杂些，因为你不能直接在settings.py里进行配置。在任何一个app的目录下新建一个admin.py, 添加如下代码即可修改(本例app名为tasks)。这个设置属于Django的设置，不属于SimpleUI的设置。

 # tasks/admin.py
 from django.contrib import admin
 
 admin.site.site_header = '大江狗管理后台'  # 设置header
 admin.site.site_title = '大江狗管理后台'   # 设置title
 admin.site.index_title = '大江狗管理后台'
 
 from .models import Task
 admin.site.register(Task)

登录后的效果如下所示：

现在你可以看到语言、logo和管理后台名字都已经改过来了。但是你会发现两个问题，左侧菜单的tasks显示的依然是英文，我们需要将其设置成中文。另外，右侧有simpleui的广告链接，页面背后有js文件跟踪simpleui的使用，这些都需要关闭。我们接下来教你如何解决这两个问题。

自定义或第三方APP名和模型名修改成中文

修改tasks/app.py, 通过verbose_name可以将app名改为中文，这里将tasks 改成了任务管理。

 from django.apps import AppConfig
 
 class TasksConfig(AppConfig):
     name = 'tasks'
 
     verbose_name = '任务管理'

接着修改tasks/models.py, 以中文设置模型的verbose_name, 如下所示：

 from django.db import models
 
 class Status(models.TextChoices):
     UNSTARTED = 'u', "Not started yet"
     ONGOING = 'o', "Ongoing"
     FINISHED = 'f', "Finished"
 
 
 class Task(models.Model):
     name = models.CharField(verbose_name="Task name", max_length=65, unique=True)
     status = models.CharField(verbose_name="Task status", max_length=1, choices=Status.choices)
     
     class Meta:
         verbose_name = "任务"
         verbose_name_plural = "任务"
 
     def __str__(self):
         return self.name

现在刷新页面，你将看到tasks英文都变成中文了。

实际Django开发中，我们还会用到第三方应用app和第三方app提供的模型，我们也可以通过打补丁的方式更改第三方app或模型以及模型字段的verbose_name或者label，将其修改成中文，如下所示：

 from third_package.models import ModelA
 
 ModelA._meta.verbose_name = ''
 ModelA._meta.verbose_name_plural = ''
 ModelA._meta.get_field('first_name').verbose_name = '名字'

关闭右侧广告链接和使用分析

修改settings.py, 添加如下两行代码：

 # 隐藏右侧SimpleUI广告链接和使用分析
 SIMPLEUI_HOME_INFO = False 
 SIMPLEUI_ANALYSIS = False 

现在查看效果，是不是清爽多了?

实际上首页的快捷操作和最近动作也可以关闭，在自定义首页部分我们会讲到。

设置默认主题

SimpleUI默认主题(default)是深蓝色的，它支持的主题有Element-ui, Admin Lte和Layui等多种风格。你可以通过右上角下拉菜单改变主题，也可以在settings.py中设置默认主题，如下所示：

 # 设置默认主题，指向主题css文件名。Admin Lte风格
 SIMPLEUI_DEFAULT_THEME = 'admin.lte.css'
 
 # 设置默认主题，指向主题css文件名。Element-ui风格
 SIMPLEUI_DEFAULT_THEME = 'element.css'
 
 # 设置默认主题，指向主题css文件名。layui风格
 SIMPLEUI_DEFAULT_THEME = 'layui.css'
 
 # 设置默认主题，指向主题css文件名。紫色风格
 SIMPLEUI_DEFAULT_THEME = 'purple.css'

自定义菜单

左侧可折叠菜单是Simple UI系统默认菜单，根据已注册的应用和模型自动生成，其中父级菜单是App名，子菜单一般是所属App的各个模型名。SimpleUI甚至会自动为你分配默认图标，比如本例的tasks的应用使用了font-awsome的fa fa-tasks。在大多数情况下，Simple UI系统默认菜单不能满足需求，这时你就需要自定义菜单了，比如添加新的选项或给菜单选项分配新的图标。

修改settings.py, 添加如下代码：

 SIMPLEUI_CONFIG = {
      # 是否使用系统默认菜单，自定义菜单时建议关闭。
     'system_keep': False,
     
      # 用于菜单排序和过滤, 不填此字段为默认排序和全部显示。空列表[] 为全部不显示.
     'menu_display': ['任务管理', '权限认证'],
     
     # 设置是否开启动态菜单, 默认为False. 如果开启, 则会在每次用户登陆时刷新展示菜单内容。
     # 一般建议关闭。
     'dynamic': False,
     'menus': [
         {
             'app': 'auth',
             'name': '权限认证',
             'icon': 'fas fa-user-shield',
             'models': [
                 {
                 'name': '用户列表',
                 'icon': 'fa fa-user',
                 'url': 'auth/user/'
                 },
                 {
                     'name': '用户组',
                     'icon': 'fa fa-th-list',
                     'url': 'auth/group/'
                 }
             ]
         },
 
         {
             'name': '任务管理',
             'icon': 'fa fa-th-list',
             'models': [
                 {
                 'name': '任务列表',
                 # 注意url按'/admin/应用名小写/模型名小写/'命名。 
                 'url': '/admin/tasks/task/',
                 'icon': 'fa fa-tasks'
                 },
             ]
         },
     ]
 }

自定义菜单效果如下所示。我们更改了SimpleUI默认分配的图标。你还可以随意增减菜单选项并对其进行排序:

自定义首页

SimpleUI默认首页由快捷链接和最近动作组成，我们可以将其隐藏，并将其链接到其它url。

继续修改settings.py, 添加如下代码：

 # 隐藏首页的快捷操作和最近动作
 SIMPLEUI_HOME_QUICK = False 
 SIMPLEUI_HOME_ACTION = False
 
 # 修改左侧菜单首页设置
 SIMPLEUI_HOME_PAGE = 'https://www.baidu.com'  # 指向页面
 SIMPLEUI_HOME_TITLE = '百度欢迎你!' # 首页标题
 SIMPLEUI_HOME_ICON = 'fa fa-code' # 首页图标
 
 # 设置右上角Home图标跳转链接，会以另外一个窗口打开
 SIMPLEUI_INDEX = 'https://www.baidu.com'

展示效果将如下所示：

实际应用中后台首页通常是控制面板，需要用图表形式展示各种关键数据，这时就需要重写首页了。这里主要有两种实现方法。第一种是重写simpleui自带的home.html, 另一种自己编写一个控制面板的页面，然后设置首页指向它, 个人倾向于第二种, 因为它完全不涉及改动simpleui的源码。

我们现在开始使用Django编写一个用于显示控制面板的页面，用于在首页显示注册用户数量及任务数量。URL路由及对应的视图函数如下所示：

 # tasks/urls.py
 urlpatterns = [
     path('tasks/dashboard/', views.dashboard, name='dashboard'),
 ]
 
 # tasks/views.py
 from django.contrib.auth.models import User
 from django.shortcuts import render
 from .models import Task
 
 def dashboard(request):
     user_count = User.objects.count()
     task_count = Task.objects.count()
 
     context = { 'user_count': user_count, 'task_count': task_count }
     return render(request, 'tasks/dashboard.html',context)

我们的模板也很简单，使用了boostrap4的admin lte风格的卡片展示用户总数和任务总数。

 <!DOCTYPE html>
 <html>
 <head>
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <title>控制面板</title>
   <!-- Tell the browser to be responsive to screen width -->
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <!-- Theme style -->
     <link rel="stylesheet" href="https://adminlte.io/themes/AdminLTE/bower_components/bootstrap/dist/css/bootstrap.min.css">
   <link rel="stylesheet" href="https://adminlte.io/themes/AdminLTE/dist/css/AdminLTE.min.css">
 
 </head>
 <body>
 <div class="wrapper">
  <!-- Main content -->
     <section class="content">
       <div class="container-fluid">
         <!-- Small boxes (Stat box) -->
         <div class="row">
           <div class="col-sm-3">
             <!-- small box -->
             <div class="small-box bg-info">
               <div class="inner">
                 <h3>{{ user_count }}</h3>
 
                 <p>用户总数</p>
               </div>
               <div class="icon">
                 <i class="ion ion-bag"></i>
               </div>
               <a href="#" class="small-box-footer">更多信息 <i class="fas fa-arrow-circle-right"></i></a>
             </div>
           </div>
           <!-- ./col -->
           <div class="col-sm-3">
             <!-- small box -->
             <div class="small-box bg-success">
               <div class="inner">
                 <h3>{{ task_count }}</h3>
                 <p>任务总数</p>
               </div>
               <div class="icon">
                 <i class="ion ion-stats-bars"></i>
               </div>
               <a href="#" class="small-box-footer">更多信息 <i class="fas fa-arrow-circle-right"></i></a>
             </div>
           </div>
           <!-- ./col -->
              <div class="col-sm-3">
             <!-- small box -->
             <div class="small-box bg-info">
               <div class="inner">
                 <h3>{{ user_count }}</h3>
 
                 <p>用户总数</p>
               </div>
               <div class="icon">
                 <i class="ion ion-bag"></i>
               </div>
               <a href="#" class="small-box-footer">更多信息 <i class="fas fa-arrow-circle-right"></i></a>
             </div>
           </div>
           <!-- ./col -->
           <div class="col-sm-3">
             <!-- small box -->
             <div class="small-box bg-success">
               <div class="inner">
                 <h3>{{ task_count }}</h3>
 
                 <p>任务总数</p>
               </div>
               <div class="icon">
                 <i class="ion ion-stats-bars"></i>
               </div>
               <a href="#" class="small-box-footer">更多信息 <i class="fas fa-arrow-circle-right"></i></a>
             </div>
           </div>
           <!-- ./col -->
         </div>
       </div>
     </section>
   </div>
 </body>

现在修改我们的settings.py, 将首页指向这个新创建的控制面板。

 # 修改首页设置, 指向新创建的控制面板
 SIMPLEUI_HOME_PAGE = '/tasks/dashboard/'
 SIMPLEUI_HOME_TITLE = '控制面板!' 
 SIMPLEUI_HOME_ICON = 'fa fa-eye'

刷新浏览器，你就会发现我们的首页已经修改了，是不是很酷?

Django SimpleUI, 你学会了吗? 体验完了SimpleUI, 我会用三个词语来描述它, 国人口味, 果然很美, 确实简单! 老规矩, 看懂了听懂了的留言点赞啊!

大江狗

转自：https://mp.weixin.qq.com/s/_HKXaea1entAf9guNRsv4A

django-extensions给django开发者提供了许多便捷的扩展工具(extensions)，在github上高达5000颗星。小编我今天就介绍它包含哪些奥利给的有用扩展以及它们的使用场景。

django-extensions的安装

使用pip安装：

$ pip install django-extensions

然后把其加入settings.py的INSTALLED_APPS:

INSTALLED_APPS = [    ...    'django_extensions',]

django-extensions提供了哪几种扩展?

django-extensions主要提供了三种扩展：命令扩展，字段扩展和模型扩展。我们接下来分别介绍。

命令扩展

shell_plus

每次进行Django项目调试时，你首先需要打开python shell，再重新import每个model。如果安装了django-extensions, 使用python manage.py shell_plus命令将打开一个加强版的django shell，这个shell_plus为你自动载入项目中所有的model，可以让你很方便的开始调试。

show_urls

一句话可以展示当前项目所有定义的urls。

clear_cache

一句话清除缓存，在测试和开发环境很有用。

export_emails

一句话导出所有用户的email地址。

pipchecker

检查pip requirements.txt文件中是否有过期的packages，类似于pip list -o，只用于已安装过的packages。

其它有用的命令扩展还包括：

• admin_generator: 只要你提供app label，就会自动为你输出定义的Admin Class代码，默认输出在stdout
• clean_pyc: 移除项目中所有的pyc文件
• create_command: 为一个app生成自定义命令所需要的目录结构。
• create_template_tags: 为一个app生成template tag所需要的目录结构。
• compile_pyc: 为项目编译python字节码
• describe_form: 生产一个model的form代码，你可以将它拷贝到你的文件
• delete_squashed_migrations: 删除残留的squash migration文件
• dumpscript：生产一个python 脚本，用来重新填充数据库
• export_emails: 为你的用户生成email地址
• graph_model: 创建基于model的GraphViz2文件.
• mail_debug: 开启一个邮件服务器，它会打印邮件内容而不是把它发送出去
• merge_model_instances: 合并重复的model instance
• notes: 展示代码中所有的 TODO, FIXME, BUG, HACK, WARNING, NOTE, XXX 的地方
• passwd: 轻松修改用户密码
• print_settings: 展示所有的，或者指定的django settings
• print_user_for_session: 通过session来找到user，并且打印
• drop_test_database: 删除测试数据库
• reset_db: 使用DROP DATABASE和CREATE DATABASE来重置数据库
• runprofileserver: 开启一个激活了profile功能的开发服务器
• runscript: 在django上下文中运行一个脚本
• runserver_plus: 标准的runserver加上Werkzeug的debugger工具
• set_fake_emails: 根据用户的数据，为所有用户设置一个虚构的email
• show_template_tags: 展示当前项目可用的template tags和template filters
• sqldiff: 展示model和数据库是否结构不一样，如果有不一样的地方就展示出来
• sqlcreate: 根据你的settings.py定义，为你生成创建数据库的SQL代码
• sqldsn: 根据settings.py定义的数据库配置，返回一个可以用于其它程序的数据库URI
• sync_s3: 将MEDIA_ROOT的文件复制到S3
• update_permissions: 重载权限
• validate_templates: 确认template是否有语法错误

字段扩展

django-extensions提供的最有用的字段扩展莫过于AutoSlugField, RandomCharField和ShortUUIDField。

AutoSlugField

很多时候我们需要在url里根据模型某个或多个字段(比如标题，用户名)生成一个独一无二的slug，便于搜索引擎发现我们的内容。AutoSlugField可以很轻松帮我们完成这个任务，而且永不重复。比如两篇文章有同样的标题，它会在第2篇文章的slug结尾上加上一个数字。下次如果你用django开发自己的博客，试试这个字段吧，保证你满意。

使用这个字段时先从django-extensions导入，然后指定根据哪些字段生成slug即可。它的强大之处在于它还支持自定义的模型方法和双下划线__关联模型查询。

slug = AutoSlugField(populate_from=['title', 'get_description', 'author__username'])

RandomCharField

验证用户身份时我们经常需要生成一个随机字符串发给用户，有时还需生成随机的邀请码。RandomCharField可以轻松实现这个目的。你还可以指定字符串长度和格式。

>>> RandomCharField(length=8, unique=True)BVm9GEaE
>>> RandomCharField(length=4, include_alpha=False)7097
>>> RandomCharField(length=12, include_punctuation=True)k[ZS.TR,0LHO
>>> RandomCharField(length=12, lowercase=True, include_digits=False)pzolbemetmok

ShortUUIDField

一个由22个字符组成的字符串，比正常的uuid短了很多。尽管不保证唯一，但重复概率极低。

模型扩展

django-extensions提供的最有用的模型基类扩展莫过于ActivatorModel, TitleDescriptionModel, TimeStampedModel 和TitleSlugDescriptionModel。使用时把你的模型继承这几个基类即可。

ActivatorModel

作为基类提供了 status, activate_date,和 deactivate_date 这3个字段。status是一个choice选项，默认是activated。每次当你激活或失活一条记录时，日期会自动更新。它还提供了一个自定义Manager方法，允许使用Model.objects.active()查询所有处于活跃状态的对象。

TitleDescriptionModel

作为基类提供了title 和 description两个字段。title最长255个字符。

TimeStampedModel

作为基类提供了created 和 modified两个字段。这两个字段都是自我管理，自动更新的。

TitleSlugDescriptionModel

作为基类提供了title , description和 slug三个字段，其中slug根据title自动生成，独一无二。

所有以上扩展你最喜欢哪个呢? 欢迎留言。

大江狗原创

2020.12.15

转自：https://mp.weixin.qq.com/s/s8fEO9lDJ584aAVb6irLFQ

顾名思义，django-import-export是一个用于处理导入和导出数据的库。它支持多种格式，包括xls、csv、json、yaml以及tablib支持的所有其他格式。它还可以轻松与Django管理后台集成，使用起来非常方便。

安装插件

使用PIP安装

pip install django-import-export

更新settings.py:

INSTALLED_APPS = (
    ...
    'import_export',
)

还有一个可选的配置，我通常这样添加:

IMPORT_EXPORT_USE_TRANSACTIONS = True

默认值为False。它确定库是否会在数据导入中使用数据库事务，以确保安全。

编写资源Resources

django-import-export库使用Resource的概念，它的类定义非常类似于Django处理模型表单和管理类的方式。

在文档中，作者建议将与资源相关的代码放在admin.py文件。但是，如果实现与Django admin没有关系，我通常更喜欢在app文件夹里创建一个名为resources.py。

models.py

from django.db import models
class Person(models.Model):    name = models.CharField(max_length=30)    email = models.EmailField(blank=True)    birth_date = models.DateField()    location = models.CharField(max_length=100, blank=True)

resources.py

from import_export import resourcesfrom .models import Person
class PersonResource(resources.ModelResource):    class Meta:        model = Person

这是最简单的定义。您可以将几个配置传递给元类，如：fields, exclude

导出数据

导出数据到CSV

from .resources import PersonResource
person_resource = PersonResource()
dataset = person_resource.export()
dataset.csv

id,name,email,birth_date,location
1,John,john@doe.com,2016-08-11,Helsinki
2,Peter,peter@example.com,2016-08-11,Helsinki
3,Maria,maria@gmail.com,2016-08-11,Barcelona
4,Vitor,vitor@freitas.com,2016-08-11,Oulu
5,Erica,erica@gmail.com,2016-08-11,Oulu

导出数据到JSON

dataset.json

[
  {"id": 1, "name": "John", "email": "john@doe.com", "birth_date": "2016-08-11", "location": "Helsinki"},
  {"id": 2, "name": "Peter", "email": "peter@example.com", "birth_date": "2016-08-11", "location": "Helsinki"},
  {"id": 3, "name": "Maria", "email": "maria@gmail.com", "birth_date": "2016-08-11", "location": "Barcelona"},
  {"id": 4, "name": "Vitor", "email": "vitor@freitas.com", "birth_date": "2016-08-11", "location": "Oulu"},
  {"id": 5, "name": "Erica", "email": "erica@gmail.com", "birth_date": "2016-08-11", "location": "Oulu"}
]

导出数据到YAML

dataset.yaml

- {birth_date: '2016-08-11', email: john@doe.com, id: 1, location: Helsinki, name: John}
- {birth_date: '2016-08-11', email: peter@example.com, id: 2, location: Helsinki, name: Peter}
- {birth_date: '2016-08-11', email: maria@gmail.com, id: 3, location: Barcelona, name: Maria}
- {birth_date: '2016-08-11', email: vitor@freitas.com, id: 4, location: Oulu, name: Vitor}
- {birth_date: '2016-08-11', email: erica@gmail.com, id: 5, location: Oulu, name: Erica}

过滤数据

from .resources import PersonResource
from .models import Person
person_resource = PersonResource()
queryset = Person.objects.filter(location='Helsinki')
dataset = person_resource.export(queryset)
dataset.yaml

- {birth_date: '2016-08-11', email: john@doe.com, id: 1, location: Helsinki, name: John}
- {birth_date: '2016-08-11', email: peter@example.com, id: 2, location: Helsinki, name: Peter}

导出到CSV视图

from django.http import HttpResponsefrom .resources import PersonResource
def export(request):    person_resource = PersonResource()    dataset = person_resource.export()    response = HttpResponse(dataset.csv, content_type='text/csv')    response['Content-Disposition'] = 'attachment; filename="persons.csv"'    return response

导出到Excel视图

from django.http import HttpResponsefrom .resources import PersonResource
def export(request):    person_resource = PersonResource()    dataset = person_resource.export()    response = HttpResponse(dataset.xls, content_type='application/vnd.ms-excel')    response['Content-Disposition'] = 'attachment; filename="persons.xls"'    return response

导入数据

查看new_persons.csv的数据：

name,email,birth_date,location,id
Jessica,jessica@jones.com,2016-08-11,New York,
Mikko,mikko@suomi.com,2016-08-11,Jyväskyla,

id必须存在，因为它是主键。但是它会生成，所以我们不需要指定值。

import.html

{% extends 'base.html' %}
{% block content %}
  <form method="post" enctype="multipart/form-data">
    {% csrf_token %}
    <input type="file" name="myfile">
    <button type="submit">Upload</button>
  </form>
{% endblock %}

views.py

from tablib import Datasetdef simple_upload(request):    if request.method == 'POST':        person_resource = PersonResource()        dataset = Dataset()        new_persons = request.FILES['myfile']        imported_data = dataset.load(new_persons.read())        result = person_resource.import_data(dataset, dry_run=True)  # Test the data impor        if not result.has_errors():            person_resource.import_data(dataset, dry_run=False)  # Actually import now     return render(request, 'core/simple_upload.html')

Django后台管理集成

在admin.py里使用ImportExportModelAdmin，而不是ModelAdmin

from import_export.admin import ImportExportModelAdmin
from django.contrib import admin

from .models import Person

@admin.register(Person)
class PersonAdmin(ImportExportModelAdmin):
   pass

添加之后刷新页面你就会看到导入和导出按钮。

在导入现有项目时，导入功能具有良好的差异性：

这是一个强大的Django库，你可以用它做更多的事情。比如只想有导出功能，可以使用ExportMixin。

from .models import Personfrom django.contrib import adminfrom import_export.admin import ExportMixin
class PersonAdmin(ExportMixin, admin.ModelAdmin):    resource_class = PersonResource
admin.site.register(Person, BookAdmin)

详细文档地址：https://django-import-export.readthedocs.io/en/latest/

文章来源：Django中文网 作者：夜之舞。