Cheetah:ディレクティブ

#set $adj = 'small'

#end if

または、Pythonの1行に相当する記述 A and B or Cという記述もできます。この場合、Bは真値でなければならないことに注意してください。

繰り返しますが、真値は、ゼロ(0)、None、空の文字列(‘’)、空のリスト([])、空の辞書({})以外のものを言います。

code: html

#set $adj = $size > 1500 and 'large' or 'small'

注意：Cheetahの1行表記の#ifは、変数を設定するのではなく出力を生成するため、このようには機能しません。

拡張代入演算子を使用することもできます。

code: html

## Increment $a by 5.

#set $a += 5

デフォルトでは、globalアトリビュートを使用しない限り、#set 変数はメソッド呼び出しまたはインクルードファイルに表示されません。例：#set global $var = EXPRESSION

グローバル変数は、すべてのメソッド、ネストされたテンプレート、およびインクルードされたファイルに表示されます。この機能は、予期しない事態を防ぐために注意して使用してください。

#del

書式

#del $var

#delは#setの反対の挙動を示すものです。設定されているローカル変数を削除します。その使用法は、Pythonのdel文と同じです。

code: html

#del $myVar

#del $myVar, $myArray5

削除できるのはローカル変数のみです。 #set global 変数、searchList変数、またはその他のタイプの変数を削除することはできません。

#attr

書式

#attr $var = EXPR

#attr}ディレクティブは、生成されたPythonクラスにクラスアトリビュートを作成します。数字や文字列などの単純なPythonリテラルを割り当てるために使用する必要があります。特に、式はsearchListの値または#set 変数に依存する必要があります。これらはコンパイル時に認識されないためです。

code: html

#attr $title = "Rob Roy"

#attr $author = "Sir Walter Scott"

#attr $version = 123.4

このテンプレートまたは任意の子テンプレートは、次のように値を出力できます。

code: html

$title, by $author, version $version

テンプレートがテンプレートモジュール（*.py)にコンパイルされていると仮定すると、

etexts から派生したテンプレートのライブラリがある場合は、タイトルと作成者を抽出してデータベースに配置できます。

#def

書式

#def METHOD(ARGUMENTS)

#end def

#def METHOD(ARGUMENTS) : TEXT_AND_PLACEHOLDERS

#defディレクティブは、生成されたPythonクラスで新しいメソッドを定義するため、またはスーパークラスメソッドをオーバーライドするために使用されます。これは、Pythonのdef文に類似しています。ディレクティブ自体は出力を生成しません。ただし、メソッドが後で$変数によって呼び出されるたびに、メソッドのコンテンツが出力（および実行されるディレクティブ）に挿入されます。

code: html

#def myMeth()

これはサンプルのメソッドのテキストです

$a $b $c(123) ## これらの変数名は他の場所で定義されています

#end def

## メソッドの使用

$myMeth()

引数と括弧は省略できます。

code: html

#def myMeth

これはサンプルのメソッドのテキストです

$a $b $c(123)

#end def

## メソッドの使用

$myMeth

Pythonの場合と同様に、メソッドには引数を指定でき、それらの引数のデフォルトを設定できます。変数名の前の$を忘れないようにしてください。

code: html

#def myMeth($a, $b=1234)

これはサンプルのメソッドのテキストです

$a - $b

#end def

## メソッドの使用

$myMeth(1)

この最後の例からの出力は次のようになります。

code: html

これはサンプルのメソッドのテキストです

1 - 1234

#defディレクティブの1行バージョンもあります。 {複数行のディレクティブとは異なり、コロン（:)を使用してメソッドのシグネチャと本文を区切ります。

code: html

#attr $adj = 'trivial'

#def myMeth: これは $adj メソッドです

$myMeth

先頭と末尾の空白はメソッドから削除されます。これは、以下とは対照的です。

code: html

#def myMeth2

これは $adj メソッドです

#end def

ここで、メソッドには'メソッドです'の後に改行が含まれます。改行が必要ない場合は、#slurpを追加します。

code: html

#def myMeth3

これは $adj メソッドです#slurp

#end def

