ビュー¶

テンプレート¶

テンプレートレンダリングエンジンは、ビューのプレゼンテーションに関する タスクを扱うための一般的な選択です。

処理されたテンプレートを返すために、コントローラはそれをレンダリングし て結果を返さなければなりません:

from helloworld.lib.base import BaseController, render

class HelloController(BaseController):
    def sample(self):
        return render('/sample.mako')

デフォルトの Mako テンプレートエンジンを使用すると、Mako は helloworld/templates ディレクトリから sample.mako とい うテンプレートファイルを検索します。(ここで、プロジェクトが ‘helloworld’ であると仮定します)

ここで使用された render() 関数は、実際には Pylons の render_mako() 関数のためにプロジェクトの base.py で定義された別名です。

変数をテンプレートに渡す¶

オブジェクトをテンプレートに渡すために、 Pylons 標準の方法は、それらを コントローラ の中で tmpl_context オブジェ クト (それはコントローラとテンプレートの中ではデフォルトで c という別 名にエイリアスされています) に追加することです:

import logging

from pylons import request, response, session, tmpl_context as c
from pylons.controllers.util import abort, redirect_to

from helloworld.lib.base import BaseController, render

log = logging.getLogger(__name__)

class HelloController(BaseController):

    def index(self):
        c.name = "Fred Smith"
        return render('/sample.mako')

テンプレートで変数を使用します:

Hi there ${c.name}!

Hi there ${c.name}

config['pylons.strict_c'] = True

デフォルトテンプレート変数¶

一般的なオブジェクトに簡単にアクセスできるように、デフォルトですべての テンプレートの中で参照できるいくつかの変数があります。テンプレートのグ ローバルスコープに存在する利用可能な名前に関する完全リストは以下の通り です:

• c – テンプレートコンテキストオブジェクト (tmpl_context のエイリアス)
• tmpl_context – テンプレートコンテキストオブジェクト
• config – Pylons の PylonsConfig オブジェクト (辞書のように振る舞う)
• g – プロジェクトのアプリケーショングローバル変数 (app_globals のエイリアス)
• app_globals – プロジェクトのアプリケーショングローバル変数
• h – プロジェクトの helpers モジュールへの参照
• request – 現在のリクエストに対する Pylons の Request オブジェクト
• response – 現在のリクエストに対する Pylons の Response オブジェクト
• session – Pylons のセッションオブジェクト (セッションが削除 されていなければ)
• translator – 現在のロケールに設定された Gettext translator オブジェクト
• ungettext() – Unicode 版の gettext ngettext 関数 (単数形変換を 処理する)
• _() – Unicode 版の gettext translate 関数
• N_() – 文字列を翻訳対象とマークするための gettext no-op 関数。 しかし実際には翻訳はされません。

テンプレートエンジンを設定する¶

新しい Pylons プロジェクトは、プロジェクトの config/environment.py の中でテンプレートエンジンがセットアップ された状態で開始します。このセクションでは、 Mako テンプレート検索オブ ジェクトを作成して、それをテンプレートレンダリング関数で使用するために app_globals オブジェクトに取り付けます。

# these imports are at the top
from mako.lookup import TemplateLookup
from pylons.error import handle_mako_error

# this section is inside the load_environment function
# Create the Mako TemplateLookup, with the default auto-escaping
config['pylons.app_globals'].mako_lookup = TemplateLookup(
    directories=paths['templates'],
    error_handler=handle_mako_error,
    module_directory=os.path.join(app_conf['cache_dir'], 'templates'),
    input_encoding='utf-8', default_filters=['escape'],
    imports=['from webhelpers.html import escape'])

# Add the additional path for the admin template
paths = dict(root=root,
             controllers=os.path.join(root, 'controllers'),
             static_files=os.path.join(root, 'public'),
             templates=[os.path.join(root, 'templates')],
             admintemplates=[os.path.join(root, 'admintemplates'),
                             os.path.join(root, 'templates')])

config['pylons.app_globals'].mako_admin_lookup = TemplateLookup(
    directories=paths['admin_templates'],
    error_handler=handle_mako_error,
    module_directory=os.path.join(app_conf['cache_dir'], 'admintemplates'),
    input_encoding='utf-8', default_filters=['escape'],
    imports=['from webhelpers.html import escape'])

カスタム render() 関数¶

カスタム render 関数を書くことで、 (例えば Genshi でデフォルトの render_genshi() の機能性を越えるような) テンプ レートエンジンの特定の特徴にアクセスしたり、テンプレートエンジンの追加 サポートを加えることができます。

キャッシュ機能を簡単に使用できるようにするとともに、テンプレートの中で 有用な共通の Pylons グローバル変数を簡単にインクルードできるようにする、 render 関数とともに使用する 2 つのヘルパー関数が提供されています。 pylons_globals() と cached_template() 関数も使うことができ ます。

一般に、カスタム render 関数はプロジェクトの lib/ ディレクトリの中 (おそらく base.py) に置かれます。

これはプロジェクトの lib/base.py で見られるような Genshi render 関 数のサンプルです。それは結果を文字列に完全にレンダリングせず、また c を使う代わりにテンプレートのグローバルな名前空間の中で使用で きる辞書が渡されると仮定します。そして、レンダリングされた文字列の代わ りに Genshi のストリームを返します。

from pylons.templating import pylons_globals

def render(template_name, tmpl_vars):
    # First, get the globals
    globs = pylons_globals()

    # Update the passed in vars with the globals
    tmpl_vars.update(globs)

    # Grab a template reference
    template = globs['app_globals'].genshi_loader.load(template_name)

    # Render the template
    return template.generate(**tmpl_vars)

pylons_globals() 関数を使うと、 config/environment.py の中でテンプレートエンジンが取り付けられ た app_globals オブジェクトを受け取るのが簡単になります。

Changed in version 0.9.7: 0.9.7 より以前は、すべてのテンプレートが ‘Buffet’ と呼ばれる層を通 して扱われていました。Buffet では、どんなカスタマイズも追加の plugin モジュールがインストールされる必要があるため、この層はしばし ばテンプレートエンジンのカスタマイズを難しくしました。Pylons 0.9.7 は現在、 Buffet プラグイン層の使用を非推奨 (deprecated) としています。

Mako によるテンプレート処理¶

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
  <head>
    ${self.head_tags()}
  </head>
  <body>
    ${self.body()}
  </body>
</html>

<%inherit file="/base.mako" />

<%def name="head_tags()">
  <!-- add some head tags here -->
</%def>

<h1>My Controller</h1>

<p>Lorem ipsum dolor ...</p>

return render('/my_action.mako')

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
  <head>
  <!-- add some head tags here -->
  </head>
  <body>

<h1>My Controller</h1>

<p>Lorem ipsum dolor ...</p>

  </body>
</html>