Turbine における Python のサポート / Turbine Python Support

Turbine has support for creating assemblers (see the specifications) with Python, by making use of JPython technology.

Turbine は、 JPython の技術を利用して、 Python でアセンブラを作る機能(仕様書[訳注:リンク修正]参照の事) をサポートしています。

The first question that comes to mind is why one would want do to something like this. Here are some of the reasons you might want to do this:

最初に浮かぶ疑問は、誰かがこのようなことを何故したがるのかということです。 あなたがやってみたくなるような幾つかの理由を以下に述べます:

  • Python is an interpreted language which means that you do not have to recompile and copy a new jar each time you make changes.
  • Python はインタプリタ型言語です。 即ち、あなたが変更するたびに新しい jar ファイルを再コンパイルしコピーする必要がありません。
  • Although Python is interpreted it is compiled to java bytecode. Performance is on par with native java code.
  • Python はインタプリタにより解釈実行されますが、 Java バイトコードにコンパイルされます。 処理速度はネイティブなJavaコードと遜色ありません。
  • Python is very easy to learn. This, together with the fact that you don't need to use a compiler, makes it possible for people with little java experience to create screens.
  • Python は簡単に学べます。 コンパイラを使う必要が無いという事実とあわせて、 これにより Java の経験があまり無い人でもスクリーンを作ることが可能となるのです。
  • You can rapidly build a prototype using python, and later on find that it is not necessary to systematically move to java :-)
  • Python により、ごく短期間でプロトタイプを実装でき、 やがて、機械的に Java へ移植する必要は無いと気づくでしょう。:-)

Turbine への Python のセットアップ / Setting Up Python for Turbine

The first thing is to download JPython from www.jpython.org and copy the jpython.jar file into your turibe/lib directory. Now you need to prepare and compile the jpython files like this: build prepare-python build jar This will create a new turbine library that contains the Python code. You need to copy this new .jar file to your application's lib directory.

最初に、JPython を www.jpython.org よりダウンロードし、 jpython.jar ファイルを turbine/lib ディレクトリにコピーします。 そして次のように jpython の準備およびコンパイルをします: build prepare-python build jar これにより Python コードの含まれた新しい Turbine ライブラリが 作成されます。この新しい .jar ファイルを、あなたのアプリケーションの lib ディレクトリにコピーしなければいけません。

Now we need to edit the TurbineResources.properties. Add the following keys to your application's properties:

次に TurbineResources.properties を編集します。あなたのアプリケーションのプロパティに次に述べるキーを加えます:

services.AssemblerBrokerService.assembler.screen=
org.apache.turbine.util.assemblerbroker.python.PythonScreenFactory
services.AssemblerBrokerService.assembler.action=
org.apache.turbine.util.assemblerbroker.python.PythonActionFactory

services.AssemblerBrokerService.python.path=/path/to/python

The first two registers the Python Assembler Factories with the AssemblerBrokerService. The last line tells the Python interpreter where to find all the .py files for your application.

最初の2つは Python Assembler Factory を AssemblerBrokerService に 登録します。 最後の行は、あなたのアプリケーションで、 全ての .py ファイルが探す Python インタプリタの場所を示します。

In the root of your services.AssemblerBrokerService.python.path you need to add a file named config.py that looks like this:

services.AssemblerBrokerService.python.path で指定した ディレクトリのすぐ下に、後述のような 内容の config.py という名前のファイルを置かなければなりません。

import java

from java.io import *
from java.util import *

sys.add_package("org.apache.turbine.modules.screens")
sys.add_package("org.apache.turbine.modules")
sys.add_package("org.apache.turbine.util.db")
sys.add_package("org.apache.turbine.util")
sys.add_package("org.apache.turbine.services.security.TurbineSecurity")
sys.add_package("org.webmacro.servlet")


from org.apache.turbine.modules.screens  import WebMacroSiteScreen
from org.apache.turbine.modules          import Action
from org.apache.turbine.util.db          import Criteria
from org.apache.turbine.util             import RunData
from org.webmacro.servlet                import WebContext
from org.apache.turbine.services.security   import TurbineSecurity

JPython sometimes gets a bit confused with the Servlet Engine classloader, which forces us to call sys.add_package for each java package that we wish to use in our Python code. You also need to import all the classes that you wish to use explicitly. You needn't add the classes here, but it avoid some duplicate declarations at the top of each screen/action.

