設定 (Configuration)¶

実行時設定¶

新しいプロジェクトが作られるとき、プロジェクトのファイルの 1 つとして development.ini と呼ばれる設定ファイルのサンプルが自動的に生成 されます。このデフォルトの設定ファイルは開発のために使用するのに適切な オプションを含んでいます。例えば、 Pylons アプリケーションの開発中は、 エラーが発生する度にデバッグレポートを見ることができると非常に便利です。 development.ini ファイルはデバッグモードを有効にするオプション を含んでいるので、このようなエラーが表示されます。

どのアプリケーションを実行するかを決定するために設定ファイルが使われる ので、複数の設定ファイルを使用することで簡単にオプションのセットを切り 換えることができます。典型的に、開発者はテスト (訳注: 開発) のための development.ini 設定ファイルと paster make-config コマン ドで生成された production.ini ファイルを使います。 production.ini ファイルは paster make-config コマンドが 適切なプロダクション用ファイルを生成することをテストするために使用され ます。また、 test.ini 設定は、テスト専用のオプションのためにプ ロジェクトに含まれています。

アプリケーションを実行するときに使用する設定ファイルを指定するには、 paster serve の最後の部分に必要な設定ファイルを含めるように 変えてください:

$ paster serve production.ini

from pylons import config

cache_dir = %(here)s/data

from pylons import config
cache_dir = config['cache_dir']

debug = config['debug']

from paste.deploy.converters import asbool

debug = asbool(config['debug'])

$ paster make-config helloworld production.ini

環境 (Environment)¶

config/environment.py モジュールは、アプリケーションを実行する のに必要とされる基本的な Pylons 環境変数をセットアップします。アプリケー ション全体のために一度だけセットアップされるオブジェクトは、ここか、も しくは lib/app_globals の __init__() メソッドでセットアッ プすべきです。

それはまた、 URL がどのように コントローラ とマッチされるかをセッ トアップする URL 設定 関数を呼び出します。そして app_globals オブジェクトを作り、どのモジュールが h とし て参照できるようになるかを設定します。さらに、テンプレートエンジンがセッ トアップされる場所でもあります。

SQLAlchemy を使用するとき、このモジュールで SQLAlchemy エンジンをセット アップすることが推奨されます。 Pylons のデフォルトの SQLAlchemy 設定で はここでエンジンが作成されます。そのエンジンは後に model/__init__.py で使用されます。

URL 設定¶

Routes と呼ばれる Python ライブラリが、 URL からコントローラとそのメソッ ド (Routes はそれを action と呼びます) へのマッピングを扱います。 デフォルトで、 Pylons は以下の route をセットアップします (それ らは config/routing.py で見つかります):

map.connect('/{controller}/{action}')
map.connect('/{controller}/{action}/{id}')


.. Prior to Routes 1.9, all map.connect statements required
.. variable parts to begin with a ``:`` like
.. ``map.connect(':controller/:action')``. This syntax is now
.. optional, and the new ``{}`` syntax is recommended.

Changed in version 0.9.7: Routes 1.9 より前は、 map.connect(':controller/:action') のよう に、すべての map.connect 文が : で始まる可変部分を必要としてい ました。現在この構文はオプションであり、新しい {} 構文が推奨さ れます。

すべての中括弧の内側のパス部分は、その ‘部分’ が URL 内のどんなテキスト にもマッチする変数 (可変部分) です。 URLの ‘部分’ とは、 2つのスラッ シュの間のテキストのことです。 URL のすべての部分が route にマッ チしなければ、 404 が返されます。

上記の route は、高性能な URL マッチングのために Routes ライブラリによっ て正規表現に変換されます。デフォルトで、すべての可変部分は、 ({controller} の特別な場合を除いて) スラッシュ以外の全ての文字とマッ チするように [^/]+ という正規表現になります。これは簡単に変えること ができて、例えば {id} が数字だけにマッチするようにするには、このよ うにします:

map.connect('/{controller}/{action}/{id:\d+}')

正規表現が {} を含んでいるなら、それを可変部分とは別に指定しなけれ ばなりません。 {id} が 2-4 桁の数字にしかマッチしないように制限する ためには:

map.connect('/{controller}/{action}/{id}',  requirements=dict(id='\d{2,4}'))

また、キーワード引数としてコントローラとアクションを指定することができ、 その場合にはそれらが URL に含まれている必要はありません:

# Archives by 2 digit year -> /archives/08
map.connect('/archives/{year:\d\d}', controller='articles',  action='archives')