#defはコンパイル時に処理されるため、それを呼び出すプレースホルダーの上または下に表示される可能性があります。また、スーパークラスプレースホルダーがサブクラスでオーバーライドされたメソッドを呼び出す場合、呼び出されるのはサブクラスメソッドです。

#block ... #end block

#blockディレクティブを使用すると、サブクラスで選択的に再実装できるテンプレートのセクションにひとつの単位として扱うことができます。全体をコピーして貼り付けて編集しなくても、テンプレートの一部を変更するのに非常に便利です。ブロックを使用するテンプレート定義からの出力は、#block ... #endblock ディレクティブが削除された同じテンプレートからの出力と同じになります。

注意：一般的な単語の blockと混同しないようにしてでください。

これは、何かの文字列#TAG ... #end TAG ペア内のコードのセクションを意味します。

したがって、ifブロック、forブロック、defブロック、blockブロックなど。

ここでは、blockブロックについてのみ説明します。

ブロックを再実装するには、#defディレクティブを使用します。この効果は、再実装の場所ではなく、元のブロックが定義された時点に戻って出力テキストを変更するように見えることです。

code: html

#block testBlock

コンテンツのテキスト

ブロックディレクティブの領域

#if $testIt

$getFoo()

#end if

#end block testBlock

必要に応じて、#endblockディレクティブでブロック名を繰り返すかどうかを指定できます。

#blockディレクティブは任意の深さにネストできます。

code: html

#block outerBlock

外側のブロック（outerBlock)の内容

#block innerBlock1

内側のブロック(innerBlock1)の内容

#end block innerBlock1

#block innerBlock2

内側のブロック(innerBlock2)の内容

#end block innerBlock2

#end block outerBlock

#endblockディレクティブのブロック名はオプションであることに注意してください。

技術的には、#blockディレクティブは、#defディレクティブの直後の同じ名前のブロック名が続くことと同等です。実際、これはCheetahが内部で処理していることです。つまり、テンプレートの他の場所で $ブロック名を使用して、ブロックコンテンツを再度出力できます。

1行の#defに類似した1行の#block構文があります。

ブロックは引数を必要とするべきではありません

外部ファイルの取り込み

#include

書式

#include raw FILENAME_EXPR

#include raw source=STRING_EXPR

#includeディレクティブは、テンプレート定義の外部からのテキストを含めるために使用されます。テキストは、外部ファイルまたは$変数から取得できます。 Cheetahは、外部ファイルを操作するときに、含まれているファイルへの変更を監視し、必要に応じて更新します。

この例は、外部ファイルでの使用法を示しています。

code: html

#include "includeFileName.txt"

読み込まれる FileName.txtの内容は、Cheetah によって解析されます。

次の例は、$変数で読み込むファイル名を与える方法を示しています。

code: html

#include source=$myParseText

$myParseTextの値は、Cheetahによって解析されます。これは、テンプレート定義に変数タグ

$ myParseTextを単に配置することと同じではありません。後者の場合、$myParseTextの値は解析されません。

デフォルトでは、含まれているテキストはCheetahタグ用に解析されます。 raw=引数を使用して、解析を抑制することができます。

code: html

#include raw "includeFileName.txt"

#include raw source=$myParseText

Cheetahは、ネストされたTemplateオブジェクト内に#includeテキストの各チャンクをラップします。ネストされた各テンプレートには、メインテンプレートのsearchListのコピーがあります。ただし、set変数は、#set globalキーワードを使用して定義されている場合にのみインクルード全体に表示されます。

すべてのディレクティブは、インクルードファイルでバランスを取る必要があります。つまり、インクルード内で#forまたは#ifブロックを開始する場合は、同じインクルードで終了する必要があります。

#import と #from

書式

#import MODULE_OR_OBJECT as NAME ...

#from MODULE import MODULE_OR_OBJECT as NAME ...

#impor}および#fromディレクティブは、外部Pythonモジュールまたはオブジェクトをプレースホルダーで使用できるようにするために使用されます。構文はPythonのインポート構文と同じです。インポートされたモジュールは、生成されたPythonクラスのすべてのメソッドにグローバルに表示されます。

code: html

#import math

