高度なチュートリアル: 再利用可能アプリの書き方¶
この高度なチュートリアルは、 Tutorial 7 が終わったところから始まります。Web-poll を、新しいプロジェクトで再利用でき、他の人に共有できる独立した Python のパッケージへと変えていきましょう。
直近のチュートリアル 1 - 7 が終わっていないなら、一目通すことをおすすめします。例で作ったプロジェクトが以下の説明でも使われるからです。
再利用性の問題¶
Web アプリケーションの設計、開発、テスト、そしてメンテナンスには多大な労力が必要です。そして多くの Python 、 Django プロジェクト は共通の問題を抱えています。この繰り返し作業を一部保存して保存しておければ良いと思いませんか？
再利用は、 Python ではごく当たり前のことです。 Python Package Index(PyPI) <https://pypi.python.org/pypi> `_ には様々なパッケージが登録されており、それらはすべてあなたの Python プログラム上で使えます。 `Django Packages にもプロジェクトに組み込める組み込める再利用可能なアプリケーションがあるので見てみてください。 Django 自体も単なる Python パッケージです。つまり既存の Python パッケージまたは Django アプリケーションを使って、自分の Web プロジェクトを構成できるということです。必要なのはそのプロジェクト独自の部品を書くことだけです。
投票アプリケーションが必要なプロジェクトを開始したとしましょう。ちょうど今まで作ってきたものと似たようなものです。どうやってその
アプリケーションを再利用可能にしますか？運のいいことに、その方法はすでに会得済みです。 チュートリアル3 では、プロジェクトレベルの URLconf から include を使って、投票アプリを分離する方法をみました。このチュートリアルではアプリケーションを新規のプロジェクトで使いやすいようにし、いつでも別の場所でインストール/利用できるようにしました。
パッケージ？アプリ？
Python の package は再利用しやすいように、関連する Python コードをまとめる方法を提供しています。パッケージは Python コードのファイル ( 通称 “モジュール” ) を１つ以上含んでいます。
パッケージは import foo.bar または from foo import bar でインポートできます。パッケージ内のディレクトリ (例えば polls) は __init__.py という特殊なファイルを、空のファイルでもいいので含む必要があります。
Django アプリケーション は単なる Python パッケージで、特に Django プロジェクトで使うよう意図されたものです。アプリは一般的な Django の慣例に則っているでしょう。例えば models 、tests, urls や views のサブモジュールがあったりです。
以降 パッケージング という言葉を、別の場所でインストールしやすいように Python パッケージを作るプロセスを表すのに用います。少し混乱するかもしれませんね。
プロジェクトと再利用可能アプリ¶
前のチュートリアルを終えると、プロジェクトはこのようになっていたはずです:
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
すでに mysite/templates を チュートリアル 7 で、 polls/templates を チュートリアル 3 で作成しました。今になるとなぜテンプレートディレクトリをプロジェクトとアプリケーションに分けたかが明確にわかりますね。投票アプリケーションに関する全ては polls にあります。アプリケーションが自己完結していて、新規のプロジェクトにも導入しやすくなっています。
今、 polls ディレクトリは新規の Django プロジェクトにコピーでき、すぐに再利用できる状態です。しかし公開するための準備が完璧というわけではありません。そのために、アプリをパッケージにして別の場所でインストールしやすいようにする必要があります。
事前に必要な物をインストールする¶
Python のパッケージングの現状は、複数のツールがあることで少しややこしいです。このチュートリアルでは setuptools をパッケージに使用します。これはおすすめのパッケージングツールです( forkされていた distribute はマージされました)。終わった後にアンインストールするために pip も使います。今はこの 2 つのパッケージをインストールしておいてください。分からなければ Django をpip でインストールする. を参照してください。 distribute も同じ方法でインストールできます。
アプリケーションをパッケージングする¶
Python の パッケージング は特定のフォーマットでアプリを作っておくことを指します。このフォーマットは簡単にインストールして使えます。 Django 自体もこのようにパッケージ化されています。投票アプリのような小さなものでは、このプロセスはそれほど難しいものではありません。
はじめに、
pollsの親ディレクトリを、 Django プロジェクトの外に作りましょう。django-pollsというディレクトリにします。アプリケーションの名前を選んでください
パッケージの名前を決めるときま、 PyPI のようなリソースをチェックして、すでにあるパッケージとの名前の衝突を避ける必要があります。 Django アプリケーションのパッケージを作って配布する際には、モジュール名の先頭に
django-を付けるのがよいでしょう。これによって Django アプリを探してる人が、作ったアプリが Django 特化のものであると分かりやすいからです。アプリケーションラベル (アプリケーションパッケージのドット分けされたパスの最後の部分です)は
INSTALLED_APPSの中で 必ず ユニークでなければなりません。auth、adminやmessagesのようなDjango contrib packages のどれとも同じラベルを使うことは避けます。pollsディレクトリをdjango-pollsディレクトリに移動する以下の内容の
django-polls/README.rstという名前のファイルを作成します: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 ----------- 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 と多くの Django 互換アプリケーションはBSDライセンスの元に配布されます。でもどのライセンスを選択するかは自由です。ライセンスの選択は、誰がコードを使え得るかに影響すると注意してください。次に
setup.pyファイルを作りましょう。これはアプリケーションがどのようにビルド、インストールされるかを提供するものです。このファイルの網羅的な説明はこのチュートリアルの範疇を超えていますが、 setuptools docs には役立つ説明があります。以下のようにdjango-polls/setup.pyファイルを作ってみましょう:django-polls/setup.pyimport 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 のモジュールとパッケージだけがまとめられます。追加のファイルを含めるには、
MANIFEST.inというファイルを作成する必要があります。前のステップで挙げた setuptools のドキュメントには、このファイルについて詳しい説明があります。テンプレート、README.rst、およびLICENSEをパッケージに含めるには、django-polls/MANIFEST.inというファイルを作成し、その中に次のように書きます。django-polls/MANIFEST.ininclude LICENSE include README.rst recursive-include polls/static * recursive-include polls/templates *
アプリケーションの詳細なドキュメントを含めるのは、任意ですが推奨されます。空のディレクトリ
django-polls/docsを将来のドキュメンテーションのために作っておきましょう。django-polls/MANAFEST.inに行を追加しておいてください:recursive-include docs *
MANIFEST.inに対象のファイルを追加しないとdocsディレクトリがパッケージに含まれないことに注意してください。多くの Django アプリではドキュメントを readthedocs.org のようなサイトを通して提供しています。python setup.py sdistでパッケージをビルドしてみましょう (django-polls内で実行してください) 。これによってdistというディレクトリと、新しいパッケージであるdjango-polls-0.1.tar.gzが作られます。
パッケージングに関するより豊富な情報は Tutorial on Packaging and Distributing Projects. にあります。
自分のパッケージを使ってみる¶
polls ディレクトリはプロジェクト外に移動したので、これはもう必要ありません。代わりにできたての django-polls パッケージを使ってみましょう。
ユーザーライブラリとしてインストールする
以下のステップは django-polls をユーザーライブラリとしてインストールするものです。ユーザー単位でのインストールはシステム全体でのインストールよりも多くの利点があります。管理者アクセス権を持っていないシステム上で使用可能というだけでなく、パッケージがシステムサービスやマシン上の他ユーザーに影響を与えるのを防げます。
ユーザー単位でのインストールは依然、そのユーザーのシステムツールの振る舞いに影響をあたえます。なので virtualenv はより確実な解決になります (下記を参照してください) 。
パッケージをインストールするためには、pip を利用してください (すでに ref:インストール <installing-reusable-apps-prerequisites> していますよね?):: To install the package, use pip (you already installed it, right?):
pip install --user django-polls/dist/django-polls-0.1.tar.gz
運が良ければ Django プロジェクトは再度、正常に動作します。確認するために再びサーバーを起動します。
パッケージをアンインストールするには pip を使います:
pip uninstall django-polls
アプリを公開する¶
django-polls のパッケージを作り、テストしました。世界に共有するときです！これが単なる例でなければこうします:
パッケージを友人にメールで送る
自身の Web サイトにアップロードする
公開されているリポジトリに投稿する。例えば the Python Package Index (PyPI). packaging.python.org には よくできたチュートリアル があります。
virtualenv に Python パッケージをインストールする¶
これまでは投票アプリをユーザーライブラリにインストールしてきました。これにはいくつか欠点があります:
ユーザーライブラリの変更はシステム上の他の Python ソフトウェアに影響を与えるおそれがあります
このパッケージの複数バージョン (もしくは同じ名前の別のもの) を実行できません
通常このような問題が起こるのは、複数の Django プロジェクトを管理している場合だけです。一番の解決方法は、 virtualenv を利用することです。このツールを使えば、複数の孤立した Python 環境を作り、各環境ごとにライブラリのコピーやパッケージの名前空間を管理することができます。
