Углублённый материал: Как создать повторно применяемое приложение

This advanced tutorial begins where Tutorial 6 left off. We’ll be turning our Web-poll into a standalone Python package you can reuse in new projects and share with other people.

If you haven’t recently completed Tutorials 1–6, we encourage you to review these so that your example project matches the one described below.

Смысл многократного использования

Большая часть работы уходит на проектирование, сборку, тестирование и конечно же поддержку веб приложения/компонента. У многих Python и Django проектов существуют схожие задачи и проблемы. Вот было бы здорово не повторять однажды проделанную работу, а сохранить её и использовать в будущем. Не правда ли?

Многократное использование - часть философии Python. К примеру, для тех кто ещё не знает что такое The Python Package Index (PyPI) - это громадное хранилище пакетов которые вы можете использовать в собственных Python программах. Посетите Django Packages и вы также увидите много приложений для Django, который были добавлены другими разработчиками. Эти приложения вы можете использовать в собственным проектах - не стесняйтесь, они для того там и есть! По-существу Django сам является обычным Python пакетом. Всё это означает простую истину: вы можете брать любые существующие решения(пакеты, не важно Python или Django) и использовать в своих проектах как угодно. Это даёт большое преимущество в скорости. Не надо придумывать то, что уже придумано другими, а значит можно посвятить всё время только разработке уникальной стороны своего проекта.

Скажем вы начали новый проект в котором используется приложение для голосования, подобно тому, которое мы разрабатывали в предыдущих уроках. Как же сделать наше приложение с голосованием многократно используемым и независимым от проекта к проекту? К счастью, мы уже на правильном пути и затрагивали эту тему в 3 части. Тогда мы уже смогли отделить приложение для голосования от проекта при помощи URLconf, используя include. В этом уроке мы продвинемся вперёд в решении этого вопроса. А именно, оформим приложение таким образом, чтобы его можно было легко подключать в наших новых проектах. А при желании приложение можно будет опубликовать, и тогда его смогут использовать и другие.

Package? App?

Пакет в Python (Package) представляет собой каталог в котором размещается обязательно файл __init__.py и один или несколько “модулей”. А “модуль” - это обычный файл с расширением ‘.py’ в котором размещён код на языке Python.

Пакет может быть импортирован в ваш код так import foo.bar или так from foo import bar. Для того, чтобы обычная директория (к примеру polls) превратилась в пакет, обязательно создайте в этой директории файл __init__.py. Этот файл может быть пустым.

Приложение (App) в Django является тоже пакетом. Только этот пакет адаптирован для использования с Django. Правила Django допускают включение в пакет таких файлов как models.py, forms.py, admin.py и некоторых др.

Позднее мы будем использовать термин packaging для описания процесса создания пакетов для Python.

Your project and your reusable app

Если вы следовали нашим инструкциям из предыдущих частей урока, ваш каталог проекта должен иметь следующий вид:

mysite/
    manage.py
    mysite/
        __init__.py
        settings.py
        urls.py
        wsgi.py
    polls/
        admin.py
        __init__.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

Во 2 части урока вы создали mysite/templates. А в 3 части урока вы создали polls/templates. Сейчас вы поймёте почему мы решили создать отдельный каталог для проекта и отдельный каталог для приложения. Всё, что касается нашего приложения для голосования мы сохранили в каталоге polls таким образом, чтобы он был автономным. Вот теперь, при желании, этот каталог можно скопировать в наш новый проект. Кроме этого, не забудьте сделать две вещи в новом проекте: добавить название приложения в кортеж INSTALLED_APPS который находится в settings.py, а после этого выполнить в консоли команду ./manage.py syncdb

И хоть приложение сейчас можно переносить из проекта в проект, этого не хватает для того, чтобы делиться с другими. Требуется оформить наше приложение особым образом и запаковать его.

Необходимые условия

Новички могут попасть в замешательство, когда речь идёт о работе с пакетами. Необходимо знать о том, что distribute пришёл на смену setuptools, а pip пришёл на смену easy_install. Поэтому, вы должны сначала установить pip, а затем с помощью него установить distribute. Доп. информацию можно получить по how to install Django with pip

Packaging your app

Python packaging refers to preparing your app in a specific format that can be easily installed and used. Django itself is packaged very much like this. For a small app like polls, this process isn’t too difficult.

  1. First, create a parent directory for polls, outside of your Django project. Call this directory django-polls.

Choosing a name for your app

