サルにもわかる Houdini: python py location

ここでは Houdini で Python (.py) ファイルを使う際のファイルの格納ディレクトリについて説明する。

使用ビルド: Houdini 22.0.465 (Win 11) ~~15.5.632 (Windows 7)~~

1. デフォルトパス

Houdini を起動、Python Shell (Windows->Python Shell または Alt+Shift+P) を開き、

>>> import sys
>>> sys.path

とすると、Houdiniがデフォルトで Python ファイルを見に行くディレクトリのリストが表示される(下記は見易さのために改行を挿入)。

['C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/python313/lib/site-packages-forced',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/python313/lib/site-packages-forced',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/python313/lib/site-packages-ui-forced',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/python313/lib/site-packages-forced',
'',
'C:\\Program Files\\Side Effects Software\\Houdini 22.0.465\\bin\\python313.zip',
'C:\\PROGRA~1\\SIDEEF~1\\HOUDIN~1.465\\python313\\DLLs',
'C:\\PROGRA~1\\SIDEEF~1\\HOUDIN~1.465\\python313\\Lib',
'C:\\Program Files\\Side Effects Software\\Houdini 22.0.465\\bin',
'C:\\PROGRA~1\\SIDEEF~1\\HOUDIN~1.465\\python313',
'C:\\PROGRA~1\\SIDEEF~1\\HOUDIN~1.465\\python313\\Lib\\site-packages',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/packages/shotbuilder/python3.13libs',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/packages/kinefx/python3.13libs',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/packages/apex/python3.13libs',
'C:/Users/ktaki//houdini22.0/python3.13libs',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/houdini/python3.13libs',
'C:/Program Files/Side Effects Software/sidefx_packages/SideFXLabs22.0/scripts/python',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/packages/texturepaint/viewer_states',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/packages/kinefx/viewer_states',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/packages/apex/viewer_states',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/houdini/viewer_states',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/packages/kinefx/viewer_handles',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/houdini/viewer_handles',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/python313/lib/site-packages',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/houdini/python3.13libs',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/python313/lib/site-packages',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/houdini/python3.13libs',
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.465/python313/lib/site-packages',
'C:/Program Files/Side Effects Software/sidefx_packages/SideFXLabs22.0/viewer_states']

上を見てわかるのは、別途設定がない場合 Houdini の Python は、

$HFS 以下の Python 関連ディレクトリを中心に見に行っている
~/houdini22.0/scripts などはパスに入っていない

ということがわかる。よって、カスタムスクリプトを自動的に読み込ませるためには下記の方法のいずれかを取る必要がある。

2. パスの追加

Houdini の Python が自動的に見に行くディレクトリは以下の方法で追加することが出来る。

2.1 python3.13libs (H22 または Py3.13 ビルドの場合)

HOUDINI_PATH で定義されているいずれかのディレクトリおよび HOME 以下に python3.13libs というディレクトリを作成すると、Houdini の Python は、それ以下を参照する。現実的なところとしては、

$HOUDINI_USER_PREF_DIR/python3.13libs
$HSITE/houdini22.0/python3.13libs: グループで共有する場合
$HOME/python3.13libs: *.py ファイルがあれば認識される

のいずれかとなる。(HSITE が C:\HoudiniFiles\ と定義されていて) 上記3つのディレクトリを作成、Houdini を再起動したのち、

>>> import sys
>>> sys.path

とすると、

...
'C:/Users/ktaki/python3.13libs',
'C:/Users/ktaki//houdini22.0/python3.13libs',
'C:/HoudiniFiles/houdini22.0/python3.13libs',
...

が追加されている。

2.2 PYTHONPATH

以下は Py2.7 のままだが、 Python の環境変数である PYTHONPATH が設定されている場合、Houdini の Python は自動的に認識する。例えば、(Windows で) C:\Python27\ 以下に Python 2.7 がインストールされていて、その下の C:\Python27\Lib\site-packages を参照する場合

システム環境変数として PYTHONPATH を追加、値をC:\Python27\Lib\site-packages とするか
$HOUDINI_USER_PREF_DIR/houdini.env に
```
PYTHONPATH = "C:/Python27/Lib/site-packages"
```
とする。

