Cheetah:テンプレートファイルのデバッグ

パーサー/コンパイラーへの指示

書式

書式

key = value (no quotes)

いくつかの例です：

code: html

$myVar

cheetahVarStartToken = @

@myVar

$myVar

code: hmtl

commentStartToken = //

// new style of comment

code: html

directiveStartToken = %

%slurp

%compiler-settings reset

変更できる設定の一部を次に示します。

構文設定

cheetahVarStartToken

commentStartToken

multilineCommentStartToken

multilineCommentEndToken

directiveStartToken

directiveEndToken

コード生成設定

ommentOffset

outputRowColComments

defDocStrMsg

useNameMapper

useAutocalling

reprShortStrConstants

reprNewlineThreshold

トラブルシューティング

この章には、他のどこにも収まらない短いものが含まれています。

より専門的な問題とトラブルシューティングのヒントについては、CheetahFAQを参照してください。 ユーザーから提供された最近のヒントについては、定期的にwikiを確認してください。 行き詰まり、これらのリソースのどれも役に立たない場合は、メーリングリストで質問してください。

プレースホルダーのヒント

明らかではない可能性のある特定の重要なルックアップを実行する方法は次のとおりです。 それぞれについて、最初にCheetah式を示し、次にPythonに相当するものを示します。これは、これらをテンプレートまたは純粋なPythonサブクラスのいずれかで使用できるためです。 Cheetahの例では、NameMapperショートカット（均一なドット表記、自動呼び出し）を可能な限り使用しています。

searchListに変数が存在するかどうかを確認するには次のようにします。

code: html

$varExists('theVariable')

self.varExists('theVariable')

code: html

self.getVar('theVariable')

self.getVar('theVariable', myDefault)

変数が欠落している場合にデフォルト値を返す「安全な」プレースホルダールックアップを実行するには、次のようにします。

code: html

$getVar('theVariable', None)

$getVar('theVariable', $myDefault)

診断出力

デバッグ出力を自分に送信する必要がある場合は、{＃silent}を使用して標準エラーに出力できます。

code: html

$getVar("unknown", "No.") + "\n" )

Pythonメソッドを使用する場合

では、どのように選択すればよいのでしょうか？

スーパークラスメソッドの呼び出し

スーパークラスメソッドの呼び出しにチーター固有のものはありませんが、それは不可欠であるため、ここでは標準のPythonテクニックを要約します。 Cheetahクラスは古いスタイルであるため、古いスタイルのクラスのソリューションについてのみ説明します。

code: python

from Cheetah.Template import Template

class MyClass(Template):

def awake(self, trans):

Template.awake(self, trans)

... great and exciting features written by me ...

code: python

===========================================================================

# Place this in a module SOMEWHERE.py . Contributed by Edmund Lian.

class CallbaseError(AttributeError):

pass

def callbase(obj, base, methodname='__init__', args=(), kw={},

raiseIfMissing=None):

try: method = getattr(base, methodname)

except AttributeError:

if raiseIfMissing:

raise CallbaseError, methodname

return None

if args is None: args = ()

return method(obj, *args, **kw)

===========================================================================

# Place this in your class that's overriding .awake (or any method).

from SOMEWHERE import callbase

class MyMixin:

def awake(self, trans):

args = (trans,)

callbase(self, MyMixin, 'awake', args)

... everything else you want to do ...

===========================================================================

テンプレートの最適化

テンプレートの入力を速くし、ユーザーのCPUサイクルを少なくするためにできることがいくつかあります。ただし、これに多くのエネルギーを投入する前に、本当に必要であることを確認してください。多くの場合、テンプレートは瞬時に初期化および入力されるように見えるため、最適化は必要ありません。テンプレートの入力が遅い、メモリの消費量が多すぎる、またはCPUサイクルが多すぎるという状況を見つけた場合は、メーリングリストでお知らせください。

code: python

テンプレートを別のテンプレートから呼び出す

Cheetahテンプレートは、実際には偽装したPythonモジュールです。 つまり、Cheetahがテンプレートをロードすると、それをPythonコードにコンパイルしてからバイトコードにコンパイルします。 すべてのテンプレートは単一のクラスとしてコンパイルされます。 重要なのは、ソースコードもバイトコードもファイルに自動的に保存されないということです。

ユーザーが1つのテンプレート（つまりPythonモジュール）を別のテンプレートからインポートできるようにする方法はいくつかあります。

編集後にすべてのテンプレートを半自動でコンパイルするには、次のGNU Makefileを使用できます。

code: Makefile

.SUFFIXES: # Clear the suffix list

.SUFFIXES: .py .tmpl

%.py: %.tmpl

cheetah compile --nobackup $<

python -m compile $@

templates = $(shell echo \*.tmpl)

modules = $(patsubst %.tmpl,%.py,$(templates))

.PHONY: all

all: $(modules)

注意：Makefileは、スペースではなくタブでインデントする必要があります。

2. Pythonインポートを無効にして、インポートフックを使用してCheetahを* .tmplファイルから直接インポートします。

コード例：

code: python

from Cheetah import ImportHooks

ImportHooks.install()

import sys

sys.path.insert(0, 'path/to/template_dir') # or sys.path.append

importHooksは、*。pyc、*。py、および* .tmplからインポートしようとします-最初に見つかったものは何でも。 ImportHooksは、*。tmplを* .pyおよび* .pycに自動的にコンパイルします。

Makefile

プロジェクトに複数のテンプレートがあり、「cheetah compile FILENAME.tmpl」と常に入力することにうんざりしていて、いつ入力するコマンドを覚えていない場合は、システムで{make}コマンドを使用できるようにすることを検討してください。 生活が楽になります。

これは、ErrorsTemplateとInquiryTemplateの2つのテンプレートを制御する単純なMakefileです。 {inquiry}と{receive}の2つの外部コマンドは、ErrorsTemplate.pyに依存しています。 さらに、InquiryTemplate自体はErrorsTemplateに依存しています。

code: Makefile

all: inquiry receive

.PHONY: all receive inquiry printsource

printsource:

a2ps InquiryTemplate.tmpl ErrorsTemplate.tmpl

ErrorsTemplate.py: ErrorsTemplate.tmpl

cheetah compile ErrorsTemplate.tmpl

InquiryTemplate.py: InquiryTemplate.tmpl ErrorsTemplate.py

cheetah compile InquiryTemplate.tmpl

inquiry: InquiryTemplate.py ErrorsTemplate.py

receive: ErrorsTemplate.py

マルチスレッドアプリケーションでのCheetahの使用

排他制御のためにロックを使用してテンプレートのレンダリングをシリアル化し、2つのスレッドが同時にテンプレートをレンダリングするのを防ぐようにします。

スレッドセーフな機能を回避します。

1つのスレッドでこれらに変更が加えられると、他のスレッドでも表示されるため、出力に一貫性がなくなります。

gettextでCheetahを使用する

gettextをCheetahとともに使用すると、CJK文字セットの場合でも、国際化されたアプリケーションを作成できますが、次の点に注意する必要があります。

xgettextは、テンプレート自体ではなく、コンパイルされたテンプレートで使用されます。