#import math as mathModule

#from math import sin, cos

#from math import sin as _sin

#import random, re

#from mx import DateTime # ## Part of Egenix's mx package.

上記のインポートの後、$math、$mathModule、$sin、$cos、$_sin、$random、$ re、$DateTimeを$変数と式が利用することができます。

すべてのテンプレートはCheetah.Template.Templateのサブクラスです。ただし、テンプレートが別のテンプレートまたは純粋なPythonクラスをサブクラス化することは可能です。これは、#extends がステップインする場所です。親クラスを指定します。

Cheetahは、まだインポートしていない場合、#extendsディレクティブに記載されているクラスを自動的にインポートします。暗黙的なインポートは次のように機能します。

code: html

#extends Superclass

## 暗黙的に '#from Superclass import Superclass'　と同じ

#extends Cheetah.Templates.SkeletonPage

## 暗黙的に '#from Cheetah.Templates.SkeletonPage import SkeletonPage'　と同じ

#extends

書式

#extends

スーパークラスが通常とは異なる場所にある場合、またはクラスとは異なる名前のモジュールにある場合は、明示的にインポートする必要があります。インポートされていないクラスからの拡張はサポートされていません。たとえば、文字列から動的に作成されたテンプレートから。親テンプレートをモジュールに取り込む最も実用的な方法はそれをプリコンパイルすることであるため、すべての親テンプレートは基本的にプリコンパイルする必要があります。

テンプレートには#extendsディレクティブを1つだけ含めることができ、クラスを1つだけリストすることができます。つまり、テンプレートは多重継承を行いません。これは意図的なものです。テンプレート内から複数の基本クラスを正しく初期化するのは非常に困難です。ただし、純粋なPythonクラスで多重継承を行うことができます。

純粋なPythonクラスが__ init__()やawake()などの標準のTemplateメソッドのいずれかをオーバーライドする場合は、必ずメソッドでスーパークラスメソッドを呼び出すようにしてください。そうしないと問題が発生します。スーパークラスメソッドの呼び出し例は、セクションtips.callingSuperclassMethodsにあります。

いずれの場合も、ルートスーパークラスはTemplateである必要があります。最下位のクラスがテンプレートの場合は、その中の#extendsを省略するだけで、Templateから自動的に継承されます。最下部のクラスが純粋なPythonクラスである場合、Templateから明示的に継承する必要があります

code: python

from Cheetah.Template import Template

class MyPurePythonClass(Template):

# ..

PythonクラスをTemplateから継承することに関心がない場合は、クラスとTemplateの両方から継承する小さなグルークラスを作成します。

例を示す前に、Cheetahが継承ツリーをどのように構成するかを、指示しないことを強調します。上記のルールに従う限り、多くの構造が可能です。

これは、一般的なサイトテンプレートだけでなく、サイトのこのセクションのテンプレートと、各URLの特定のテンプレートサーブレットを含む大規模なWebサイトの例です。各テンプレートは、テンプレートで使用されるメソッド/属性を含む純粋なPythonクラスから継承します。最下位のスーパークラスから始めて、特定のテンプレートサーブレットで終わります。

code: html

1. SiteLogic.py (サイトのためのメソッドを含むPythonで実装されたクラス)

from Cheetah.Template import Template

class SiteLogic(Template):

2. Site.tmpl/py (一般的なサイトフレームワークを含むテンプレート。

これは出力を制御するテンプレートです。

<HTML> <HEAD> ...を含むもの、

＃def /＃blockの外側にテキストを含むもの)

#from SiteLogic import SiteLogic

#extends SiteLogic

#implements respond

3. SectionLogic.py (セクションのヘルパーコード含むPythonで実装されたクラス)

from Site import Site

class SectionLogic(Site)