Houdini は再起動が必要だが、再び Python Shell を開き、

>>> import sys
>>> sys.path

とすると、今度は、PYTHONPATHで設定したディレクトリが追加されていることがわかる。

['C:/PROGRA~1/SIDEEF~1/HOUDIN~1.632/python27/lib/site-packages-ui-forced' 
'C:/PROGRA~1/SIDEEF~1/HOUDIN~1.632/python27/lib/site-packages-forced' 
'' 
'C:\\Python27\\Lib\\site-packages' 
...

2.3 コマンドで追加

コマンド経由で参照ディレクトリを追加することも可能。例えば、2.1 を見ると、 C:/HoudiniFiles/houdini22.0/python3.13libs (つまりは $HSITE/houdini22.0/python3.13libs) は存在するが、$HSITE/python3.13libs は存在しない。これを追加したい場合、Python Shell を開き、

>>> import sys os
>>> sys.path.append("%s/python3.13libs" % os.environ["HSITE"])

として

>>> sys.path

とすると、

...'C:/share/HoudiniFiles/python3.13libs']

と一番最後に append (追加) されたことがわかる。

2.4 pythonrc.py

2.1 までで設定したディレクトリのいずれにかに pythonrc.py というファイルを作成、その中で 2.3 で説明したコマンドを記述しておけば、毎回 Python Shell を開いてコマンドを実行しなくともディレクトリの追加が可能になる。例えば $HOME/houdini15.5/python2.7libs/pythonrc.py というファイルを作成、その中に

import sys os
sys.path.append("%s/python2.7libs" % os.environ["HSITE"])

とすれば、デフォルトにはない $HSITE/python2.7libs 以下が認識されるようになる。なお、pythonrc.py は、$HOUDINI_USER_PREF_DIR/scripts/python に配置することも可能。詳細はこちら。

3. py ファイルの実行

ここでは、timerX.py というビューポートの再生時間を計測する Python スクリプトを作成、上記のディレクトリのいずれかに配置し、実行する方法を説明する。

3.1 timerX.py

timerX.py の中身は以下の通り。

import hou
import time
global player_time
def outputPlaybarEvent(event_type, frame):
    if hou.playbarEvent.Started == event_type:
        global player_time
        player_time = time.time()
    elif hou.playbarEvent.Stopped == event_type:
        print time.time() - player_time

def go():
    hou.playbar.addEventCallback(outputPlaybarEvent)

このコードには def で定義された二つの関数があり、一つ目の関数 outputPlaybarEvent が実際の演算内容を定義し、二つ目の関数 go が実行方法を定義している。詳細は別の機会に。

3.2 実行

Houdini を起動し、例えば、sphere を作成して、PyroシェルフからFlames を追加、
最終フレームを 60なり、短めに設定する。
メインUI 右下のアニメーションループ設定を Loop から Play Once に変更。
Python Shell を開き、以下を一行ずつ実行
```
>>> import timerX
>>> timerX.go()
```
メインウィンドウの再生ボタンを押す。

3.3 スクリプト変更

毎回 Loop Once と自分で変更するのは面倒なので、このスクリプト実行時に、自動的に設定するようにしたい。その場合、

Houdiniは終了せずにテキストエディタで timerX.py を編集。
def go(): 以下を次の2行にして上書き保存。
```
def go():
    hou.playbar.setPlayMode(hou.playMode.Once)
    hou.playbar.addEventCallback(outputPlaybarEvent)
```
変更を確認するためにアニメーションループ設定を Loop に戻す。
Python Shell で reload(timerX)とすれば、スクリプトをもう一度読み込み変更が反映される。
```
>>> reload(timerX)
<module 'timerX' from 'C:/share/HoudiniFiles/python2.7libs\timerX.pyc'>
```
再び
```
>>> timerX.go()
```
としてから、再生ボタンを押せば、再生モードが自動的に Play Once に変更されたことがわかる。

サルにもわかる Houdini

2016-11-16

python py location