超シンプルなアプリケーションを作ろう | Zope3

おみくじを作ってみましょう。

おみくじプログラム

今回作ってみるアプリケーションはあなたのラッキーカラーを教えてくれるおみくじです。CGIのサンプルとしても定番ですね。要はアクセスするたびに表示内容が変わるよ、っていうことです。

Pythonパッケージを作る

Zope3にはどんな風にプログラムを書いていけばいいのか、明確な指針があります。これはZope3の設計ポリシーといってもいいでしょう。これに沿っておみくじプログラムを書いていきましょう。

Zope2と違って、Zope3のアプリケーションはPythonのパッケージとして作ります。つまり、「Products以下に置くこと」みたいなお約束はありません。どこかPYTHONPATHの通ったところを作業場所に決めてください。

作業場所を決めましたね。今回作るパッケージ名はomikujiとします。ディレクトリを作りましょう。

$ mkdir omikuji
$ cd omikuji
$ touch __init__.py

はい、上記のコマンドでPythonのパッケージ omikuji ができました。パッケージには __init__.py が必要です。忘れないでくださいね。ちゃんとPYTHONPATHの通っている場所に作りましたか？Pythonの対話シェルで確認しましょう。

$ python
Python 2.3.5 (#2, Jun 19 2005, 13:28:00) 
[GCC 3.3.6 (Debian 1:3.3.6-6)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import omikuji

インポートできればOKです。

omikujiパッケージのトップディレクトリ

パッケージのトップディレクトリには、アプリケーションにとって最重要な中核の機能を配置します。それ以外のものは置きません。

おみくじアプリケーションの最重要機能はラッキーカラーを算出するというアルゴリズムです(単にランダムを使うだけですが)。

これを kuji.py に書きましょう。

"""Fortune cookie

$Id: 001130,v 1.57 2005/11/20 21:29:00 root Exp $
"""
import random

color = ('red', 'green', 'blue', 'white', 'black')

def luckycolor():
    """lucky color algorithm"""
    return random.choice(color)

できました。luckycolor関数が肝心な機能です。

次に configure.zcml というファイルを作ってください。これはZCMLという Zope3の設定ファイルです。ZCMLはZope3のコンポーネント同士を結びつけるための糊の役割を果します。これがないとZope3はおみくじプログラムを読み込んでくれません。

細かい説明はしませんが、ZCMLはZopeの起動時に読み込まれ、あるコンポーネントから別のあるコンポーネントへのアダプターを登録していきます。これが糊の役割です。実行時にZopeのアプリケーションは登録されたアダプターを見つけて必要な処理を行っています。

今回のアプリケーションは本当に単純なものなので、ZCMLに書くことはほとんどありません。以下の内容を書いてください。

<include package=".browser" />

ZCMLには色々なディレクティブ(タグ)があります。最上位で使えるディレクティブ(あるディレクティブの中でしか使えないディレクティブがたくさんあります)は configure とinclude です。

include は次に読み込むZCMLを指定するディレクティブです。ここでは、このパッケージ内にあるbrowserパッケージの中にある configure.zcmlを読み込めという命令になります。ですが、まだbrowserパッケージはありませんね。作りましょう。

$ mkdir browser
$ touch browser/__init__.py

browserは、Zope3の命名規則でウェブブラウザ向けの見た目の機能を提供するパッケージの名前と決められています。Zopeのソースツリーを眺めてみれば、 browserパッケージがたくさんあることが分かります。

おみくじプログラムは、ウェブブラウザでラッキーカラーを教えてあげるアプリケーションにするつもりなので、browserパッケージを作りました。

これで、トップディレクトリに必要なものが全て揃いました。

$ ls -1 omikuji
__init__.py
browser/
configure.zcml
kuji.py

browserパッケージ

次にウェブブラウザ向けの機能を作っていきましょう。

まず、空っぽのファイルを作ります。

$ cd browser
$ touch configure.zcml
$ touch view.py
$ touch view.pt
$ ls -1
__init__.py
configure.zcml
view.pt
view.py

また、configure.zcmlが出てきましたね。これにはこのパッケージで提供するウェブブラウザ向けの機能の設定を書きます。こんな感じでパッケージの中には必ず一つのconfigure.zcmlを作るというパターンを覚えておきましょう。

view.pyにはビュー(View)クラスと言われる表示用ロジックを提供するクラスを書きます。Zope3ではビュー(例えばHTML1ページ)にビュークラスを付けることができます。Zope2ではちょっとした関数がたくさんのPythonScriptになってごちゃごちゃになるところですが、Zope3はビュークラスを使うことでとてもすっきりした構成になります。

view.ptは表示用に使うテンプレート言語ZopePageTemplateで書かれたファイルです。ページの表示結果にこのページテンプレートを使えます。

これで、おみくじアプリケーションに必要なディレクトリ・ファイルの構成ができあがりました。これがZope3用パッケージの定番の構成です。

$ ls -R1 omikuji
omikuji:
__init__.py
browser/
configure.zcml
kuji.py

omikuji/browser:
__init__.py
configure.zcml
view.pt
view.py

Zope3のパッケージを作るための便利なツールがあるようです。私はまだ使ったことがないのですが、Zope3の開発に使われているようなので、使って損はなさそうです。URLだけ紹介しておきます。

http://www.zope.org/Members/fdrake/zpkgtools

configure.zcml

今回はZCMLから書いていきましょう。

<configure
  xmlns="http://namespaces.zope.org/browser">

  <page
      for="*"
      name="omikuji.html"
      permission="zope.View"
      class=".view.KujiView"
      template="view.pt"
      />

</configure>

ZCMLでは、普通はconfigureディレクティブを書いて、その中にいろいろなディレクティブを書きます。(ZCMLの細かい説明は省きます。)

configureではその中で使うディレクティブを使うために、使えるネームスペースを宣言する必要があります。

ここでは、ウェブブラウザ用のディレクティブを提供するbrowserネームスペースを有効にしています。

xmlns="http://namespaces.zope.org/browser"

pageディレクティブは、URLでアクセスできるウェブブラウザ用の1ページを定義するためのものです。

<page
    for="*"
    name="omikuji.html"
    permission="zope.View"
    class=".view.KujiView"
    template="view.pt"
    />

for にはこのページの対象になるインターフェースを指定しますが、このおみくじパッケージはどこでも見られるようにするので、特にインターフェースは指定しないために * としています。今はとりあえずあまり気にしなくてもいいです。

name は実際のURLになる部分です。特に拡張子をhtmlにする必要はありません。好きな名前を付けられます。ここではomikuji.htmlとしました。

permission はこのページにアクセスするための権限の設定です。おみくじを誰でもみられるようにzope.Viewパーミッションを定義しておきました。ちなみにZope3のパーミッションは全て宣言してからでないと使えません。これは Zope2と違う点ですね。zope.Viewはzope本体ではじめから宣言されているパーミッションです。

class はこのページで使うビュークラスを指定します。ページにアクセスがあると、ビュークラスで指定したクラスのインスタンスが作られて、直接そのメソッドが実行されたり、ページテンプレート内でこのインスタンスにアクセスできたりします。

ここではviewモジュールのKujiViewクラスをビュークラスとして使うように宣言しています。

template はこのページで使うテンプレートを指定します。同じディレクトリにあるview.ptを使うように宣言しています。

ビュークラス view.py

configure.zcmlが完成しました。この中でビュークラスを使うよう書きました。ビュークラスを実装しましょう。

"""Browser view component for fortune cookie

$Id: 001130,v 1.57 2005/11/20 21:29:00 root Exp $
"""
from omikuji.kuji import luckycolor


class KujiView:
    
    def luckycolor(self):
        """today's lucky color."""
        return luckycolor()

luckycolorメソッドを持つクラスを作りました。このメソッドは前に定義した luckycolor関数を返すだけです。

テンプレート view.pt

ページテンプレートです。ここで上述のビュークラスのluckycolorメソッドを実行して、その結果をHTMLに埋め込みましょう。これがomikuji.htmlの処理結果としてウェブブラウザに返ります。

<html>
<head>
<title>Lucky color</title>
</head>
<body>

Your lucky color is <span tal:replace="view/luckycolor">red</span>!!

</body>
</html>

Your lucky color is <span tal:replace="view/luckycolor">red</span>!!

view/luckycolor となっている部分が重要なところです。ここでviewという名前はZCMLで定義したビュークラスのインスタンスを指しています。このインスタンスのluckycolorメソッドを実行せよ、という意味になるので、結果として何かの色の名前になります。

完成

これで完成です。最後にZope3が起動するときにomikujiパッケージを読み込むようにZCMLをpackage-includesに追加しておきましょう。

$ cd Zope3のルートディレクトリ
$ cd package-includes

omikuji-configure.zcmlの中身は次のとおり。

<include package="omikuji" />

omikuji-configure.zcmlを置いたpackage-includesはちゃんとZope3が起動したときに読み込む場所になっているでしょうか。前のコラム「起動の仕組み」に書いたsite.zcmlのことを思い出してくださいね。

omikuji-configure.zcmlの名前の規則ですが、これは一般的に XXX-configure.zcmlのXXXの部分にパッケージ名が入ります。PYTHONPATHの直下にあるトップのパッケージは名前に重複がないはずですから、この命名規則でZCMLの名前も重複しないはずですね。

それでは、Zope3を起動してください。うまく起動しましたか？起動しなかったら、エラーメッセージがでているはずです。良く読んで解決してください。分からなかったらフィードバックで質問してくれてもOKです。

起動したら、

http://localhost:8080/omikuji.html

にアクセスしてみてください。おみくじページが表示されましたか？こんな風にメッセージが表示できたら成功です。

Your lucky color is black!!

今回はここまでです。いかがだったでしょうか。次回はおみくじを少しだけ発展させて、ラッキーカラーに表示する色の種類を自分で登録できるようにしたいと思います。

フィードバックもお待ちしています。

次回、超シンプルなアプリケーションを作ろうその2に続く。

Chat (Lingr.com)

Informaiton

Daily

Column

Zope Solution

Extra

アーカイブ

OSS案内所

Site Info

関連リンク