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

Этот расширенный учебник продолжает то, что было начато в Учебнике 7. Мы превратим наш веб-опрос в автономный пакет Python, который вы сможете повторно использовать в новых проектах и делиться им с другими людьми.

Если вы недавно не закончили учебники 1–7, мы рекомендуем вам их пересмотреть, чтобы ваш пример проекта соответствовал описанному ниже.

Многократное использование имеет значение

Разработка, создание, тестирование и сопровождение веб-приложения — это большая работа. Многие проекты Python и Django сталкиваются с общими проблемами. Не было бы замечательно, если бы мы могли сохранить часть этой повторяющейся работы?

Многократное использование — это способ жизни в Python. Индекс пакетов Python (PyPI) содержит обширный набор пакетов, которые вы можете использовать в собственных программах Python. Ознакомьтесь с пакетами Django для поиска существующих многократно используемых приложений, которые вы могли бы включить в свой проект. Сам Django также является обычным пакетом Python. Это означает, что вы можете взять существующие пакеты Python или приложения Django и объединить их в собственный веб-проект. Вам нужно будет написать только те части, которые делают ваш проект уникальным.

Предположим, вы начинаете новый проект, которому нужно приложение опросов, подобное тому, над которым мы работали. Как сделать это приложение многократно используемым? К счастью, вы уже на правильном пути. В Учебнике 1 мы увидели, как мы можем отделить опросы от URLconf уровня проекта, используя include. В этом учебнике мы предпримем дополнительные шаги, чтобы сделать приложение простым в использовании в новых проектах и готовым к публикации для установки и использования другими.

Ваш проект и ваше многократно используемое приложение

После предыдущих учебников наш проект должен выглядеть так:

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

Вы создали mysite/templates в Учебнике 7, а polls/templates в Учебнике 3. Теперь, возможно, яснее, почему мы выбрали отдельные каталоги шаблонов для проекта и приложения: все, что является частью приложения опросов, находится в polls. Это делает приложение автономным и проще встраивать в новые проекты.

Директорию polls теперь можно скопировать в новый проект Django и сразу же повторно использовать. Однако она еще не готова к публикации. Для этого нам нужно упаковать приложение, чтобы другие могли легко его установить.

Установка необходимых компонентов

Текущее состояние упаковки Python несколько запутанно из-за различных инструментов. В этом учебнике мы будем использовать setuptools для создания нашего пакета. Это рекомендуемый инструмент для упаковки (слитый с веткой distribute). Мы также будем использовать pip для установки и удаления. Установите эти два пакета сейчас. Если вам нужна помощь, вы можете обратиться к инструкции по установке Django с помощью pip. Вы можете установить setuptools таким же образом.

Упаковывание вашего приложения

Упаковка Python — это подготовка вашего приложения в определенном формате, который можно легко установить и использовать. Сам Django упаковывается очень похожим образом. Для небольшого приложения, такого как опросы, этот процесс не слишком сложен.

1. Сначала создайте родительскую директорию для polls, вне вашего проекта Django. Назовите эту директорию django-polls.

   Выбор имени для вашего приложения

   При выборе имени для вашего пакета проверьте ресурсы, такие как PyPI, чтобы избежать конфликтов имен с существующими пакетами. Зачастую полезно добавлять префикс django- к имени вашего модуля при создании пакета для распространения. Это помогает другим пользователям, ищущим приложения Django, определить ваше приложение как специфическое для Django.

   Метки приложений (т. е. конечная часть точечной пути к пакетам приложений) *должны* быть уникальными в INSTALLED_APPS. Избегайте использования той же метки, что и в каких-либо пакетах Django contrib, например auth, admin, или messages.

2. Переместите директорию polls в директорию django-polls.

