Django 1.10文档中文版Part4

最新推荐文章于 2024-10-02 10:53:34 发布

weixin_30778805

最新推荐文章于 2024-10-02 10:53:34 发布

阅读量66

点赞数

文章标签： python

原文链接：http://www.cnblogs.com/kaid/p/7965482.html

版权

2.10 高级教程：如何编写可重用的apps

2.10.1 重用的概念

The Python Package Index (PyPI)有大量的现成可用的Python库。https://www.djangopackages.com
作为Django的app基地也有大量现成可用的apps。

包？App?
包是python重用代码的方式，以目录的形式体现，需要包含__init__.py文件，采用import的方式导入。
app则是Django专用的包，包含一些通用的Django组件，例如models、tests、urls和views等子模块。

2.10.2 你的项目和可重用的app

通过前面的教程，你的项目结构如下：

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分离的条件。但是还需要一个打包的过程。

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。