JPython は、 あなたの Python プログラム中で使いたい個々の Java パッケージに 対して、それぞれ sys.add_package を呼び出さなければならない 原因となる、サーブレットエンジンクラスローダーとちょっと混乱することがあります。 あなたが、明示的に使いたい全てのクラスもインポートする必要があります。 ここではクラスを加える必要はありませんが、各々の screen/action の 最初で、宣言が幾つか重複するのを避けます。

Turbine で Python を使う / Using Python with Turbine

To create python screens we use exactly the same methodology than for normal java screens. First you need a /screens subdirectory in your services.AssemblerBrokerService.python.path. This is where your screen code will live. Layouts goes in /layouts, actions in /actions and so forth (just remember to register the appropriate assembler factories).

Python でスクリーンを作るには、通常の Java でスクリーンを作るのと全く同じ方法論を使います。 最初に、services.AssemblerBrokerService.python.path に、 /screens サブディレクトリが必要です。 この場所は、あなたのスクリーンのプログラム存在する場所です。 そしてレイアウトは /layouts におき、アクションは /actions にそれぞれ置きます。(適切なアセンブラファクトリーを 登録するのを忘れないでください。)

I'm going to create a sample WebMacro screen. First we need a .py file where this screen can live. The .py file should have the same name as your .wm file and it must be all lower case. Inside this file we create a new class with the same name as the file, but in this the first letter is uppercase (the rest is always lower case). To override a method is fairly simple (just create a new method with the same name).

それでは、WebMacro のサンプルスクリーンを作ってみましょう。 最初に、このスクリーンの場所に .py ファイルが必要です。 .py ファイルは、.wm ファイルと同じ名前のものがなければならず、 全て小物でなければいけません。このファイルの中で、 ファイル名と同じ名前の新しいクラスを作りますが、 この最初の文字は大文字です。(残りは必ず小文字です) メソッドのオーバーライドは全くもって簡単です。 (単に、同じ名前の新しいメソッドを作るだけです)

There is one problem however - Python does not support method overloading based on type signatures, so usually the simplest for is used, which is doBuildTemplate( RunData data ) for WebMacroSiteScreen in stead of doBuildTemplate( RunData data, WebContext context ). You have two options to overcome this problem. (1) Create a new superclass that exposes a method under a different name or (2) just call getContext in your python code. I usually just go for the second option because it is fairly straight forward anyway.

しかしながら、一つ問題があります。 Python は型仕様に基づくメソッドのオーバーロードをサポートしていません。 通常は、簡略的に doBuildTemplate( RunData data ) を使い、 WebMacroSiteScreen には、 doBuildTemplate( RunData data, WebContext context ) を使ったりします。 これを克服するには 2 つの方法があります。 (1)別の名前で呼び出せるメソッドを出した、 新しいスーパークラスを作る。 (2)あなたの python のプログラム中で単に getContext を呼ぶ。 私の場合、通常は、素直な方法なので 2 番目の方法を使います。

Now for the code. Let's create a screen called Test. First create a test.wm file (I assumer everybody knows how to do this). Now create a test.py and place it in the python-path/screens directory. It should look something like this:

さて、プログラムに目を向けましょう。 Test という名前のスクリーンを作りましょう。 最初に、test.wm ファイルを作ります。 (みんなが作り方を知っていると想定してます。) そして、test.py を作り、python-path/screens ディレクトリに置きます。 このようなプログラムになります:

class Subjectslist(WebMacroSiteScreen):
   def doBuildTemplate (self,data):
        context = self.getContext(data)
        context.put ("me","Leon")
        context.put ("text","Python is cool");

For more information about the self parameter see the Python docs. You can call any java code that you would normally be able to use (just remember to add it to conf.py) including database, services, etc. You can also freely use any of the Python built-in types and any Python module that was built on 100% pure Python.

self のプロパティについて詳しく知りたければ、 Python のドキュメントを読んでください。 データベースやサービスなど、 通常使えるようなどんな Java コードでも呼び出すことができます (conf.py を加えるのを忘れないで下さい)。 100% 純粋な Python で作られているので、 さらに、どんな Python の組み込み型やモジュールも自由に使うことができます。