環境
- Windows
- Autodesk Maya 2025.3
uv
開発環境を管理するためのツールとして uv を使用します。
uvについて簡単に説明すると仮想環境の作成、プロジェクトの初期化、パッケージの管理などができるツールです。Rust製で非常に高速でかつ高機能なため、このツールのみで色々なライブラリを代用することができます。
Windows環境でのインストールは Installation に記載があるPowerShellのコマンド1行で簡単にインストールできます。
Windows でのインストール先は %HOMEPATH%\.local\bin
で、uvでインストールするツールはこのパスに追加されるため好みに応じて環境変数 PATH
に追加しておくと良いかと思います。
仮想環境の作成
mayapyへのソフトリンクの作成
「mayapyでvenvを実行する」を参考にmayapyへのソフトリンクを作成します。
cd "C:\Program Files\Autodesk\Maya2025\bin"
mklink python.exe mayapy.exe
Program Files以下のディレクトリのため管理者権限が必要です。
venv の作成
uv venv --python "C:\Program Files\Autodesk\Maya2025\bin\python.exe" --system-site-packages
--python
でMayaのPythonインタプリタを指定、--system-site-packages
をONにすると作成した仮想環境からMayaのPythonパッケージにアクセスできるようになります。
プロジェクトディレクトリの作成
下記のコマンドで作成できます。
uv init
ただし、DCCツールのケースではPythonの一般的なプロジェクト構成よりもドキュメントで推奨されている構成のほうが扱いやすいかもしれません。
例えばMayaであれば「モジュール パッケージを作成する」あたりを参考にサブディレクトリの構成を検討すると良いかと思います。
EditorConfig
コードスタイルを維持するための設定ファイルとして EditorConfig に準拠した設定ファイルを .editorconfig
という名前で用意します。
有名なエディタではプラグイン不要で認識します。
(エディタの対応状況は https://editorconfig.org/#pre-installed で確認できます)
設定については Example を参考に始めて、好みに応じて File Format Details を基に調整を加えると良いかと思います。
linter, formatter
linter, formatterに関しては実行速度と機能性の観点から Ruff がおすすめです。
下記のコマンドでインストールできます。
uv tool install ruff
linterとして使用する
下記のコマンドで静的構文解析が実行できます。
ruff check <Directory or File>
修正まで行う場合はオプションで --fix
を指定します。
ruff check --fix <Directory or File>
formatter として使用する
下記のコマンドでフォーマットできます。
ruff format <Directory or File>
フォーマット前に実行結果を確認したい場合は --check
と --diff
のオプションを指定します。
ruff format --check --diff <Directory or File>
import order
import order に関する設定はMayaのPythonパッケージを tool.ruff.lint.isort
の section-order
と tool.ruff.lint.isort.sections
で指定すると綺麗にできます。
[tool.ruff.lint.isort]
section-order = [
"future",
"standard-library",
"first-party",
"third-party",
"maya-library",
"local-folder",
]
[tool.ruff.lint.isort.sections]
"maya-library" = [
"maya",
]
型チェック
型チェックについてはいくつか種類がありますが、ここでは mypy を紹介します。
uv tool install mypy
mypy <File or Directory>
その他
テストフレームワーク
テストについてはシンプルで使いやすい pytest がおすすめです。