「全能」選手—Django 1.10文檔中文版Part4

時間 2019-11-19

標籤全能選手 django 1.10 文檔中文版 part4 欄目 Python 简体版

原文原文鏈接

歡迎你們訪問個人主頁：www.liujiangblog.com

第一部分傳送門css

第二部分傳送門html

第三部分傳送門python

3.2 模型和數據庫Models and databasesgit

3.2.2 查詢操做making queriesgithub

3.3.8 會話sessions數據庫

2.10 高級教程：如何編寫可重用的apps

2.10.1 重用的概念

The Python Package Index (PyPI)有大量的現成可用的Python庫。https://www.djangopackages.com
做爲Django的app基地也有大量現成可用的apps。django

包？App?
包是python重用代碼的方式，以目錄的形式體現，須要包含__init__.py文件，採用import的方式導入。
app則是Django專用的包，包含一些通用的Django組件，例如models、tests、urls和views等子模塊。

2.10.2 你的項目和可重用的app

經過前面的教程，你的項目結構以下：session

mysite/
    manage.py
    mysite/
        __init__.py
        settings.py
        urls.py
        wsgi.py
    polls/
        __init__.py
        admin.py
        migrations/
            __init__.py
            0001_initial.py
        models.py
        static/
            polls/
                images/
                    background.gif
                style.css
        templates/
            polls/
                detail.html
                index.html
                results.html
    tests.py
    urls.py
    views.py
    templates/
        admin/
            base_site.html

它已經具有的project和app分離的條件。可是還須要一個打包的過程。app

2.10.3 安裝一些必要工具

使用setuptools和pip來打包咱們的app。請先安裝他們。
https://pypi.python.org/pypi/setuptools
https://pypi.python.org/pypi/pip工具

2.10.4 打包你的app

打包的意思是讓你的app具備一種特殊的格式，使得它更容易被安裝和使用。

首先，在Django項目外面，爲你的polls應用，準備一個父目錄，取名django-polls；

爲你的app選擇一個合適的名字：
在取名前，去PYPI搜索一下是否有重名或衝突的包已經存在。建議給包名加上「django-」的前綴。名字中最後一個圓點的後面部分在INSTALLED_APPS中必定要獨一無二，不能和任何Django的contrib packages中的重名，例如auth、admin、messages等等你。
拷貝polls目錄到該目錄內；
建立一個文件django-polls/README.rst，寫入下面的內容：

Polls

Polls is a simple Django app to conduct Web-based polls. For each
question, visitors can choose between a fixed number of answers.
Detailed documentation is in the "docs" directory.
Quick start
-----------
64 Chapter 2. Getting started
Django Documentation, Release 1.10.2a1
1. Add "polls" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = [
...
'polls',
]
2. Include the polls URLconf in your project urls.py like this::
url(r'^polls/', include('polls.urls')),
3. Run `python manage.py migrate` to create the polls models.
4. Start the development server and visit http://127.0.0.1:8000/admin/
to create a poll (you'll need the Admin app enabled).
5. Visit http://127.0.0.1:8000/polls/ to participate in the poll.

建立一個django-polls/LICENSE版權申明文件。大多數Django相關的app都基於BSD版權。
接下來建立一個setup.py文件，用於編譯和安裝app。如何建立這個，請前往setuptools的官方文檔獲取詳細的教程，本文不涉及。具體內容以下：

django-polls/setup.py

import os
from setuptools import find_packages, setup

with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
    README = readme.read()
    
# allow setup.py to be run from any path
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))

setup(
    name='django-polls',
    version='0.1',
    packages=find_packages(),
    include_package_data=True,
    license='BSD License', # example license
    description='A simple Django app to conduct Web-based polls.',
    long_description=README,
    url='https://www.example.com/',
    author='Your Name',
    author_email='yourname@example.com',
    classifiers=[
        'Environment :: Web Environment',
        'Framework :: Django',
        'Framework :: Django :: X.Y', # replace "X.Y" as appropriate
        'Intended Audience :: Developers',
        'License :: OSI Approved :: BSD License', # example license
        'Operating System :: OS Independent',
        'Programming Language :: Python',
        # Replace these appropriately if you are stuck on Python 2.
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Topic :: Internet :: WWW/HTTP',
        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
    ],
)

默認只有python的模塊和包會被打包進咱們的app內。爲了包含一些附加的文件，須要建立一個MANIFEST.in文件。爲了將靜態文件，模板等等非python語言編寫的文件打包入內，咱們須要在django-polls/MANIFEST.in文件內寫入：

include LICENSE
    include README.rst
    recursive-include polls/static *
    recursive-include polls/templates *

該步驟可選，可是強烈推薦，將詳細的說明文檔一塊兒打包。建立一個空的目錄django-polls/docs，用於放置你的app相關文檔。同時不要忘了，在django-polls/MANIFEST.in文件內寫入一行recursive-include docs *。須要注意的是，若是docs目錄是空的，那麼它不會被打包進去。固然，許多apps經過在線的網站提供文檔閱讀。
在你的django-polls目錄內，運行python setup.py sdist命令。這將會建立一個dist目錄，並編譯成功你的新包，django-polls-0.1.tar.gz。