Python で初めてスクリプトを記述する場合のヒントとコツ

Python ビルトインライブラリ

Python には、多数の便利なビルトインライブラリやデータ構造があります。一般的なプログラミングタスクに使用できる既存のライブラリが用意されているため、ほとんどの場合、MEL スクリプトと同様にカスタムユーティリティを作成する必要はありません。Python のビルトインライブラリに関する文書は、http://docs.python.org を参照してください。このサイトには、一般的な Python プログラミングの入門ガイドとして適したチュートリアルも提供されています。

Python クラスを使用したカスタム UI

使いやすい Python 関数の 1 つに functools.partial があり、これを使用するとコールバック関数に追加情報を渡すことができます。たとえば、次のクラスでは、クリックすると番号が出力されるボタンをいくつか含むウィンドウが作成されます。

from functools import partial
import maya.cmds as cmds
class ButtonWin(object):
   def __init__(self):
      self.win = cmds.window()
      self.layout = cmds.columnLayout(parent=self.win)
      for x in range(10):
         cmds.button(label="Click Here %d"%x, parent=self.layout,          command=partial(self.report,x))
         cmds.showWindow()
   def report(self,buttonIndex,value):
      print "button %d got %s"%(buttonIndex,value)
f = ButtonWin()

Maya で Python スクリプトをデバッグする

Python スクリプトの利点の 1 つに、開発段階でデバッガとして利用にできることが挙げられます。これによって、スクリプティングのトラブルシューティング時間を大幅に削減できます。

pdb で使用する

Python では、pdb モジュール内にビルトインデバッガが装備されています。pdb には、クィックデバッグセッションに適したテキストインタフェースがあります。スクリプトエディタ（Script Editor）からコールされたスクリプトで pdb を使用すると、pdb で入力が必要な場合には必ず入力ダイアログボックスが表示されます。pdb の使用方法はシンプルであり、次のようにインポートしてブレークポイントを設定します。

import pdb
pdb.set_trace()

2 行目まで実行すると入力ダイアログが表示されるので、標準コマンドを使用して作業を続行し、ステップイン、値の出力などを行います。

pdb に関する詳細文書は、 http://docs.python.org/library/pdb.html を参照してください。

外部デバッガで使用する

複雑なデバッグタスクの場合は、外部のグラフィカルデバッガを使用するほうが簡単でしょう。無償または市販の IDE には、以下のようなものがあります。

外部デバッガを使用して Maya に初めてユーティリティモジュールをインポートすると、IDE への通信ソケットが開きます。IDE が Maya に接続されたら、スクリプトファイルを開いてブレークポイントの設定や変数値の検査などができます。IDE ごとに独自に必要なワークフローがあります。詳細については、それぞれのマニュアルを参照してください。

Wing IDE を Maya で使用する

Windows で Wing IDE 3.1 を使用して Maya Python スクリプトのデバッグセッションを開始するには、以下の操作を実行します。

wingdbstub.py を Wing IDE インストールディレクトリから Maya Python スクリプトパスにコピーします。たとえば、C:\Program Files (x86)\Wing IDE 3.1\wingdbstub.py を C:\Users\<ユーザ名>\Documents\maya\scripts にコピーします。
Wing IDE の [Edit] > [Preferences] > [Debugger] で、[Enable Passive Listen] をチェックして、外部プロセスからの接続を許可します。ダイアログボックスが表示され、通信ポートを開く権限を要求されます。以下のようにしてこれを許可します。
Maya を起動して、Python スクリプトを確実にインポートして実行します。
Wing IDE でこのスクリプトを開きます。F9 を使用するか左端のマージンをクリックして、ブレークポイントを設定します。
Maya で Python ステートメントを実行します。
```
import wingdbstub
```
権限を要求する別の認証ダイアログボックスが表示されることがあります。以下のようにしてこれを許可します。
Wing IDE に戻り、Wing IDE のメインウィンドウの左下にあるステータスインジケータが緑色であることを確認します。これは、リモートデバッグ接続が確立され、 Maya が実行中であることを示します。
Maya で、ブレークポイントを含む Python 関数をコールします。ブレークポイントに到達すると、ステータスインジケータが、Maya が一時停止していることを示す黄色に変わります。実行する次のコード行が赤いラインで強調表示されます。
これで、Wing IDE のすべてのデバッグ機能を使用して、プログラムの状態を検査できるようになりました。F5 または緑色の再生ボタンを押すと、制御が Maya に戻ります。

注:

Wing IDE の使用方法の詳細については、ヘルプを参照してください。

Python 関数を MEL プロシージャとして登録する

createMelWrapper 関数を使用して、Python 関数を MEL プロシージャとして登録することができます。次に、MEL プロシージャをコールすると、Python 関数をコールし、これが受け取る引数を渡して関数の結果を返します。

この関数の詳細については、次の場所にある melutils.py ファイルを参照してください。

C:\Program Files\Autodesk\Maya2012\Python\lib\site-packages\maya\mel

または、スクリプトエディタ（Script Editor）で以下を実行します。

import maya.mel
help(maya.mel.createMelWrapper)

この関数の利点:

Python 関数を MEL プロシージャとして登録すると、プロシージャとスクリプトの名前が同じ場合でも、MEL スクリプトをソースとする必要がありません。これに比べ、Python を使用する場合は、スクリプトを明示的にインポートしなければ、これに含まれる関数またはクラスにアクセスできません。このラッパ（wrapper）関数を使用すると、Maya ではオンザフライでソースとすることができ、常にスクリプトごとにロードできるようにする必要がありません。
Maya の一部のアトリビュートでは、MEL プロシージャしか使用できません。たとえば、asset ノード（以前の container ノード）では、コンテナアトリビュート（Container Attributes）領域にあるRmb コマンド（Rmb Command）アトリビュートは、MEL プロシージャしか使用できません。

