Python コンソール

Shotgun Python Console

Shotgun Toolkit の Python コンソール
最新バージョン: v1.1.1 (ベータ)
バージョン番号は、セマンティック バージョニング基準に従っています。
システム名: tk-multi-pythonconsole

注: このドキュメントは、Toolkit の設定を管理するユーザのみが使用可能な機能について説明します。詳細については、『Shotgun 統合ユーザ ガイド』を参照してください。
概要
ドキュメント
            パネル
            タブ
                  エディタ
                  出力
            ボタン
                  出力
                  エディタ
            グローバル
            外部ソース
            ホットキー
            その他の注意事項
インストール、更新、開発
設定オプション

このアプリケーションは、Toolkit のアプリケーションを実行する環境にインタラクティブな Python コンソールを提供します。

ドキュメント

これは、Python インタープリタにアクセスする DCC で使用するための Python コンソール パネルです。該当のインタープリタとのインタラクションが制限されている、またはそのサポートがない場合に使用します。

Shotgun Python Console
Photoshop CC 2017 の Python コンソール

Shotgun Python Console
Flame の Python コンソール

パネル

Maya にドッキングされたコンソール

インストールすると、コンソールはパネルとして DCC に登録され、Shotgun メニューで利用できるようになります。組み込みの Toolkit パネル(maya、nuke、houdini)をサポートするアプリでは、コンソールはドッキングされたパネルに表示されます。古いバージョンの DCC またはパネルをサポートしない DCC で使用する場合、コンソールは通常の Toolkit ダイアログとして表示されます。

タブ

タブ

Python コンソールには 1 つまたは複数のタブが表示され、それぞれエディタと出力ウィンドウが含まれています。右下隅にある + ボタンをクリックすると、新しいタブを作成できます。タブ名の横には x ボタンがあり、タブを削除できます。タブ自体をダブルクリックすると、タブの新しい名前を入力するよう求められます。タブの配置はドラッグ アンド ドロップによって変更することができます。DCC を閉じるときにタブの状態が保存され、次回の起動時に復元されます。

エディタ

エディタ

コンソールには、Python を編集するための入力領域があります。エディタには行番号が含まれ、カーソルの現在の行を強調表示し、またいくつかの基本構文を強調表示します。コンソールは DCC のパレットを使用して統合されたルック アンド フィールを提供しようとします。

出力

出力

出力領域には実行した Python の結果が表示されます。ソースの Python コマンド エコーは既定でオンになっており、>>> で始まるので出力画面で区別できます。各実行にはタイムスタンプも付けられます。エコーをオフにするためのトグルがあります。構文およびランタイム エラーは、デバッグ用の完全なスタック トレースとともに赤色で表示されます。

ボタン

ボタン

出力

  • [クリア](Clear) - 出力ブラウザの内容をクリアします。
  • [エコー](Echo) - 実行されたコマンドを出力ブラウザにエコーするかどうかを切り替えます。

エディタ

  • [実行](Execute) - エディタの内容を実行します。
  • [保存](Save) - エディタの現在の内容をファイルに保存します。
  • [開く](Open) - エディタでファイルを開きます。
  • [クリア](Clear) - エディタの内容をクリアします。
  • [行番号](Lines) - 現在のタブの行番号を切り替えます。

グローバル

グローバル

一部の Shotgun/Toolkit グローバルは、シェルの Shotgun エンジンで利用可能なグローバルと同様、コンソールにあらかじめ定義されています。

  • Tk API ハンドルは tk 変数を介して利用できます
  • Shotgun API ハンドルは shotgun 変数を介して利用できます
  • 現在のコンテキストは context 変数に格納されます
  • シェル エンジンは engine 変数を介してアクセスできます

外部ソース

アプリには、外部ロケーションから Python ソースをロードするために実装できるフックが付属しています。フックは external_sources_hook と呼ばれ、使用するには get_external_source_actions というメソッドを実装する必要があります。このメソッドは、QActions のリストを返し、アクションがトリガされると新しいタブが(コンテンツとともに)コンソールに追加されます。事前定義されたユーザのリストのために github から gist をロードする実装例が提供されます。フックによって返されるアクションは、[開く](Open)ボタンを押し続けると表示されるポップアップ メニューに表示されます。

外部ソース

ホットキー

  • Ctrl + Enter で選択内容を実行
  • Ctrl + T を押して新しいタブを作成
  • Ctrl + Shift + [ または Ctrl + Shift + ] でタブ間を移動
  • Ctrl + Wheel によって入力/出力フォントのサイズを調整

注: これらのホットキーはすべての DCC で使用できるわけではありません。

その他の注意事項

  • 一部の古いバージョンの DCC では、セッションを閉じるときに Python コンソールを開いたままにしておくとクラッシュする可能性があります。これは一部の古いバージョンの PySide のバグの可能性があります。新しいバージョンの PySide にバンドルされている最新バージョンの DCC は終了時にクラッシュしないようです。最新の DCC リリースでこの問題が発生する場合は、チケットを送信して、当社がさらに調査できるようにご協力ください。

インストールと更新

Shotgun Pipeline Toolkit にこのアプリを追加する

Project XYZ にこのアプリを追加するには、asset という名前の環境で次のコマンドを実行します。

> tank Project XYZ install_app asset tk-maya tk-multi-pythonconsole

最新バージョンに更新する

この項目が既にプロジェクトにインストールされている場合に最新バージョンを取得するには、update コマンドを実行します。特定のプロジェクトに含まれている tank コマンドに移動し、そこでこのコマンドを実行します。

> cd /my_tank_configs/project_xyz
> ./tank updates

または、tank コマンドを実行し、プロジェクトの名前を指定して、更新チェックを実行するプロジェクトを指定します。

> tank Project XYZ updates

コラボレーションと発展

Shotgun Pipeline Toolkit にアクセスできる場合は、すべてのアプリ、エンジン、およびフレームワークのソース コードにも Github からアクセスできます。これらは Github を使用して格納および管理しています。これらの項目は自由に発展させてください。さらなる独立した開発用の基盤として使用したり、変更を加えたり(その際はプル リクエストを送信してください)、いろいろと研究してビルドの方法やツールキットの動作を確認してください。このコード リポジトリには https://github.com/shotgunsoftware/tk-multi-pythonconsole からアクセスできます。

特殊な要件

  • 上記の操作を行うには、Shotgun バージョン v6.2.0 以降が必要です。
  • 上記の操作を行うには、Shotgun Pipeline Toolkit Core API バージョン v0.16.32 以降が必要です。

環境設定

以下に、使用するすべての環境設定の概要を示します。これらの設定は、このアプリまたはエンジンを有効にするための環境設定ファイルで定義する必要があります。

external_sources_hook

タイプ: hook

既定値: {self}/external_sources.py

説明: 新しいタブの外部ソースに関する情報を提供します。

フォローする

0 コメント

ログインしてコメントを残してください。