# Technical Documentation: PKUanonym/REKCARC-TSC-UHT > ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/PKUanonym/REKCARC-TSC-UHT) ### Overview (README.md) # 清华大学计算机系课程攻略 [](https://github.com/PKUanonym/REKCARC-TSC-UHT/watchers) [](https://github.com/PKUanonym/REKCARC-TSC-UHT/stargazers) [](https://github.com/PKUanonym/REKCARC-TSC-UHT/network/members) [](https://github.com/PKUanonym/REKCARC-TSC-UHT/issues) [](https://rekcarc-tsc-uht.readthedocs.io/en/latest/?badge=latest) Web page: [REKCARC-TSC-UHT.readthedocs.io](https://REKCARC-TSC-UHT.readthedocs.io) 受[浙江大学相关项目](https://github.com/QSCTech/zju-icicles)启发，创立了本项目。 由于本仓库未启用 `git-lfs`，因此请不要上传单个超过 100M 的文件，否则 commit 无效。 若要下载单个文件夹，复制该文件夹的网址，粘贴入 [DownGit](https://minhaskamal.github.io/DownGit/#/home) 中，选择 download 即可。 如果您是清华大学学生，可移步 https://git.tsinghua.edu.cn/pkuanonym/REKCARC-TSC-UHT 进行查看并且能节约不少流量。 感谢对本项目贡献的同学：[Trinkle23897](https://github.com/trinkle23897)、[LJSthu](https://github.com/ljsthu)、[shyoshyo](https://github.com/shyoshyo)、[wuhaozhe](https://github.com/wuhaozhe)、[choumartin1234](https://github.com/choumartin1234)、[FztTony](https://github.com/FztTony/)、[VicaYang](https://github.com/VicaYang/)、[duzx16](https://github.com/duzx16/)、[zerotrac](https://github.com/zerotrac)、[gjz010](https://github.com/gjz010/)、[Recursion](https://github.com/RecursionSheep)、[linusboyle](https://github.com/linusboyle)、[namasikanam](https://github.com/namasikanam)、[JamesZhengYuyu](https://github.com/JamesZhengYuyu)、[zx1239856](https://github.com/zx1239856)、[yaoqs](https://github.com/yaoqs)、[heheda12345](https://github.com/heheda12345)、[MashPlant](https://github.com/MashPlant)、[lwpie](https://github.com/lwpie)、[cht33](https://github.com/cht33)、[chenweize1998](https://github.com/chenweize1998)、[will7101](https://github.com/will7101)、[UNIDY2002](https://github.com/UNIDY2002)、[yinhaoxuan](https://github.com/yinhaoxuan)、[zhengkw18](https://github.com/zhengkw18)、[rcy17](https://github.com/rcy17)、[prnake](https://github.com/prnake)、[qky18](https://github.com/qky18)、[JamesZFS](https://github.com/JamesZFS)、[Co1lin](https://github.com/Co1lin)、[3ToThe6](https://github.com/3ToThe6)、[c7w](https://github.com/c7w)、[zhaochenyang20](https://github.com/zhaochenyang20)、[Maple](https://github.com/Maple2004)、[yuxuan-z](https://github.com/yuxuan-z19) ……以及电脑前的您！ ## 前言 继承自 [Trinkle23897 的项目](https://github.com/Trinkle23897/thu-cst-cracker)，删去了其中侵权内容。若还有任何侵权内容请在 issues 下指出，非常感谢。 ## 目录 本项目收录的内容见 [收录内容](收录内容.md) 本项目大部分课程的参考书目见 [参考书目](参考书目.md) ## 贡献 **欢迎贡献！** Issue、PR、纠错、资料、选课/考试攻略，完全欢迎！来自大家的关注、维护和贡献，才是让这个攻略继续存在的动力~ 如果希望匿名贡献，可以 email 至此邮箱，注明 "REKCARC-TSC-UHT" 即可：PKUanonymous@qq.com 贡献方法见 [贡献方法](贡献方法.md) ## 许可 由贡献者编写部分的许可如下： [(Creative Commons BY-SA 4.0) 知识共享署名 - 相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh) 其他部分的版权归属于其各自的作者。资料仅供参考，请自己判断其适用性。 ## 附录 ### 清华大学学生纪律处分管理规定实施细则 #### 第六章　学术不端、违反学习纪律的行为与处分 第二十一条 有下列违反课程学习纪律情形之一的，给予警告以上、留校察看以下处分： （一）课程作业抄袭严重的； （二）实验报告抄袭严重或者篡改实验数据的； （三）期中、期末课程论文抄袭严重的； （四）在课程学习过程中严重弄虚作假的其他情形。 --- ### 大一小学期 Week 3 Python Docs Readme (`大一小学期/Week_3-Python/docs/readme.md`) # 使用方法 ## 文档目标 关于大一小学期一些形而上学的课程体验，请参考计算机系的[课程攻略文档](https://docs.qq.com/doc/DZGp6VW5kUVZUWWtD)。与之不同，本文档的目标非常具体。 此文档参考了自 2019 年到 2021 年三年 Python 小学期的要求，综合了暑培课程讲义、往年优秀作业与本人所参与的多个应用爬虫与数据分析的 SRT 工作汇编而成，**希望能够为一字班选修了 Python 小学期的同学提供有力的自学预习材料，也之后需要使用相关 Python 工具的同学提供支持。** **与暑培内容重叠的部分，汇编者进行了修订，例如为网页爬虫提供了包括 Facebook，Twitter，Youtube 等高强度反爬网页的实例。如果你参与了暑培的部分内容，仍然建议你阅读经过汇编者补充的例子。** **暑培课程之外，汇编者扩充更多相应的文档，主要是 BeatifulSoup4，Pandas，Matplotlib，做到了对于小学期内容的全覆盖与降维打击。** ## 内容概述 ```shell . ├── CodeReview.md ├── DS_tutorial.pdf ├── Python │   ├── Numpy.ipynb │   └── Python\ Advanced\ Topics.ipynb ├── backend │   ├── Django.md │   ├── Django_preparation.pdf │   └── SQL.pdf ├── crawler │   └── crawler.ipynb ├── readme.md ├── soup │   ├── BeatifulSoup4.ipynb │   ├── Pandas.ipynb │   ├── Pandas_refined.ipynb │   └── README.md └── visualize ├── Matplotlib.ipynb └── README.md 5 directories, 15 files ``` 1. Python 路径下：[Python 基础语法](https://docs.net9.org/languages/python/)与 Python 进阶（IPython）、Numpy 2. Crawler 路径下：crawler 3. soup 路径下：BeautifulSoup4 与 Pandas 4. backend 路径下：Django 5. visualize 路径下：Matplotlib ### Python 语法基础 Python入门与基础语法，见 [Python 基础语法](https://docs.net9.org/languages/python/)。 ### Python 进阶 Python Advanced Topics 文档主要分享一些 Python 的进阶内容，介绍一些实用技能栈。该文档涵盖 IPython 这一实用的 Python的交互式接口，以及 tqdm, argparse, pathlib 等实用 Python 库。 ### Numpy Numpy(Numerical Python 的简称) 几乎是整个 Python 科学计算生态系统的核心，它提供了高效存储和操作密集数据缓存的接口。这部分文档介绍了 Numpy 的用法，尤其强调了以下重点内容： + Numpy 和 Python 的效率区别 + Numpy 广播机制的规则 + Numpy Fancy Index + 传统索引的视图问题 ### crawler Crawler 文档主要讲述 Python 爬虫的基本用法以及实操建议，主要内容包括： + 最基本的 HTTP 知识以及如何利用浏览器 inspect 功能； + 解爬取网页的两大方式：利用 requests 发送请求，以及利用 selenium 模拟浏览器访问网页； + 实际操作过程中的注意事项； + 以不同类型的网页为例讲解什么情况下具体应当使用哪种方式。 ### BeautifulSoup4 BeautifulSoup4 可以帮助我们来处理请求获得的 HTML 页面中的数据，进行过滤、筛选、查找，是 Python 爬虫的重要工具。这部分文档以大量实例介绍了 BeautifulSoup4 的 API 和基本用法。 ### Pandas Pandas 是在 NumPy 基础上建立的新程序库，提供了一种高效的 DataFrame 数据结构。DataFrame 本质上是一种带行标签和列标签、支持相同类型数据和缺失值的多维数组。Pandas 文档重点介绍该包中 Series、DataFrame 和其他相关数据结构的高效使用方法。 ### Django Django 是一个由 Python 编写的一个开放源代码的 Web 应用框架。 使用 Django，只要很少的代码，Python 程序开发人员就可以轻松地完成一个正式网站所需要的大部分内容，并进一步开发出全功能的 Web 服务。 Django 部分教程旨在帮助大家： + 了解如何使用 Django 开发一个简单应用程序； + 了解前后端分离的开发模式，学习如何使用 Django 搭建一个后端； + 掌握一种在服务器上部署 Django 的方式 （Django + Nginx + uWSGI 部署）。 ### Matplotlib Matplotlib 是建立在 NumPy 数组基础上的多平台数据可视化程序库，这部分讲义将详细介绍使用 Python 的 Matplotlib 工具实现数据可视化的方法，涵盖线形图、散点图、直方图等，包含了大量实例。 ## 额外注意 Pandas 与 Numpy 小学期并不必用，但是熟练的使用这两个工具会使得你的工作更加优雅。 ## 下载 若要下载单个文件夹，复制该文件夹的网址，粘贴入 [DownGit](https://minhaskamal.github.io/DownGit/#/home) 中，选择 download 即可。 ## 使用方法 文档全部由 markdown 与 Jupyter Notebook 写成。 ### Local Jupyter 你可以将仓库 clone 到本地使用，顺带练习你的 Git 技能，毕竟 QT 开发不使用 Git 会极度痛苦。同时，关于 Jupyter Notebook 和 Python 基础环境的配置请参考[此链接](https://zhaochen20.notion.site/Python-2f9538e9f6024827b55abbeb48025b30)。 ### Google Colab 你也可以使用 Google Colab 服务。 * 首先打开 Google Colab 为 Github 适配的界面。点击此[链接](https://colab.research.google.com/github/)，在对应位置输入该仓库链接： ```tex https://github.com/zhaochenyang20/Sino-Japanese-Relations-analysis ``` 然后 Enter，Colab 便会自动爬取该仓库的全部 ipynb 文件，并以列表形式显示在下面。点击对应文件右侧图标，便可以在新标签页打开该笔记本。 **注意事项** 1. 由于 Colab 自带的包的版本都很低，可能会出现部分 API 不兼容的情况。所以在使用下列笔记本时，建议在运行前先进行包的安装和更新，创建一个新的代码框，在对应的笔记本下运行如下指令即可。 **Numpy.ipynb** ```bash ! pip install --upgrade numpy ``` **BeatifulSoup4.ipynb** ```bash ! pip install --upgrade beautifulsoup4 ``` **Pandas.ipynb** ```bash ! pip install --upgrade pandas ! pip install --upgrade pandas-datareader ``` **Matplotlib.ipynb** ```bash ! pip install --upgrade matplotlib ! pip install --upgrade basemap ! pip install basemap-data-hires ``` 在安装和更新完毕后，Colab 会输出如下 log： ``` WARNING: The following packages were previously imported in this runtime: [···] You must restart the runtime in order to use newly installed versions. ``` 此时需要点击 log 下方的 `RESTART RUNTIME` 按钮即可将更新应用，接下来你便可以正常使用笔记本了。 2. 如果你发现有部分系统命令（即在 Jupyter Notebook 中以 ! 开头）无法运行，请尝试点击界面中的“复制到云端硬盘”，在 Google Drive 中的副本中运行。 ## 学习顺序 建议小学期选择了 Python 的同学，按照[基础语法](https://docs.net9.org/languages/python/)，IPython，Crawler，BeautifulSoup4，Matplotlib，DJango 的顺序进行学习。而其余两块内容 Numpy，Pandas 在小学期使用并不多，可以留作个人兴趣衍生。 ## 补充说明 由于时间仓促，错误在所难免，如若文档出现问题，请及时在本仓库的 [Issue](https://github.com/zhaochenyang20/Sino-Japanese-Relations-analysis/issues) 界面提出。 # 为何而写 ## 初起 暑假初期，我在处理暑培课程安排时，王导突然来找我，询问科协是否有课程指引方向的资料，类似 [docs9](https://docs.net9.org/) 的风格。 > 一字班同学在问有没有零字班好哥哥好姐姐帮忙介绍介绍大一小学期，包括新雅那边他们也准备搞… 作为技能文档的参与者，我不得不说，技能文档的初衷本身即是希望大家收获课程之外的一些能力，能够在课程当中使用到，而并不是刻意针对课程的。比如暑假之后我们会更新 Numpy，Pandas，IPython 的内容，这些内容绝非课程必须，只是在课程作业中使用会让你的作业更加优雅有效。更何况，科协的一大初衷也是希望能够带大家认知到除了课业之外还有广阔的计算机科学与技术的天地，而绝非课程的一亩三分地。 因此，暑假结束前科协恕难提供这方面的支持，毕竟即便是暑培现有资料的整合，也需要有非常多后续的整理修改工作。为了打造臻于完美，服务后人的技能文档，网络部相关的同学们用心可谓良苦。 我只能回复王导，关于小学期的课程指南，可以参考计算机系的[课程攻略文档](https://docs.qq.com/doc/DZGp6VW5kUVZUWWtD)。然而，类似 docs9 这类的文档，困难太大，恕难从命。 如此想来，这件事情的确与我无关。**作为技能文档组的编写者与计算机系课咨委的一员，我尽到了我的责任。而且我已经度过了许多让我体验不佳的课程，按说这辈子我不可能再受这些课程的苦，下辈子我也不会再学计算机这专业。一切都与我无关，不妨如同大多数麻木的人一样，事不关己，高高挂起。** ## 转折 然而，之后几天，我的良知却不免惴惴难安。 这真的是我渴望的生活吗？ 参加课咨委的工作一整年了，我逐渐感知到，我之所以对于推动系内的课程改革有如此热忱，何尝不是不抱有薪火相传的初衷？ 在我入学之前，就有杰哥等贵系的先辈们，积极地推动体系结构课程的改革，才能够让如今系内体系结构课程的体验有了大幅提升。之后，九字班学长学姐对小学期课程的提议和反馈得到了老师们的认可，才让零字班小学期压力控制在了合理的高压范围内，而非九字班所经历的魔鬼夏天。如果没有这些先辈学长学姐对于课改的探索，如果没有他们点亮了课改的火炬，我们现在又会经历怎样难堪的课程体验？ 更何况，如果没有改革和参与改革的意识，每个人都安于现状，要么觉得事不关己高高挂起，要么觉得经历过的折磨一辈子不会有第二次，就选择对于任何意义的改革作壁上观，那么现在我们所生活的国家至今还是**大清**，绝非现在的中国。诚然我也激烈地批判着当下中国社会的种种弊病，然而我没谁也不愿意回到生产力落后，文化闭塞的清朝。社会改革促进了生产力的伟大进步，即便前人为了改革做出的牺牲已经让大多阅读到此处的人过上了衣食无忧的生活，然而我仍然坚信改革的火炬将会薪火相传。 于是乎，我再次想到了王导的问题。难道科协除了内容广泛的暑培外，暂时无法提供细致专业服务于小学期的指导，就不得不让同学们经历以往的前辈们在大一暑假曾经经历过的那些折磨吗？ 绝不，至少我们还可以抱团自救。 > **星星之火，可以燎原。** 虽然目前计算机系的部分课程质量仍然堪忧，**但是我们每提出一次课改意见，每贡献一次开源资料，都会为计算机系课程质量提升留下不可磨灭的贡献**。我们会帮助到之后的学弟学妹，更高年级学长学姐也会如此帮助我们。 ## 尾声 于是乎，就有了你看到的此份文档。这份文档是我个人邀请三位一字班计算机系或者软院的同学们一同参考暑培讲义所编写的。基本涵盖了小学期 Python 课程的所有需求。在暑培课程之外，我们扩充了相应的文档和资料。从[语法基础](https://docs.net9.org/languages/python/)，到 IPython，Numpy，Pandas，BeautifulSoup4，Matplotlib，Django 等全部资料。 # 致谢 ## 汇编者 - [lurf21](https://github.com/lurf21) - [QuentinHsuow](https://github.com/QuentinHsuow) - [luohaowen2003](https://github.com/luohaowen2003) ## 暑培讲师 - [Eren Zhao](https://zhaochenyang20.github.io/about/) - [c7w](https://github.com/c7w) - [lambda](https://github.com/Btlmd) - [ayf](https://github.com/ayf19) ## 打工仔 - [learning Rate](https://github.com/lr-tsinghua11) --- ### 大一小学期 Week 3 Python Docs Soup README (`大一小学期/Week_3-Python/docs/soup/README.md`) # FAQ Q：我在运行部分代码时出现了一些异常，怎么办？ A：Pandas 库的更新很快，所以该文档具有一定的时效性。**一切请以 Pandas 官方文档为准**，或者使用搜索引擎搜索错误输出。 Q：使用 `curl` 指令下载示例所需的数据时，出现问题怎么办？ A：由于网络原因，可以考虑直接访问对应网站下载。如果数据确实已经下载，可以在 jupyter notebook 中使用 `pwd` 命令查看一下当前目录是否正确。 --- ### 大一小学期 Week 3 Python Docs Visualize README (`大一小学期/Week_3-Python/docs/visualize/README.md`) ## 针对运行这份笔记中的代码时可能出现的一些问题，我们给出以下参考解决方案 1. 需要使用 curl 指令下载 csv 格式数据文件来运行示例时，如果 curl 出现问题，可以直接向 pd.read_csv() 传入下载链接，直接从网络上加载数据； 2. 在 Basemap 部分，如果遇到绘制的地图不符合预期的情况，可以尝试运行以下代码： ``` conda install -c conda-forge basemap-data-hires ``` 3.对于例子“Surface Temperature Data”，需要下载的数据文件较大，如果用curl指令下载过程中出现问题，可以尝试直接用浏览器访问[美国宇航局戈达德太空研究所](http://data.giss.nasa.gov/)(NASA’s Goddard Institute for Space Studies)的网站，并下载所需数据文件至工作文件夹。 4. 对于其它可能出现的异常情况，可以使用 Ipython 查阅 documents，自行调整 API 尝试解决。 --- ### 大一小学期 Week 3 Python Docs CodeReview (`大一小学期/Week_3-Python/docs/CodeReview.md`) # 审核者须知 参考技能文档的[编写者须知](https://docs.net9.org/notes/editor/)，除此之外： 1. 将翻译稿中出现的类似于“书中第 xx 章”的字样删去。 2. 所以示例代码必须自己完全运行，避免因为 API 过于老旧无法使用。 ------ # 重要事项 **正确使用标点符号** + 正确使用**全角**标点符号与**半角**标点符号。汉语请使用全角符号，英语请使用半角符号。 + 请在每句话的末尾添加**句号**。 + 正确使用**括号**。括号在句中表示对句中前一个元素的解释说明，如 `语法糖（英语：Syntactic sugar）`。括号在句外表示对前面整个句子的解释说明。 + 正确使用**分号**，可以使得行文结构更加清晰。 **正确进行中文排版** + **中英文之间、中文和数字之间需要增加空格，数字和单位之间不需要增加空格。** + 行文中正文与超链接之间需要增加空格。 + 全角字符和其他字符之间不加空格。 + **专有名词使用正确的大小写。如使用缩写，则该缩写应已成为业界标准。** **推荐的代码风格** + 变量使用驼峰命名法、下划线命名法等均可，但需要尽量保证同一篇文档内命名风格统一。 + 下列代码风格惯例以 C++ 语言为例： + 大括号换行与不换行均可，但需要保证同一篇文档内格式统一。不换行时，其与左侧的右括号之间应当有一个空格。 + 关键字 `if`、`for` 等与后续左括号之间应当有一个空格。 + 运算符 `+`、`-` 等与左右操作数之间应当各有一个空格，运算符 `.`、`->` 两侧均不应当有空格，逗号 `,` 左侧不应当有空格而右侧应当有空格。 + 行内注释起始标记 `//` 与注释文字间应当有一个空格。 + 使用 2 个空格或者 4 个空格进行缩进均可，但需要保证同一篇文档内统一。 --- ### 大一小学期 Week 3 Python Docs Backend Django (`大一小学期/Week_3-Python/docs/backend/Django.md`) # Django 与后端 Django 是一个由 Python 编写的一个开放源代码的 Web 应用框架。 使用 Django，只要很少的代码，Python 的程序开发人员就可以轻松地完成一个正式网站所需要的大部分内容，并进一步开发出全功能的 Web 服务。 Django 本身基于 MVC 模型，即 Model（模型）+ View（视图）+ Controller（控制器）设计模式，MVC 模式使后续对程序的修改和扩展简化，并且使程序某一部分的重复利用成为可能。 本教程旨在帮助大家入门 Django，并掌握一些后端开发的基本知识，具体来说，希望帮助大家达成以下目标： + 了解如何使用 Django 开发一个简单应用程序； + 了解前后端分离的开发模式，学习如何使用 Django 搭建一个后端； + 掌握一种在服务器上部署 Django 的方式 （Django + Nginx + uWSGI 部署）。 ## 前置准备 请参考 lambda 学长暑培授课中的[课前准备文档](./Django_preparation.pdf)。 通过此命令可以检查你是否已经安装 Django 及 Django 版本。 ```bash python -m django --version ``` ## 创建一个简单的投票应用 > 需要注意的是Django的[文档](https://docs.djangoproject.com/zh-hans/4.0/)本身编写得相当清晰完备，以下内容大部分摘自该文档，因此若有不清晰之处，敬请查阅[文档](https://docs.djangoproject.com/zh-hans/4.0/)。 ### 新建项目 如果这是你第一次使用 Django 的话，你需要一些初始化设置。也就是说，你需要用一些自动生成的代码配置一个 Django project —— 即一个 Django 项目实例需要的设置项集合，包括数据库配置、Django 配置和应用程序配置。 打开命令行，cd 到一个你想放置你代码的目录，然后运行以下命令： ``` django-admin startproject mysite ``` 这行代码将会在当前目录下创建一个 `mysite` 目录。在其中，你会看到以下文件树： ``` mysite/ manage.py mysite/ __init__.py settings.py urls.py asgi.py wsgi.py ``` 这些目录和文件的用处是： + 最外层的 `mysite/` 根目录只是你项目的容器， 根目录名称对 Django 没有影响，你可以将它重命名为任何你喜欢的名称。 + `manage.py`: 一个让你用各种方式管理 Django 项目的命令行工具。许多如运行临时服务器、生成 migration， 迁移数据库结构等操作都可以通过 `manage.py` 进行。我们也可以在 `manage.py` 中运行自定义命令。 + 里面一层的 `mysite/` 目录包含你的项目，它是一个纯 Python 包。它的名字就是当你引用它内部任何东西时需要用到的 Python 包名。 (比如 `mysite.urls`). + `mysite/__init__.py`：一个空文件，告诉 Python 这个目录应该被认为是一个 Python 包。 + `mysite/settings.py`：Django 项目的配置文件。 + `mysite/urls.py`：Django 项目的 URL 声明，就像你网站的“目录”。 + `mysite/asgi.py`：作为你的项目的运行在 ASGI 兼容的 Web 服务器上的入口。 + `mysite/wsgi.py`：作为你的项目的运行在 WSGI 兼容的 Web 服务器上的入口。 ### 简易服务器 在 mysite 目录下，运行以下代码： ```bash python manage.py runserver ``` 即可启动一个临时服务器（只能用于开发测试，而不应当用于生产环境）。通过浏览器访问 http://127.0.0.1:8000/ （Djaongo 默认监听 127.0.0.1:8000）你将看到一个“祝贺”页面，证明你已经成功创建了项目。这个简易服务器之后可用于开发中的测试。 ### 新建应用 应用和项目是多对多的关系。一个应用通常用于完成一个相对独立的功能，可以安装于不同的项目中; 而一个项目也可以包含多个应用。 下面我们来演示创建应用： ```bash python manage.py startapp ``` 例如，在manage.py所在目录下运行以下代码： ```bash python manage.py startapp polls ``` 将创建一个名为 polls 的应用。 在 Django 中，每一个应用都是一个 Python 包，并且遵循着相同的约定。Django 自带一个工具，可以帮你生成应用的基础目录结构。例如，你可以观察一下刚刚创建的投票应用的文件目录。 ### 创建视图 视图可以根据不同的请求给出 HTTP 响应，我们来为 polls 创建个简单的视图。例如我们在 `polls/views.py` 中输入： ```python from django.http import HttpResponse def index(request): return HttpResponse("Hello, world. You're at the polls index.") ``` 这时，调用 index 将返回一个 HTTP 响应，内容为 Hello, world. You're at the polls index. 。 ### 创建路由 路由配置告诉 Django 哪些的 URL 应该被分配给哪些视图。我们来为我们刚才编写的 index 试图配置路由。 首先配置应用一级的路由，在 polls 目录下新建 `urls.py` ，输入以下内容： ```python from django.urls import path from . import views urlpatterns = [ path('hello', views.index, name='index'), ] ``` 然后配置项目一级的路由: ```python from django.urls import include, path urlpatterns = [ path('polls/', include('polls.urls')) ] ``` 这里需要注意 include 函数可以引用其他位置的 URL 配置，并将截断匹配的部分，将剩余部分分发给后续的 URL 配置进行匹配。 这时我们运行临时服务器测试访问这个页面： ```bash python manage.py runserver ``` 访问 ``` http://localhost:8000/polls/hello ``` 预期观察到的响应为 Hello, world. You're at the polls index. 我们回过头来看看我们的请求是如何被分配到 index 的。 当我们访问 http://localhost:8000/polls/hello ，Django 哪来进行匹配的部分是 `polls/hello` 首先在项目一级匹配，匹配到了 `polls/` ，于是 `polls/` 被去除，剩下 hello 子串到应用 polls 的 `urls.py` 中进行匹配。hello 子串又匹配到了视图 index 。此时 HTTP 请求作为第一个参数传给了 index 函数进行处理。index 函数处理这个请求后，应当返回一个 HttpResponse 对象，Django 会将这个对象对应的 HTTP 响应传递给客户端。 ### 使用数据库 接下来我们来演示如何使用 Django 的 ORM 模型来操作数据库。Django 支持多种数据库。默认情况下，Django使用 SQLite3 作为数据库。这种情形无需配置。我们也可以使用 MySQL 作为数据库。在此处我们以 MySQL 为例。如果你对 MySQL 不熟悉，可以参看[暑培文档](./SQL.pdf)中的 MySQL 部分。 #### settings.py 在使用数据库前，我们需要先了解 `settings.py` 中进行一些常用设置： > DEBUG 决定项目是在调试状态还是在生产环境。 **永远不要在 DEBUG 开启的情况下将网站部署到生产中**。DEBUG 开启时，产生错误会返回详细的错误报告，其中包含许多敏感信息，不宜在生产环境中泄露。DEBUG 关闭时，产生的错误仅有简略说明。 ALLOWED_HOSTS > 允许访问的域名列表，其他域名访问将直接被 ban，响应为 HTTP 400. INSTALLED_APPS > 表示该项目使用了哪些应用。Django会为在其中列出的应用进行注册。会进行启动配置、跟踪 migration 等数据库信息。 DATABASES > 表示使用何种数据库，以及使用数据库时的配置，如主机、端口、用户名密码等等。 #### 配置 MySQL 数据库 下面按照 Django 文档中的示例，演示为项目配置 MySQL 数据库。 首先安装 mysqlclient： ```bash pip install mysqlclient ``` 然后在恰当位置创建 MySQL 数据库的配置文件 `my.cnf `，输入你的数据库配置: ``` [client] host = 服务器地址 database = 所选数据库 user = 用户名 password = 密码 port = 端口 default-character-set = 字符集，这里推荐 utf8mb4 ``` 然后，在 `settings.py` 进行如下修改: ```python DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'OPTIONS': { 'read_default_file': '', }, } } ``` 如果填入的地址为相对路径，那么将会是相对运行 `manage.py` 时的工作目录。 #### 建立模型 模型对应于数据库中的表，可以用来设计和访问数据库的结构。我们为 polls 应用建立模型。编辑 `models.py` 输入以下内容： ```python from django.db import models class Question(models.Model): question_text = models.CharField(max_length=200) pub_date = models.FloatField('date published') class Choice(models.Model): question = models.ForeignKey(Question, on_delete=models.CASCADE) choice_text = models.CharField(max_length=200) votes = models.IntegerField(default=0) ``` 上面的代码建立了两个模型，对应于数据库中的两张表。模型是 models.Model 的子类，模型的字段是 models.Field 的实例。模型的每个字段对应于数据库中的一个字段。 在建立模型后我们需要让 Django 在数据库中建立这些模型，或对模型的修改做出对应数据库结构的调整。因此我们需要首先注册这一应用。在 `settings.py` 中，将我们的应用添加到 INSTALLED_APPS 中。 ```python INSTALLED_APPS = [ 'polls.apps.PollsConfig', 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', ] ``` 这时应用 polls 就被添加到了我们的 Django 项目中了。 我们运行: ```bash python manage.py makemigrations polls Migrations for 'polls': polls\migrations\0001_initial.py - Create model Question - Create model Choice ``` 此时 Django 会检测我们对应用 polls 的模型做了哪些修改，在将这些修改操作汇总到一个 Python 文 件中。 我们可以看到在 `polls/migrations` 目录中出现了一个 `0001_initial.py` 文件。我们通常无需阅读 migrations 中的文件。 接下来我们需要将修改操作应用到数据库： ```bash python manage.py migrate ``` 此时你对模型的修改将会被执行到数据库中。注意到修改包含了大量其他模型的操作，这是因为我们在 INSTALLED_APPS 中配置了许多应用，而这些应用的模型尚未建立。 对于应用更改时具体执行的 SQL 语句，我们可以使用: ```bash python manage.py sqlmigrate polls 0001 ``` 来查看 migration 0001 对应的 SQL 语句。 从这些语句中我们发现 Django 默认为我们建立主键，并添加了外键约束。 **总结起来，修改模型并应用修改分为 3 步: ** + 编辑 `models.py` 文件，改变模型。 + 运行 `python manage.py makemigrations` 为模型的改变生成迁移文件。 + 运行 `python manage.py migrate` 来应用数据库迁移。 #### 一些常见的模型定义： 以下面这段代码为例展示一些模型构建的常用内容： ```python # 创建枚举选项： class Role(models.TextChoices): MEMBER = "member" DEV = "dev" QA = "qa" SYS = "sys" SUPERMASTER = "supermaster" class PendingModifyPasswordEmail(models.Model): # 指定主键 id = models.BigAutoField(primary_key=True) # 唯一 hash1 = models.CharField(max_length=100, unique=True) # 枚举类型 role = models.CharField(max_length=12, choices=Role.choices) # 默认函数 createdAt = models.FloatField(default=getTime.get_timestamp) class Meta: # 索引 indexes = [ models.Index(fields=["hash1", "role"]), models.Index(fields=["createdAt"]), ] # 联合唯一 unique_together = ["hash1", "createdAt"] ``` #### 模型 API 我们可以利用模型 API 完成对数据的操作。下面我们在 Django Shell 中演示一些常见模型 API 的使用方法。当然，我们通常会在视图函数中使用这些 API，使用交互式方式只是为了便于演示。 首先启动 Django Shell： ```bash python manage.py shell ``` 在 Django Shell 中: ``` /* Detailed source-code truncated for AI context efficiency. */ ``` 在这里我们发现对象的显示不太方便，我们可以配置相应模型的 `__str__` 方法来自定义模型的显示内容： 为 Question 和 Choice 分别定义以下方法即可： ```python def __str__(self): return f"{self.question_text} @ {self.pub_date}" ``` ```python def __str__(self): return f"{self.choice_text} [{self.votes}]" ``` 然后重启 Django Shell，再次尝试查询: ```django >>> from polls.models import * # 自定义显示: >>> Choice.objects.all() , , ]> >>> Question.objects.all() , , ]> ``` 接下来我们看看如何修改对象。和创建类似地，有两种方法: ```django # save object: 修改特定对象 >>> ch = Choice.objects.get(pk=2) >>> ch.votes = 114514 >>> ch.save() # update: 修改整个 Query Set >>> Choice.objects.filter(id=3).update(votes=255) 1 # 查看修改效果 >>> Choice.objects.all() , , ]> ``` 然后是一些基本的查询方法（注意使用双下划线进行级联的写法）: ``` /* Detailed source-code truncated for AI context efficiency. */ ``` 我们可以使用 `.query` 来查看 QuerySet 对应的 SQL 语句: ```django >>> print( ... Choice.objects.filter( ... Q(question__id=2) & (~Q(choice_text__in=["A", "B"]) | Q(id=1)) ... ).query ... ) SELECT `polls_choice`.`id`, `polls_choice`.`question_id`, `polls_choice`.`choice_text`, `polls_choice`.`votes` FROM `polls_choice` WHERE(`polls_choice`.`question_id` = 2 AND (NOT (`polls_choice`.`choice_text` IN (A, B)) OR `polls_choice`.`id` = 1)) ``` 在查询复杂(或者开发者对 ORM 接口不熟悉)的情况下也可以直接裸写 SQL。由于不同 SQL 实现的版 本的差异，这样的代码并不想 ORM 那样具有较为良好的迁移性。 ```django >>> Choice.objects.raw("SELECT * FROM ...") ``` 当然，并不是说如果使用 ORM 就一定能保证代码在不同数据库之间无损转换。例如 Postgre SQL 的 DISTINCT ON 接口就会导致一部分代码迁移到 MySQL 后不能使用。而如果要把一部分数据从一种数据 库迁移到另一种数据库，这通常也十分令人头大。 > 这里介绍了创建应用程序的基本方法，如果想要体验创建一个完整应用程序的过程，请参看[文档](https://docs.djangoproject.com/zh-hans/4.0/intro/tutorial01/) ## 前后端分离的开发模式 对于 Web 应用来说，可以将其简单视为 2 部分： + 前端：用户可以看到并与之交互的部分。 + 后端：用户看不到，但承担着一些如数据存储、计算等等功能的部分。 对于前后端的互动，也可以简单分成两种模式： + 服务端渲染：服务端将用户看到的界面计算好，然后整体以 HTML 的形式返回。 + 用户端渲染：服务端先将不含数据，但包含交互逻辑的前端传给客户端。客户端需要时向服务端请求数据，利用请求的数据来完成页面的渲染。 对于当前日趋复杂的 Web 应用来说，前后端分离的是一种日趋流行的趋势 + 前后端分离应用的页面在交互的过程中，只传递了数据，而不是渲染好的整个视图，更加高效、灵活。 + 后端人员与前端人员的工作解耦，两者只需要通过约定的 API 进行协作，不需要代码的直接交互，不会出现后端开发里面嵌入了前端代码这种难以维护情形。 可能还需要说明的是，在学会前后端分离后，并不一定所有的任务都一定要上前后端分离，有些非常简单的任务用耦合的架构大概就能做的非常好了。 ### Templates & Forms Django 对前后端耦合的开发模式有深入的支持，但模板和表单在前后端分离的开发中使用较少，不是本节的重点，在这里附上文档链接，供有兴趣的同学查阅。 + 模板：https://docs.djangoproject.com/zh-hans/4.0/intro/tutorial03/ + 表单：Generic View:https://docs.djangoproject.com/zh-hans/4.0/intro/tutorial04/ 以下介绍使用 Djaongo 搭建纯后端的基本操作。 ### 使用 Django 收发请求 作为一个后端来说，最为常规的操作可能读取请求参数和收发各种 JSON。 #### GET 仍以上述投票程序为例，假设我们希望实现这样一个接口，请求 `/polls/questions/` 返回 id=2 的问题文本、创建时间和所有选项，此时我们可以写如下一个视图函数: ```python from django.http import HttpRequest, JsonResponse from .models import * from django.forms.models import model_to_dict def question_detail(req: HttpRequest, qid: int): res = Question.objects.filter(id=qid).first() if res: return JsonResponse({ "code": 0, "data": { **model_to_dict(res), "choices": [ model_to_dict(ch, exclude=["question"]) for ch in res.choice_set.all() ] } }) else: return JsonResponse({ "code": -1 }, status=404) ``` 其接受一个 HttpRequest 对象和被查询问题的 id ，使用 model_to_dict 将问题对象转换为 dict ， 再将问题对应所有的 Choice 转化也都转化为 dict 。最后将这个 dict 与 list 的复合物封装成 JSON 返回。 然后我们在 `polls/urls.py` 中为其配置路由。 ```python from django.urls import path from . import views urlpatterns = [ path('question/', views.question_detail), ] ``` 这里我们遇到一种新的路由格式。其在匹配到这一项后相当于调用了: ```django views.question_detail(request=, qid=) ``` qid 被作为关键字参数传给了 views.question_detail。 更多 URL Pattern 写法详见官方文档。 这时我们可以使用 Postman 对该接口进行验证和调试。 此外，对于 GET 请求中附带的参数，可以使用 req.GET 获取，例如添加上 `print(req.GET)` 即可获取 GET 请求的参数。 #### POST 我们考虑另一种情形，就是给指定问题的指定选项投票，类似于以下场景： ```json // 请求 { "qid": 2, "cid": 0 } // 响应 { "code": 0, "choices": [...] } ``` 这时我们可以撰写类似这样的一个视图函数: ```python def vote(req: HttpRequest): info = json.loads(req.body) try: qid = info["qid"] cid = info["cid"] ch = Choice.objects.get(pk=cid) if ch.question.id != qid: raise ValueError("Mismatched question and choice pair") ch.votes += 1 ch.save() return JsonResponse({ "code": 0, "choices": [ model_to_dict(ch, exclude=["question"]) for ch in Choice.objects.filter(question__id=qid) ] }) except: if settings.DEBUG: raise return JsonResponse({ "code": -1 }, status=400) ``` 然后添加一条路由: ``` path('vote', views.vote) ``` 这时在 Postman 中查询，发现响应为 HTTP 403，原因是缺少 CSRF token（出于安全性考虑，Djaongo 默认要求 POST 请求携带 CSRF token，已表明该请求来自被授权的表单）。 在这里我们不妨直接添加装饰器关闭 CSRF token 检查。 ```python from django.views.decorators.csrf import csrf_exempt @csrf_exempt def vote(req: HttpRequest): ... ``` 有时我们希望指定请求的方法，可以使用: ```python from django.views.decorators.http import require_http_methods as method @method(["GET"]) def leaderboard(req: HttpRequest): ... ``` 此时若收到的请求不是 GET 请求，则会返回一个错误。 ## 部署 Django 后端编写好后，我们希望将其部署在服务器上，这样我们就可以通过服务器对外网的端口访问页面。 在此使用一种典型部署：使用 uWSGI 来代理 Django，再用反向代理 Nginx 连接 uWSGI，将其代理到外网。 ### uWSGI 现在我们准备将 Django 部署到服务器上了。 先将文件转移到服务器的某个文件夹中（如果你使用 PyCharm，则可以使用其内置的“部署”工具来进行转移），这里以暑培服务器为例，选择 `/home/train/site`。 在前置准备中，我们已经安装了 conda 并配置好了虚拟环境，确认了 Nginx 可以正常启动。 进入网站目录，启动虚拟环境，用以下代码，我们可以将 uWSGI 代理到 10001 端口： ```bash uwsgi --http :10001 --module mysite.wsgi ``` 其中 module 参数指出相应的 Python 模块。 现在我们就可以从外网通过端口来访问这个 Django 应用了。 如果提示无法连接到 MySQL 服务器，则可在 `mysite/__init__.py` 中加入以下代码： ```python import pymysql pymysql.install_as_MySQLdb() ``` 我们也可以使用配置文件来进行操作: ``` [uwsgi] socket = :9999 chdir = /home/train/site module = mysite.wsgi master = true processes = 9 threads = 9 vacuum = true ``` 然后 ```bash uwsgi --ini u.ini ``` 其中，如果直接使用 uWSGI 应该指定 http，否则指定 socket。 关于 Django + uWSGI 的更多配置，详见[如何用 uWSGI 托管 Django](https://docs.djangoproject.com/zh-hans/4.0/howto/deployment/wsgi/uwsgi/)。 ### Nginx 我们可以先来个极简配置，代理一波 uWSGI(更细致的配置可以参考其官方文档)。 在 `/etc/nginx/sites-enabled/default` 中加入以下内容: （uWSGI 将 Django 代理到了 127.0.0.1 的 9999 端口，Nginx 又将其代理到了 10002 端口） ``` server{ listen 10002; server_name 59.66.131.240; location / { include uwsgi_params; uwsgi_pass 127.0.0.1:9999; uwsgi_read_timeout 15; } } ``` 此时在命令行中执行： ```bash sudo service nginx start ``` 此时就可以在外网中访问之前搭建的网页了。 另外也可以使用 Nginx 配置静态文件的代理。形如： ``` server { listen 10001; server_name 59.66.131.240; location / { root /home/nana/build; index index.html; } ``` 有时我们会遇到 Nginx 没有权限读取内容的问题，表现为 HTTP 403，此时可以给相关文件加上权限， chown，甚至可以直接找到 `/etc/nginx/nginx.conf` ，将其首部的 user 改为 root。 #### 查找错误 在配置 Nginx 时，常用 ```bash sudo nginx -t sudo cat /var/log/nginx/error.log ``` 定位错误(前者检查配置文件中的错误，后者展示错误日志）。 例如配置文件编写有误，或端口被占用等问题，就可以被这两个命令发现。 ## 扩展阅读 还有一些比较常用的主题，篇幅有限，以下是链接： 单元测试 UnitTest: https://docs.djangoproject.com/zh-hans/4.0/intro/tutorial05/ Middle Ware: https://docs.djangoproject.com/zh-hans/4.0/topics/http/middleware/ Command: https://docs.djangoproject.com/zh-hans/4.0/howto/custom-management-comm ands/ Django REST Framework：https://www.django-rest-framework.org --- ### 大一小学期 Week 3 Python Exam 2016 Docs Contents (`大一小学期/Week_3-Python/exam/2016/docs/contents.txt`) ============================= Django documentation contents ============================= .. toctree:: :hidden: index .. toctree:: :maxdepth: 3 intro/index topics/index howto/index faq/index ref/index misc/index glossary releases/index internals/index Indices, glossary and tables ============================ * :ref:`genindex` * :ref:`modindex` * :doc:`glossary` --- ### 大一小学期 Week 3 Python Exam 2016 Docs Glossary (`大一小学期/Week_3-Python/exam/2016/docs/glossary.txt`) ======== Glossary ======== .. glossary:: concrete model A non-abstract (:attr:`abstract=False `) model. field An attribute on a :term:`model`; a given field usually maps directly to a single database column. See :doc:`/topics/db/models`. generic view A higher-order :term:`view` function that provides an abstract/generic implementation of a common idiom or pattern found in view development. See :doc:`/topics/class-based-views/index`. model Models store your application's data. See :doc:`/topics/db/models`. MTV "Model-template-view"; a software pattern, similar in style to MVC, but a better description of the way Django does things. See :ref:`the FAQ entry `. MVC `Model-view-controller`__; a software pattern. Django :ref:`follows MVC to some extent `. __ https://en.wikipedia.org/wiki/Model-view-controller project A Python package -- i.e. a directory of code -- that contains all the settings for an instance of Django. This would include database configuration, Django-specific options and application-specific settings. property Also known as "managed attributes", and a feature of Python since version 2.2. This is a neat way to implement attributes whose usage resembles attribute access, but whose implementation uses method calls. See :class:`property`. queryset An object representing some set of rows to be fetched from the database. See :doc:`/topics/db/queries`. slug A short label for something, containing only letters, numbers, underscores or hyphens. They're generally used in URLs. For example, in a typical blog entry URL: .. parsed-literal:: https://www.djangoproject.com/weblog/2008/apr/12/**spring**/ the last bit (``spring``) is the slug. template A chunk of text that acts as formatting for representing data. A template helps to abstract the presentation of data from the data itself. See :doc:`/topics/templates`. view A function responsible for rendering a page. --- ### 大一小学期 Week 3 Python Exam 2016 Docs Index (`大一小学期/Week_3-Python/exam/2016/docs/index.txt`) ==================== Django documentation ==================== .. rubric:: Everything you need to know about Django. Getting help ============ Having trouble? We'd like to help! * Try the :doc:`FAQ ` -- it's got answers to many common questions. * Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or the :doc:`detailed table of contents `. * Search for information in the archives of the |django-users| mailing list, or `post a question`_. * Ask a question in the `#django IRC channel`_, or search the `IRC logs`_ to see if it's been asked before. * Report bugs with Django in our `ticket tracker`_. .. _archives: https://groups.google.com/group/django-users/ .. _post a question: https://groups.google.com/d/forum/django-users .. _#django IRC channel: irc://irc.freenode.net/django .. _IRC logs: http://django-irc-logs.com/ .. _ticket tracker: https://code.djangoproject.com/ How the documentation is organized ================================== Django has a lot of documentation. A high-level overview of how it's organized will help you know where to look for certain things: * :doc:`Tutorials ` take you by the hand through a series of steps to create a Web application. Start here if you're new to Django or Web application development. Also look at the ":ref:`index-first-steps`" below. * :doc:`Topic guides ` discuss key topics and concepts at a fairly high level and provide useful background information and explanation. * :doc:`Reference guides ` contain technical reference for APIs and other aspects of Django's machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts. * :doc:`How-to guides ` are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how Django works. .. _index-first-steps: First steps =========== Are you new to Django or to programming? This is the place to start! * **From scratch:** :doc:`Overview ` | :doc:`Installation ` * **Tutorial:** :doc:`Part 1: Requests and responses ` | :doc:`Part 2: Models and the admin site ` | :doc:`Part 3: Views and templates ` | :doc:`Part 4: Forms and generic views ` | :doc:`Part 5: Testing ` | :doc:`Part 6: Static files ` | :doc:`Part 7: Customizing the admin site ` * **Advanced Tutorials:** :doc:`How to write reusable apps ` | :doc:`Writing your first patch for Django ` The model layer =============== Django provides an abstraction layer (the "models") for structuring and manipulating the data of your Web application. Learn more about it below: * **Models:** :doc:`Introduction to models ` | :doc:`Field types ` | :doc:`Meta options ` | :doc:`Model class ` * **QuerySets:** :doc:`Executing queries ` | :doc:`QuerySet method reference ` | :doc:`Lookup expressions ` * **Model instances:** :doc:`Instance methods ` | :doc:`Accessing related objects ` * **Migrations:** :doc:`Introduction to Migrations` | :doc:`Operations reference ` | :doc:`SchemaEditor ` | :doc:`Writing migrations ` * **Advanced:** :doc:`Managers ` | :doc:`Raw SQL ` | :doc:`Transactions ` | :doc:`Aggregation ` | :doc:`Search ` | :doc:`Custom fields ` | :doc:`Multiple databases ` | :doc:`Custom lookups ` | :doc:`Query Expressions ` | :doc:`Conditional Expressions ` | :doc:`Database Functions ` * **Other:** :doc:`Supported databases ` | :doc:`Legacy databases ` | :doc:`Providing initial data ` | :doc:`Optimize database access ` | :doc:`PostgreSQL specific features ` The view layer ============== Django has the concept of "views" to encapsulate the logic responsible for processing a user's request and for returning the response. Find all you need to know about views via the links below: * **The basics:** :doc:`URLconfs ` | :doc:`View functions ` | :doc:`Shortcuts ` | :doc:`Decorators ` * **Reference:** :doc:`Built-in Views ` | :doc:`Request/response objects ` | :doc:`TemplateResponse objects ` * **File uploads:** :doc:`Overview ` | :doc:`File objects ` | :doc:`Storage API ` | :doc:`Managing files ` | :doc:`Custom storage ` * **Class-based views:** :doc:`Overview ` | :doc:`Built-in display views ` | :doc:`Built-in editing views ` | :doc:`Using mixins ` | :doc:`API reference ` | :doc:`Flattened index` * **Advanced:** :doc:`Generating CSV ` | :doc:`Generating PDF ` * **Middleware:** :doc:`Overview ` | :doc:`Built-in middleware classes ` The template layer ================== The template layer provides a designer-friendly syntax for rendering the information to be presented to the user. Learn how this syntax can be used by designers and how it can be extended by programmers: * **The basics:** :doc:`Overview ` * **For designers:** :doc:`Language overview ` | :doc:`Built-in tags and filters ` | :doc:`Humanization ` * **For programmers:** :doc:`Template API ` | :doc:`Custom tags and filters ` Forms ===== Django provides a rich framework to facilitate the creation of forms and the manipulation of form data. * **The basics:** :doc:`Overview ` | :doc:`Form API ` | :doc:`Built-in fields ` | :doc:`Built-in widgets ` * **Advanced:** :doc:`Forms for models ` | :doc:`Integrating media ` | :doc:`Formsets ` | :doc:`Customizing validation ` The development process ======================= Learn about the various components and tools to help you in the development and testing of Django applications: * **Settings:** :doc:`Overview ` | :doc:`Full list of settings ` * **Applications:** :doc:`Overview ` * **Exceptions:** :doc:`Overview ` * **django-admin and manage.py:** :doc:`Overview ` | :doc:`Adding custom commands ` * **Testing:** :doc:`Introduction ` | :doc:`Writing and running tests ` | :doc:`Included testing tools ` | :doc:`Advanced topics ` * **Deployment:** :doc:`Overview ` | :doc:`WSGI servers ` | :doc:`Deploying static files ` | :doc:`Tracking code errors by email ` The admin ========= Find all you need to know about the automated admin interface, one of Django's most popular features: * :doc:`Admin site ` * :doc:`Admin actions ` * :doc:`Admin documentation generator` Security ======== Security is a topic of paramount importance in the development of Web applications and Django provides multiple protection tools and mechanisms: * :doc:`Security overview ` * :doc:`Disclosed security issues in Django ` * :doc:`Clickjacking protection ` * :doc:`Cross Site Request Forgery protection ` * :doc:`Cryptographic signing ` * :ref:`Security Middleware ` Internationalization and localization ===================================== Django offers a robust internationalization and localization framework to assist you in the development of applications for multiple languages and world regions: * :doc:`Overview ` | :doc:`Internationalization ` | :ref:`Localization ` | :doc:`Localized Web UI formatting and form input ` * :doc:`Time zones ` Performance and optimization ============================ There are a variety of techniques and tools that can help get your code running more efficiently - faster, and using fewer system resources. * :doc:`Performance and optimization overview ` Python compatibility ==================== Django aims to be compatible with multiple different flavors and versions of Python: * :doc:`Jython support ` * :doc:`Python 3 compatibility ` Geographic framework ==================== :doc:`GeoDjango ` intends to be a world-class geographic Web framework. Its goal is to make it as easy as possible to build GIS Web applications and harness the power of spatially enabled data. Common Web application tools ============================ Django offers multiple tools commonly needed in the development of Web applications: * **Authentication:** :doc:`Overview ` | :doc:`Using the authentication system ` | :doc:`Password management ` | :doc:`Customizing authentication ` | :doc:`API Reference ` * :doc:`Caching ` * :doc:`Logging ` * :doc:`Sending emails ` * :doc:`Syndication feeds (RSS/Atom) ` * :doc:`Pagination ` * :doc:`Messages framework ` * :doc:`Serialization ` * :doc:`Sessions ` * :doc:`Sitemaps ` * :doc:`Static files management ` * :doc:`Data validation ` Other core functionalities ========================== Learn about some other core functionalities of the Django framework: * :doc:`Conditional content processing ` * :doc:`Content types and generic relations ` * :doc:`Flatpages ` * :doc:`Redirects ` * :doc:`Signals ` * :doc:`System check framework ` * :doc:`The sites framework ` * :doc:`Unicode in Django ` The Django open-source project ============================== Learn about the development process for the Django project itself and about how you can contribute: * **Community:** :doc:`How to get involved ` | :doc:`The release process ` | :doc:`Team organization ` | :doc:`Meet the team ` | :doc:`Current roles ` | :doc:`The Django source code repository ` | :doc:`Security policies ` | :doc:`Mailing lists ` * **Design philosophies:** :doc:`Overview ` * **Documentation:** :doc:`About this documentation ` * **Third-party distributions:** :doc:`Overview ` * **Django over time:** :doc:`API stability ` | :doc:`Release notes and upgrading instructions ` | :doc:`Deprecation Timeline ` --- ### 大一小学期 Week 3 Python Exam 2016 Docs Faq Admin (`大一小学期/Week_3-Python/exam/2016/docs/faq/admin.txt`) ============== FAQ: The admin ============== I can't log in. When I enter a valid username and password, it just brings up the login page again, with no error messages. =========================================================================================================================== The login cookie isn't being set correctly, because the domain of the cookie sent out by Django doesn't match the domain in your browser. Try setting the :setting:`SESSION_COOKIE_DOMAIN` setting to match your domain. For example, if you're going to "https://www.example.com/admin/" in your browser, set ``SESSION_COOKIE_DOMAIN = 'www.example.com'``. I can't log in. When I enter a valid username and password, it brings up the login page again, with a "Please enter a correct username and password" error. =========================================================================================================================================================== If you're sure your username and password are correct, make sure your user account has :attr:`~django.contrib.auth.models.User.is_active` and :attr:`~django.contrib.auth.models.User.is_staff` set to True. The admin site only allows access to users with those two fields both set to True. How do I automatically set a field's value to the user who last edited the object in the admin? =============================================================================================== The :class:`~django.contrib.admin.ModelAdmin` class provides customization hooks that allow you to transform an object as it saved, using details from the request. By extracting the current user from the request, and customizing the :meth:`~django.contrib.admin.ModelAdmin.save_model` hook, you can update an object to reflect the user that edited it. See :ref:`the documentation on ModelAdmin methods ` for an example. How do I limit admin access so that objects can only be edited by the users who created them? ============================================================================================= The :class:`~django.contrib.admin.ModelAdmin` class also provides customization hooks that allow you to control the visibility and editability of objects in the admin. Using the same trick of extracting the user from the request, the :meth:`~django.contrib.admin.ModelAdmin.get_queryset` and :meth:`~django.contrib.admin.ModelAdmin.has_change_permission` can be used to control the visibility and editability of objects in the admin. My admin-site CSS and images showed up fine using the development server, but they're not displaying when using mod_wsgi. ========================================================================================================================= See :ref:`serving the admin files ` in the "How to use Django with mod_wsgi" documentation. My "list_filter" contains a ManyToManyField, but the filter doesn't display. ============================================================================ Django won't bother displaying the filter for a ``ManyToManyField`` if there are fewer than two related objects. For example, if your :attr:`~django.contrib.admin.ModelAdmin.list_filter` includes :doc:`sites `, and there's only one site in your database, it won't display a "Site" filter. In that case, filtering by site would be meaningless. Some objects aren't appearing in the admin. =========================================== Inconsistent row counts may be caused by missing foreign key values or a foreign key field incorrectly set to :attr:`null=False `. If you have a record with a :class:`~django.db.models.ForeignKey` pointing to a non-existent object and that foreign key is included is :attr:`~django.contrib.admin.ModelAdmin.list_display`, the record will not be shown in the admin changelist because the Django model is declaring an integrity constraint that is not implemented at the database level. How can I customize the functionality of the admin interface? ============================================================= You've got several options. If you want to piggyback on top of an add/change form that Django automatically generates, you can attach arbitrary JavaScript modules to the page via the model's class Admin :ref:`js parameter `. That parameter is a list of URLs, as strings, pointing to JavaScript modules that will be included within the admin form via a ``