map.connect 文における可変部分、またはキーワード引数は、アクション の中で利用することが可能です。上の route の場合、 article コントロー ラに解決されます:

class ArticlesController(BaseController):

    def archives(self, year):
        ...

year とマッチした URL 部分は、関数引数の中で名前によって参照できます。

デフォルトのマッピングは、あらゆるコントローラのあらゆるアクションにマッ チします。これは以下の URL がマッチすることを意味します:

/hello/index       >>    controller: hello, action: index
/entry/view/4      >>    controller: entry, action: view, id:4
/comment/edit/2    >>    controller: comment, action: edit, id:2

複雑な URL が必要でない場合、この簡単な方法は大規模なアプリケーションに さえ適していることがあります。

また、コントローラをディレクトリにまとめることができます。例えば管理画 面用に別の comments コントローラが必要なら:

$ paster controller admin/comments

これにより admin ディレクトリの下に適切な comments コントローラ が作成されます。 comments コントローラに到達するために:

/admin/comments/index    >>    controller: admin/comments, action: index

map.connect('/', controller='main', action='index')

# generates /content/view/2
url(controller='content', action='view', id=2)

# Generates /content/view/3 during a request for /content/view/3
url.current()

# Generates /content/view/2 during a request for /content/view/3
url.current(id=2)

ミドルウェア¶

プロジェクト WSGI スタックは config/middleware.py モジュールで セットアップされます。観念的に、このファイルは必要とするミドルウェアを インポートして、 make_app 関数でそれをセットアップします。

Pylons アプリケーションのためのセットアップであるデフォルトスタックは WSGI ミドルウェア で詳細に説明されます。

デフォルトミドルウェアスタック:

# The Pylons WSGI app
app = PylonsApp()

# Routing/Session/Cache Middleware
app = RoutesMiddleware(app, config['routes.map'])
app = SessionMiddleware(app, config)
app = CacheMiddleware(app, config)

# CUSTOM MIDDLEWARE HERE (filtered by error handling middlewares)

if asbool(full_stack):
    # Handle Python exceptions
    app = ErrorHandler(app, global_conf, **config['pylons.errorware'])

    # Display error documents for 401, 403, 404 status codes (and
    # 500 when debug is disabled)
    if asbool(config['debug']):
        app = StatusCodeRedirect(app)
    else:
        app = StatusCodeRedirect(app, [400, 401, 403, 404, 500])

# Establish the Registry for this application
app = RegistryManager(app)

if asbool(static_files):
    # Serve static files
    static_app = StaticURLParser(config['pylons.paths']['static_files'])
    app = Cascade([static_app, app])

return app

それぞれのミドルウェアはそれより前のものをラップするので、スタックはそ れが呼ばれる順の逆順で組み立てられる必要があります。 すなわち、 WSGI Application をラップする最後のミドルウェアは、サーバによって最初に呼ば れます。

スタックの中のミドルウェアの最後の断片は Cascade と呼ばれ、開発の間、静 的な内容ファイルを返すのに使用されます。最高の性能のためには、設定ファ イルの中で static_files = false と設定することで Cascade ミドルウェ アを無効にすることを考慮してください。そして、ウェブサーバあるいは CDN が静的なファイルを返します。

# CUSTOM MIDDLEWARE HERE (filtered by error handling middlewares)

# The Pylons WSGI app
app = PylonsApp()

# Routing/Session/Cache Middleware
app = RoutesMiddleware(app, config['routes.map'])
app = SessionMiddleware(app, config)
app = CacheMiddleware(app, config)

# CUSTOM MIDDLEWARE HERE (filtered by error handling middlewares)
app = MyMiddleware(app)

# Routing/Session/Cache Middleware
app = RoutesMiddleware(app, config['routes.map'])
app = SessionMiddleware(app, config)

# MyMiddleware can only see the cache object, nothing *above* here
app = MyMiddleware(app)

app = CacheMiddleware(app, config)

[app:main]
use = egg:app_name
full_stack = true

アプリケーション・セットアップ¶

Pylons を使用するプロジェクトに関して、言及されることのある ‘アプリケー ション・セットアップ’ には 2 種類あります。

• 新しいアプリケーションをセットアップする
• プロジェクト情報とパッケージの依存を設定する

import logging

from helloworld.config.environment import load_environment

log = logging.getLogger(__name__)

def setup_app(command, conf, vars):
    """Place any commands to setup helloworld here"""
    load_environment(conf.global_conf, conf.local_conf)

$ paster setup-app development.ini

install_requires=[
    "Pylons>=0.9.7",
],

$ python setup.py develop