3. Создайте файл django-polls/README.rst со следующим содержимым:

   django-polls/README.rst

   =====
   Polls
   =====
   
   Polls is a 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::
   
       path('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.
   

4. Создайте файл django-polls/LICENSE. Выбор лицензии выходит за рамки этого учебника, но достаточно сказать, что код, выпущенный публично без лицензии, *бесполезен*. Django и многие совместимые с Django приложения распространяются по лицензии BSD; однако вы можете выбрать собственную лицензию. Просто имейте в виду, что ваш выбор лицензии повлияет на тех, кто сможет использовать ваш код.

5. Далее мы создадим файлы pyproject.toml, setup.cfg, и setup.py, которые описывают, как создать и установить приложение. Полное объяснение этих файлов выходит за рамки этого учебника, но в документации setuptools есть хорошее объяснение. Создайте файлы django-polls/pyproject.toml, django-polls/setup.cfg, и django-polls/setup.py со следующим содержимым:

   django-polls/pyproject.toml

   [build-system]
   requires = ['setuptools>=40.8.0', 'wheel']
   build-backend = 'setuptools.build_meta:__legacy__'
   

   django-polls/setup.cfg

   [metadata]
   name = django-polls
   version = 0.1
   description = A Django app to conduct web-based polls.
   long_description = file: README.rst
   url = https://www.example.com/
   author = Your Name
   author_email = yourname@example.com
   license = BSD-3-Clause  # Example license
   classifiers =
       Environment :: Web Environment
       Framework :: Django
       Framework :: Django :: X.Y  # Replace "X.Y" as appropriate
       Intended Audience :: Developers
       License :: OSI Approved :: BSD License
       Operating System :: OS Independent
       Programming Language :: Python
       Programming Language :: Python :: 3
       Programming Language :: Python :: 3 :: Only
       Programming Language :: Python :: 3.8
       Programming Language :: Python :: 3.9
       Topic :: Internet :: WWW/HTTP
       Topic :: Internet :: WWW/HTTP :: Dynamic Content
   
   [options]
   include_package_data = true
   packages = find:
   python_requires = >=3.8
   install_requires =
       Django >= X.Y  # Replace "X.Y" as appropriate
   

   django-polls/setup.py

   from setuptools import setup
   
   setup()
   

6. По умолчанию в пакет включаются только модули и пакеты Python. Для включения дополнительных файлов нам нужно создать файл MANIFEST.in. В документации setuptools, упомянутой в предыдущем шаге, подробнее обсуждается этот файл. Для включения шаблонов, README.rst и нашего файла LICENSE, создайте файл django-polls/MANIFEST.in со следующим содержимым:

   django-polls/MANIFEST.in

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

7. Необязательно, но рекомендуется включить подробную документацию к вашему приложению. Создайте пустую директорию django-polls/docs для будущей документации. Добавьте дополнительную строку в django-polls/MANIFEST.in:

   recursive-include docs *
   

   Обратите внимание, что директория docs не будет включена в ваш пакет, если вы не добавите в неё какие-либо файлы. Многие приложения Django также предоставляют документацию онлайн через сайты, такие как readthedocs.org.

8. Попробуйте создать свой пакет с помощью python setup.py sdist (запустите изнутри django-polls). Это создаст директорию dist и создаст ваш новый пакет, django-polls-0.1.tar.gz.

Для получения дополнительной информации о упаковке см. Учебник Python по упаковке и распространению проектов.

Использование собственного пакета

Поскольку мы переместили директорию polls из проекта, она больше не работает. Теперь мы исправим это, установив наш новый пакет django-polls.

1. Для установки пакета используйте pip (вы уже установили его, верно?):

   python -m pip install --user django-polls/dist/django-polls-0.1.tar.gz
   

2. Надеюсь, ваш проект Django теперь снова будет работать правильно. Запустите сервер снова, чтобы подтвердить это.

3. Для удаления пакета используйте pip:

   python -m pip uninstall django-polls
   

Опубликование вашего приложения

Теперь, когда мы упаковали и протестировали django-polls, оно готово к публикации в мире! Если это был не просто пример, вы теперь могли бы:

• Отправьте пакет другу по электронной почте.
• Загрузите пакет на свой веб-сайт.
• Опубликуйте пакет в общедоступном репозитории, таком как Python Package Index (PyPI). На сайте packaging.python.org есть хороший учебник по этому вопросу.

Установка пакетов Python с виртуальной средой

Ранее мы установили приложение polls в качестве пользовательской библиотеки. Это имеет некоторые недостатки:

• Изменение пользовательских библиотек может повлиять на другое Python-программное обеспечение на вашей системе.
• Вы не сможете запустить несколько версий этого пакета (или других с тем же именем).

Как правило, эти ситуации возникают только при одновременном обслуживании нескольких проектов Django. В таких случаях лучшим решением является использование venv. Этот инструмент позволяет поддерживать несколько изолированных сред Python, каждая со своей копией библиотек и пространства имён пакетов.