4. Section.tmpl/py (セクションの#defオーバーライドなどを含むテンプレート)

#from SectionLogic import SectionLogic

#extends SectionLogic

5. page1Logic.py (テンプレートサーブレットのヘルパーコードを含むPythonで実装されたクラス)

from Section import Section

class indexLogic(Section):

6. page1.tmpl/py (テンプレート-サイトの特定のページのサーブレット)

#from page1Logic import page1Logic

#extends page1Logic

純粋なPythonクラスには、直接の子テンプレートでは使用されないが、必要に応じて子孫テンプレートで使用できるメソッド/アトリビュートが含まれている場合もあります。たとえば、サイトテンプレートには、サイト管理者の名前と電子メールアドレスの属性があり、必要なテンプレートで$変数としてすぐに使用できます。

#extendsを使用する場合は常に、上記の手順2のように#implementsも必要になることがよくあります。次のセクションを読んで、#implements とは何か、いつ使用するかを理解してください。

#iimplements

#defまたは#blockメソッドを直接呼び出して、その出力を取得できます。トップレベルのコンテンツ（#def / #blockの外側にあるすべてのテキスト/プレースホルダー/ディレクティブ）は連結され、デフォルトでrespond()メソッドにラップされます。したがって、respond()を呼び出すと、テンプレート全体の出力が得られます。したがって、Webwareが respond() を呼び出すと、テンプレート全体が出力されます。また、テンプレートインスタンスでprint()またはstr(t)を実行すると、Cheetahが __str__()メソッドが呼び出されるメソッドのエイリアスにするという事実を利用しています。

それはすべて問題ありませんが、アプリケーションが respond() ではなく別のメソッド名を呼び出すことを好む場合はどうでしょうか。たとえば、代わりに send_output() を呼び出したい場合はどうなりますか？そこで #mplements がステップインします。これにより、メインメソッドの名前を選択できます。これをテンプレート定義に入れるだけです：

code: html

#implements send_output

あるテンプレートが別のテンプレートを拡張する場合、継承チェーン内のすべてのテンプレートには独自のメインメソッドがあります。テンプレートに入力するには、これらのメソッドの1つだけを呼び出し、他のメソッドは無視されます。呼び出すメソッドは、アプリケーションの構造に応じて、継承チェーン内の任意のテンプレート（ベーステンプレート、リーフテンプレート、またはそれらの間）に含めることができます。したがって、2つの問題があります。（1）正しいメソッド名を呼び出すことと、（2）不要な同じ名前のサブクラスメソッドが呼び出したいメソッドをオーバーライドできないようにすることです。

Cheetahは、呼び出すメソッドがrespond()であると想定しています。これは、Webwareが呼び出すものだからです。#blockで適切に機能するため、目的のメソッドが最下位レベルのベーステンプレートのメソッドであると想定します。したがって、#extends を使用すると、Cheetahはそのテンプレートのメインメソッドを writeBody()に変更して、邪魔にならないようにし、ベーステンプレートのrespond() をオーバーライドしないようにします。

残念ながら、テンプレートが他の方法で使用されている場合、この仮定は破綻します。たとえば、最高レベルのリーフテンプレートでメソッドを使用し、ベーステンプレートを単なるメソッド/属性のライブラリとして扱いたい場合があります。その場合、リーフテンプレートは、メソッド名をrespond()（またはアプリケーションが呼び出したいもの）に戻すために#implementsrespondが必要です。同様に、メインメソッドが継承チェーンの中間テンプレートの1つにある場合、そのテンプレートには#mplementsresponseが必要です。

仮定が崩れるもう1つの方法は、ベーステンプレートのメインメソッドであるが、そのテンプレートが純粋なPythonクラスを拡張する場合です。 Cheetahは#extendsを確認し、メソッドの名前をwriteBody() に忠実に、しかし誤って変更するため #implementsrespond を使用して元に戻す必要があります。それ以外の場合は、Cheetah.Template内のダミーのrespond()が見つかり、何も出力されません。したがって、#extends を使用していて出力が得られない場合、{最初の}ことを考える必要があります。

制御構造

制御構造とは、プログラムのフロー制御をするすべてのものを指します。

Cheetah では次のフロー制御をサポートしています。

#for ... #end for

{#for}ディレクティブはシーケンスを繰り返し処理します。構文はPythonと同じですが、変数の前のシャープ記号($)を忘れないようにしてください。

書式

#for $var in EXPR

#end for

次のテンプレートは#forの簡単な例です。

code: html

<TABLE>

#for $client in $service.clients

<TR>

<TD>$client.surname, $client.firstname</TD>

<TD><A HREF="mailto:$client.email" >$client.email</A></TD>

</TR>

#end for

</TABLE>

辞書のキーと値をループする方法は次のとおりです。

code: html

<PRE>

#for $key, $value in $dict.items()

$key: $value

#end for

</PRE>

ハイフンで区切られた番号のリストを作成する方法は次のとおりです。この#endforタグは、各ハイフンの後に改行文字が導入されないように、最後の行を共有します。

code: html

#for $i in range(15)

$i - #end for

{#end for} の場所がインデンテーションの妥当性を損なう場合は、代わりに次のようにすることができます。

code: html

#for $i in $range(15)

$i - #slurp

#end for

前の2つの例では、最後の番号の後に余分なハイフンを配置します。 #setディレクティブを使用して、この問題を回避する方法を次に示します。これについては、以下で詳しく説明します。

code: html

#set $sep = ''

#for $name in $names

$sep$name

#set $sep = ', '

#end for

文字列の間にセパレータを配置するだけですが、forループは必要ありません。

code: html

#echo ', '.join($names)

#repeat ... #end repeat

特定の回数何かをします。引数は任意の数式にすることができます。ゼロまたは負の場合、ループはゼロ回実行されます。

書式

#repeat EXPR

#end repeat

次のテンプレートは#repeatの簡単な例です。

code: html

#repeat $times + 3

She loves me, she loves me not.

#repeat

She loves me.

ループ内では、どの反復を行っているかを判断する方法はありません。カウンター変数が必要な場合は、Pythonのrange()関数で代わりに#forを使用してください。 Pythonの範囲はデフォルトでベース0であるため、1からカウントを開始する方法は2つあります。1から5までカウントしたいとし、$countは5です。

code: html

#for $i in $range($count)

#set $step = $i + 1

$step. Counting from 1 to $count.

#end for

#for $i in $range(1, $count + 1)

$i. Counting from 1 to $count.

#end for

以前の実装では、繰り返しカウンターとしてローカル変数{$ i}を使用していました。ただし、これにより#repeat のインスタンスがネストされなくなりました。現在の実装では #repeat のすべてのインスタンスに新しいローカル変数を使用するため、この問題は発生しません。

#while ... #end while

#whileはPythonのwhile文と同じです。その後に任意のブール式を続けることができます。

書式

#while EXPR

#end while

次のテンプレートは#whileの簡単な例です。

code: html

#while $someCondition('arg1', $arg2)

条件式は真値

#end while

無限ループを作成しないように注意してください。 #while 1は、コンピュータのメモリが不足するまでループすることになります。

#break と #continue

これらのディレクティブは、Pythonと同様に使用されます。 #breakは#forループを途中で終了しますが、#continueはすぐに#forループの次の反復にジャンプします。

書式

#break

#continue

この例では、出力リストに10 - は含まれません。

code: html

#for $i in range(15)

#if $i == 10

#continue

#end if

$i - #slurp

#end for

この例では、'Joe'に等しい名前が見つかるとループが終了します。

code: html

#for $name in $names

#if $name == 'Joe'

#break

#end if

$name - #slurp

#end for

#if ... #else if ... #else ... #end if

書式

#if EXPR

#else if EXPR

#elif EXPR

#end if

#ifディレクティブは、テキストの一部を条件付きで表示するために使用されます。 #ifと#elseifの後に条件式を続ける必要がありますが、# elseには不要です。有効なPython式はすべて許可されます。 Pythonと同様に、ゼロ(0)、空の文字列(‘’)、None、空のリスト([])、または空の辞書({})に評価されない限り、式は新値(True)です。 Pythonとは異なり、# elifは #elseif の同義語として受け入れられます。

ここではいくつかの例を示します。

code: html

#if $size >= 1500

大きい

#else if $size < 1500 and $size > 0

小さい

それら以外

#end if

code: html

#if $testItem($item)

The item $item.name is OK.

#end if

これは、#ifディレクティブと#forディレクティブを組み合わせた例です。

code: html

#if $people

<table>

<tr>

<th>Address</th>

<th>Phone</th>

</tr>

#for $p in $people

<tr>

<td>$p.address</td>

<td>$p.phone</td>

</tr>

#end for

</table>

<p> Sorry, the search did not find any people. </p>

#end if

1行での#if

書式

#if EXPR1 then EXPR2 else EXPR3#

フロー制御のための#ifディレクティブには、1行で記述する方法もあります。 EXPR1がTrueの場合、EXPR2を評価し、結果を出力します。（#echo EXPR2#と同様の結果）。 EXPR1がTrueでない場合は、EXPR3を評価し、その結果を出力します。このディレクティブでは不要な式は評価されません。

Python のif文でいうところのthenとelseの両方を含める必要があります。これがうまくいかない場合や、このスタイルが気に入らない場合は、複数行の#ifディレクティブを使用してください。

末尾の#は、通常のディレクティブの終端文字です。いつものように、同じ行のディレクティブの後に何もない場合は省略することができます。

#unless ... #end unless

書式

#unless EXPR

#end unless

#unlessは #if の反対の挙動をするものです。条件式が偽値(False)として評価される場合、テキストが実行されます。ときによりこれはとても便利です。

#unless EXPR は #if not(EXPR) と同等です。

code: html

#unless $alive

This parrot is no more! He has ceased to be!

'E's expired and gone to meet 'is maker! ...

THIS IS AN EX-PARROT!!

#end unless

#ifとは異なり、#unless構造内で#elseif または #else を使用することはできません。

書式

#passディレクティブはPythonのpassステートメントと同じです。何もしません。文が構文的に必要であるが、プログラムがアクションを必要としない場合に使用できます。

次の例は、$ Aのみが真の場合は何もしません

code: html

#if $A and $B

do something

#elif $A

#elif $B

do something

do something

#end if

#stopディレクティブは、特定の時点でテンプレートの処理を停止するために使用されます。出力には、その時点までに処理されたものだけが表示されます。

#stopが#include内で呼び出されると、インクルードされた残りのコードをスキップして、

＃includeディレクティブの後から続行します。含まれているコードの処理を停止します。同様に、#stopが#defまたは#block内で呼び出されると、#defまたは#blockのみが停止します。

code: html

猫が

#if 1

マットの上に座った

ネズミを見ている

#end if

姿勢を低くして

これは次のようにレンダリングされます。

code:html

猫が

マットの上に座った

次の例では。

code: html

猫が

#block action

マットの上に座った

ネズミを見ている

#end block

姿勢を低くして

出力は次のようになります。

code: html

猫が

マットの上に座った

姿勢を低くして

#return

これはPythonと同じように使用されます。 #returnは、デフォルトの戻り値Noneまたは指定された値で現在のメソッドを終了します。 #defまたは#block内でのみ使用できます。

書式

#return

#returnは、呼び出されたメソッドから出力されたすべてのテキストの合計を返す#stopディレクティブとは異なることに注意してください。次の例は、この点を示しています。

code: html

$test1

#def test

1.5

#if 1

#return '123'

99999

#end if

#end def

これは次のようにレンダリングされます。

code: html

一方次の例では。

code: html

$test

#def test

1.5

#if 1

99999

#end if

#end def

code: html

1.5

エラーハンドリグ

Cheetahでランタイムエラー（例外）を処理する方法は2つあります。 1つ目は、Pythonの構造化された例外処理ステートメントを反映するCheetahディレクティブを使用することです。 2つ目は、チーターのErrorCatcherフレームワークです。これらについて以下に説明します。

#try ... #except ... #end

#try ... #finally

#assert

Cheetahの例外処理ディレクティブは、Pythonの例外処理ステートメントを正確に反映しています。次のチーターコードは、それらの使用法を示しています。

code: html

$mightFail()

#except

It failed

#end try

#assert $x == $y

#except AssertionError

They're not the same!

#end try

#raise ValueError

#except ValueError

#end try

$mightFail()

#except ValueError

Hey, it raised a ValueError!

#except NameMapper.NotFound

Hey, it raised a NameMapper.NotFound!

It didn't raise anything!

#end try