Dynamo/Python開発環境

皆さんはどのような環境でDynamo, Pythonを開発されていますか。

良いコードを作るには、良い環境が必要です。たぶん。

SBOでは、DynamoベースでPycharmを活用した環境で開発をしています。ここでは、その内容と構築方法を紹介します。

Python Scriptノード

まずは、Revit標準の開発環境について

Revitをインストールすると、Dynamoも使えるようになります。DynamoでPythonコードを記述する際は、Python Scriptノードを使用します。

ほとんどのユーザがこの環境からスタートすると思いますが、使い勝手は悪いと思います。

使い勝手が悪い例を２点挙げます。

１点目：Pythonエディタとしての性能が悪い: コードの整形やリファクタリングなどPython Scriptノードではできないことがとても多いです。Python用のテキストエディタを使うと、その違いをすぐに実感できます。
２点目：関数等の使いまわしが難しい: Python Scriptノードでは、作成した関数等を使いまわすことが難しいと思います。カスタムノードの機能を活用すればそれなりのことができるかもしれませんが、利便性は劣ります。

いずれPythonに慣れてきて、ノードを使用するよりもテキストコードの記述が多くなってくると、Python Scriptノードでのコーディングは非効率になってくると思います。

SBOの開発環境

ここからは、SBOの開発環境を紹介します。

Dynamoベースで開発しつつほぼPythonでコーディングする、という特殊な環境です。

エディタ・IDE

PythonエディタとしてPycharmを使用しています。正確にはエディタではなくIDEですね。

これを選んだ理由は、特にありません・・・。世間では、VS Codeが人気のようです。Dynamo Forumでもそのようですが、私はPycharmしか使ったことがありません。かなり気に入っているため、しばらく使い続けるつもりです。

以降は、PycharmをDynamoで活用するためのノウハウを紹介します。

全体構成

全体構成を示します。

実行用ファイルやモジュールは、Python形式のファイルです(拡張子が.py)。これらはすべてPycharmで作成します。

実行用ファイルは、Dynamoから直接アクセスする唯一のファイルです。Excel等の関連データとのやり取りは、実行用ファイルのみに記述します。

実行用ファイルは、ツールごとに作成します。一方、自作パッケージは、様々なツールで共有します。モジュール（自作の関数等）を容易に共有できることがこの開発環境のメリットの一つです。

エディタ使用時のDynamoグラフ

エディタを使う場合に使用するノードを紹介します。

ツールで実行したい処理はエディタでコーディングするため、ノードはほぼ使用しません。エディタでPython形式（.py）のファイルを作成し、Dynamoでそれを読み込んで実行する、という形になります。

グラフは下図のようになり、どのようなツールでもほぼ同じ構成になります。

各ノードの説明

File Pathノード: 実行用ファイルの場所を指定します。
File From Pathノード: パスをファイルに変換します。
FileSystem.ReadTextノード: ファイルを読み込んでテキストを出力します。
Python Script From Stringノード: 入力されたテキストをPython Scriptとして認識し、実行します。
IN[x]につながっているノード: Pythonを実行する際に入出力が必要であれば、例のようにIN[x]につなげます。必要によりノード数を増減します。
Watchノード: Dynamoプレーヤで実行結果を表示したい場合に使用します。

Pythonプロジェクトのディレクトリ構成

ディレクトリ構成も紹介しておきます。

”Python ディレクトリ構成”で検索すると様々な記事がでてきます。そして、どれも微妙に異なります。結局は、どんな開発をしたいかで変わるということのようです。

まだまだ勉強中ですが、現時点では以下の構成としています。

基本形と元ネタ

プロジェクト構成は、以下を基本とします。元ネタのリンク先も示します。

packaging_tutorial/  # プロジェクト名（pipで指定）
├── LICENSE
├── pyproject.toml
├── README.md
├── src/
│   └── example_package_YOUR_USERNAME_HERE/  # パッケージ名（importで指定）
│       ├── __init__.py
│       └── example.py
└── tests/

Python のプロジェクトをパッケージングする – Python Packaging User Guide
PyPAのPython Packaging User Guideです

Licenseやpyproject.toml等はひとまず放置します（パッケージングするものができたら準備します）。ここで重要なのは、次の２点です。

１点目：srcディレクトリを設ける: 通称srcレイアウトと呼ぶそうです。srcディレクトリを置かないフラットレイアウト派もあるようです。正直どちらでも良いのですが、srcレイアウトを採用します。
２点目：パッケージ名に自分の名前を入れる: リンク先のガイドでは、名前の衝突を避けるために自分の名前を入れることが推奨されています。GitHubからインストールする際に有効らしいです。だだし、プロジェクト名とパッケージ名を一致させることを推奨する記事もあります（むしろこちらが多数派のようです）。