プラグインの概要

プラグインファイルは、環境設定ファイルで指定されたプラグインパス内の .py ファイルです。

コードのダウンロード先の src/examplePlugins フォルダには、サンプルプラグインがいくつか用意されています。これらは、生成された特定のイベントを検索して処理し、ShotGrid インスタンスの他の値を変更するための独自のプラグインを構築する方法の簡単な例を示します。

プラグインを更新するたびにデーモンを再起動する必要はありません。デーモンは、プラグインが更新されたことを検出して自動的に再ロードします。

プラグインがエラーを生成しても、デーモンがクラッシュすることはありません。プラグインは、再度更新されるまで無効になります(修正した場合も同様に動作するようリクエスト中)。その他のプラグインは引き続き実行され、イベントが処理されます。デーモンは、中断されたプラグインが正常に処理された最後のイベント ID を追跡します。プラグインが更新(および修正)されると、デーモンはプラグインを再ロードし、プラグインが終了した時点からイベントを処理しようとします。すべて正常に実行されると、デーモンは現在のイベントまでのプラグインを捕捉し、すべてのプラグインを通常のものとして使用してイベントを処理し続けます。

ShotGrid イベント処理プラグインは、コールバック登録関数と任意の数のコールバックという 2 つの主要な部分で構成されます。

registerCallbacks 関数

フレームワークによってロードするには、プラグインは少なくとも次の関数を実装する必要があります。

def registerCallbacks(reg):
    pass

この関数は、イベントを処理するために呼び出す関数をイベント処理システムに通知するために使用されます。

この関数は、1 つの引数を取る必要があり、それは Registrar オブジェクトです。

Registrar には非常に重要なメソッドが 1 つあります: Registrar.registerCallback

ShotGrid イベントを処理する必要がある関数ごとに、Registrar.registerCallback を、適切な引数で 1 回ずつ呼び出します。

関数は必要な数だけ登録できます。また、ファイル内のすべての関数をイベント処理コールバックとして登録する必要はありません。

コールバック

システムに登録されるコールバックは、次の 4 つの引数を取る必要があります。

追加情報について ShotGrid にクエリーする必要がある場合の ShotGrid 接続インスタンス。
レポートに使用する必要がある Python Logger オブジェクト。エラーメッセージと極めて重要なメッセージは、設定された任意のユーザに電子メールで送信されます。
処理する ShotGrid イベント。
コールバックの登録時に渡される args 値。(Registrar.registerCallback を参照)

ログ記録

イベントプラグインで print 文を使用することはお勧めしません。Python 標準ライブラリの標準ロギングモジュールを使用することをお勧めします。ロガーオブジェクトは、さまざまな関数に提供されます。

def registerCallbacks(reg):
    reg.setEmails('root@domain.com', 'tech@domain.com') # Optional
    reg.logger.info('Info')
    reg.logger.error('Error') # ERROR and above will be sent via email in default config

および

def exampleCallback(sg, logger, event, args):
    logger.info('Info message')

イベントフレームワークがデーモンとして実行されている場合、これはファイルに記録されます。それ以外の場合は stdout に記録されます。

堅牢なプラグインの構築

デーモンは ShotGrid に対してクエリーを実行しますが、find() コマンドが失敗した場合に再試行する機能が組み込まれているため、デーモン自体には一定の堅牢性があります。

https://github.com/shotgunsoftware/shotgunEvents/blob/master/src/shotgunEventDaemon.py#L456

プラグインにネットワークリソース(ShotGrid または他のリソース)が必要な場合は、独自の再試行メカニズムや堅牢性を提供する必要があります。ShotGrid アクセスの場合、デーモンの内容を確認して、プラグインにその機能を提供できるヘルパー関数またはクラスを作成することができます。

ShotGrid Python API は既にネットワークの問題に対してあるレベルの再試行を実行できますが、数分間実行される ShotGrid のメンテナンスウィンドウのタイミングにぶつかったり、ネットワーク障害が発生した場合、これでは十分ではない場合があります。

https://github.com/shotgunsoftware/python-api/blob/master/shotgun_api3/shotgun.py#L1554

プラグインの機能に応じて、イベントの処理中に問題が発生した場合に追跡を続けるために登録することもできます。registerCallback 関数の stopOnError 引数を参照してください。

https://github.com/shotgunsoftware/shotgunEvents/wiki/API#wiki-registerCallback

Edit this document