例

次の例は、createMelWrapper 関数を使用して Python 関数を MEL プロシージャとして登録し、Rmb コマンド（Rmb Command）アトリビュートを asset ノード（以前の container ノード）で使用する方法を示しています。

以下を Maya2012/scripts ディレクトリに rmbScript.py として保存します。

import maya.cmds as cmds
import maya.mel as mel
def exCoNotes(node):
    if(cmds.nodeType(node)=='container'):
       objCont = node 
    else:
       objCont = cmds.container(q=True, findContainer=node)
    exec(cmds.getAttr(objCont+'.notes'))
    pyfunction = 'main("'+node+'","'+objCont+'")'
    exec(pyfunction) 
    cmds.select(node, r=True)
def setThisContainerCurrent(node):
    if(cmds.nodeType(node)=='container'):
       objCont = node 
    else:
       objCont = cmds.container(q=True, findContainer=node)
    cmds.container(objCont, e=True, c=True)
    cmds.select(node, r=True)
def rmbMyContainerScript():
    return ("Execute Container Notes", "exCoNotes",
    "Set This Container Current", "setThisContainerCurrent")

スクリプトエディタ（Script Editor）の Python タブから以下を実行します。これによって、必要な MEL ラッパ（wrapper）スクリプトが作成されます。

from rmbScript import *
import maya.cmds as cmds
import maya.mel as mel
mel.createMelWrapper(rmbMyContainerScript,retType='string[]')
mel.createMelWrapper(exCoNotes)
mel.createMelWrapper(setThisContainerCurrent)

オブジェクトを作成します。
アセット > 高度なアセット > 作成（Assets > Advanced Assets > Create）を選択して、rmbMyContainerScript を asset の Rmb コマンド（Rmb Command）アトリビュートに追加します。
注:
このて銃手順は、トランスフォームを含むアセットにも使用できます。ただし、ノードタイプは dagContainer になります。
以下のコードと同様のものを、asset ノードの注（Notes）セクションに追加します。
```
def main(node, container):
    print node
    print container
```
スクリプトエディタ（Script Editor）で MEL タブに以下を入力します。
```
rehash;
```
オブジェクトをして、マーキングメニューからカスタム（Custom）を選択します。これで、カスタムの右マウスボタンメニューが表示されるようになります。詳細については、カスタムコマンドまたはメニューをアセットに割り当てるを参照してください。

アニメートしたカーブのキーフレームの作成

Python のサンプルスクリプトを使用して、アニメートしたカーブを作成してキーフレームを設定することができます。

import maya.OpenMaya as om
import maya.OpenMayaAnim as oma
def addkeys(plugName, times, values, changeCache):
   # Get the plug to be animated.
   sel = om.MSelectionList()
   sel.add(plugName)
   plug = om.MPlug()
   sel.getPlug(0, plug)
   # Create the animCurve.
   animfn = oma.MFnAnimCurve()
   animCurve = animfn.create(plug, oma.MFnAnimCurve.kAnimCurveTL)
   
   # Copy the times into an MTimeArray and the values into an    MDoubleArray.
   timeArray = om.MTimeArray()
   valueArray = om.MDoubleArray()
   for i in range(len(times)):
      timeArray.append(om.MTime(times[i], om.MTime.uiUnit()))
      valueArray.append(values[i])
   # Add the keys to the animCurve.
   animfn.addKeys(
      timeArray,
      valueArray,
      oma.MFnAnimCurve.kTangentGlobal,
      oma.MFnAnimCurve.kTangentGlobal,
      False,
      changeCache
   )

上記のサンプルコードでチャンネルにキーフレームアニメーション（つまりプラグ）が追加されます。変更内容を元に戻す必要がまったくない場合は、以下のようにコールします。

addkeys('pCube1.tx', [1.0, 3.0, 5.0], [0.6, 1.2, 2.4], None)

ただし、変更内容を元に戻せるようにしておく場合は、以下のようにコールします。

changeCache = oma.MAnimCurveChange()
addkeys('pCube1.tx', [1.0, 3.0, 5.0], [0.6, 1.2, 2.4], changeCache)

変更内容を元す場合は、以下の手順を実行します。

changeCache.undoIt()

注:

ここではわかりやすくするために、plugName で指定したプラグは現在アニメートされていないものとします。これは練習問題用で、この条件を不要にするために必要なチェックを追加することもできます。

一般的な情報メッセージ

dgInfo コマンドを使用して DG に関する情報を入手する場合、DIRTY BLOCK、DIRTY PROP といった情報メッセージが表示されることがあります。このメッセージの定義については、一般的な情報メッセージを参照してください。

ScriptJob を使用してユーザイベントを作成する

これは、Python スクリプトで、API コールを使用して行うことができます。以下の例は、myEvent という新しいユーザイベントタイプを登録する方法を示します。

import maya.OpenMaya as om
om.MUserEventMessage.registerUserEvent('myEvent')

イベントが発生するたびに myFunc という関数が実行されるようにするには、次を実行します。

def myFunc(data):
    print('Got a myEvent event!')
callbackId = om.MUserEventMessage.addUserEventCallback('myEvent', myFunc)

myEvent イベントを送信するには、次を実行します。

om.MUserEventMessage.postUserEvent('myEvent')

終了後にコールバック関数を削除するには、次を実行します。

om.MUserEventMessage.removeCallback(callbackId)