When choosing a name for your package, check resources like PyPI to avoid naming conflicts with existing packages. It’s often useful to prepend django- to your module name when creating a package to distribute. This helps others looking for Django apps identify your app as Django specific.

  1. Move the polls directory into the django-polls directory.

  2. Create a file django-polls/README.rst with the following contents:

    =====
    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
    -----------
    
    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 syncdb` 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.
    

4. Create a django-polls/LICENSE file. Choosing a license is beyond the scope of this tutorial, but suffice it to say that code released publicly without a license is useless. Django and many Django-compatible apps are distributed under the BSD license; however, you’re free to pick your own license. Just be aware that your licensing choice will affect who is able to use your code.

5. Next we’ll create a setup.py file which provides details about how to build and install the app. A full explanation of this file is beyond the scope of this tutorial, but the distribute docs have a good explanation. Create a file django-polls/setup.py with the following contents:

import os
from setuptools import setup

README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).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=['polls'],
    include_package_data=True,
    license='BSD License',  # example license
    description='A simple Django app to conduct Web-based polls.',
    long_description=README,
    url='http://www.example.com/',
    author='Your Name',
    author_email='yourname@example.com',
    classifiers=[
        'Environment :: Web Environment',
        'Framework :: Django',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: BSD License', # example license
        'Operating System :: OS Independent',
        'Programming Language :: Python',
        'Programming Language :: Python :: 2.6',
        'Programming Language :: Python :: 2.7',
        'Topic :: Internet :: WWW/HTTP',
        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
    ],
)

I thought you said we were going to use distribute?

Distribute is a drop-in replacement for setuptools. Even though we appear to import from setuptools, since we have distribute installed, it will override the import.

  1. Only Python modules and packages are included in the package by default. To include additional files, we’ll need to create a MANIFEST.in file. The distribute docs referred to in the previous step discuss this file in more details. To include the templates, the README.rst and our LICENSE file, create a file django-polls/MANIFEST.in with the following contents:

    include LICENSE
    include README.rst
    recursive-include polls/static *
    recursive-include polls/templates *
    
  2. It’s optional, but recommended, to include detailed documentation with your app. Create an empty directory django-polls/docs for future documentation. Add an additional line to django-polls/MANIFEST.in:

    recursive-include docs *
    

    Note that the docs directory won’t be included in your package unless you add some files to it. Many Django apps also provide their documentation online through sites like readthedocs.org.

  3. Try building your package with python setup.py sdist (run from inside django-polls). This creates a directory called dist and builds your new package, django-polls-0.1.tar.gz.

For more information on packaging, see The Hitchhiker’s Guide to Packaging.

Using your own package

Since we moved the polls directory out of the project, it’s no longer working. We’ll now fix this by installing our new django-polls package.

Installing as a user library

The following steps install django-polls as a user library. Per-user installs have a lot of advantages over installing the package system-wide, such as being usable on systems where you don’t have administrator access as well as preventing the package from affecting system services and other users of the machine. Python 2.6 added support for user libraries, so if you are using an older version this won’t work, but Django 1.5 requires Python 2.6 or newer anyway.

Note that per-user installations can still affect the behavior of system tools that run as that user, so virtualenv is a more robust solution (see below).

  1. Inside django-polls/dist, untar the new package django-polls-0.1.tar.gz (e.g. tar xzvf django-polls-0.1.tar.gz). If you’re using Windows, you can download the command-line tool bsdtar to do this, or you can use a GUI-based tool such as 7-zip.

  2. Change into the directory created in step 1 (e.g. cd django-polls-0.1).

  3. If you’re using GNU/Linux, Mac OS X or some other flavor of Unix, enter the command python setup.py install --user at the shell prompt. If you’re using Windows, start up a command shell and run the command setup.py install --user.

    With luck, your Django project should now work correctly again. Run the server again to confirm this.

  4. To uninstall the package, use pip (you already installed it, right?):

    pip uninstall django-polls
    

Publishing your app

Now that we’ve packaged and tested django-polls, it’s ready to share with the world! If this wasn’t just an example, you could now:

For more information on PyPI, see the Quickstart section of The Hitchhiker’s Guide to Packaging. One detail this guide mentions is choosing the license under which your code is distributed.

Installing Python packages with virtualenv

Earlier, we installed the polls app as a user library. This has some disadvantages:

  • Modifying the user libraries can affect other Python software on your system.
  • You won’t be able to run multiple versions of this package (or others with the same name).

Typically, these situations only arise once you’re maintaining several Django projects. When they do, the best solution is to use virtualenv. This tool allows you to maintain multiple isolated Python environments, each with its own copy of the libraries and package namespace.