ソースコードの書式整形・チェックに「isort」「Black」を使用する。
- isortは、インポート文をアルファベット順に並べたり、セクションや種類ごとに自動分類したりすることができるパッケージである。
- BlackはPythonコードフォーマッターの一つである。他のフォーマッターよりも厳しいルールを課しているという特徴がある。
- 各種設定はpyproject.tomlに記載されている。
- (仮想環境上ではなく)windowsのpython環境上にパッケージ「Poe the Poet」をインストールする。
- 「Poe the Poet」はpoetryでタスクランナーを実行することができるようになるパッケージである。
- 最も推奨されるインストール方法はwindowsに「pipx」をインストールしてから、以下のコマンドを入力する方法である。
pipx install poethepoet
- 以下のコマンドラインを実行することで、各種整形が実行される。
- isort
poe isort
- Black
poe black
- .vscode/extensions.jsonに記載されている以下のエクステンションをVScodeにインストールすることで、ファイルセーブ時に自動的に整形されるようになる。
- VScode上の自動整形に関する設定は.vscode/setting.jsonに記載されている
- ワークスペース内で使うPythonの仮想環境を、ucgrb内で作成された環境(.venv)に指定する必要がある。
- コマンドパレット(Windows:
Ctrl+shift+P)を開き、Python Select Interpreterから適切なパスを選択する。
- コマンドパレット(Windows:
上記の実行方法は、本リポジトリ(ucgrb)そのものをワークスペースとしている場合の実行方法である。例えば、「実行方法 - Gurobi Optimizer有償版ライセンスがある場合 -」では、本リポジトリ(ucgrb)より上のディレクトリでmain.pyを作成しているため、ワークスペースが上のディレクトリとなる可能性がある。その際には、以下の点を注意する必要がある。
cdコマンドを利用して、本リポジトリ(ucgrb)に移動してから、コマンドを実行する必要がある。
- ディレクトリucgrb/.vscodeをコピーして、ワークスペースのディレクトリにペーストする必要がある。
- ワークスペース内で使うPythonの仮想環境を、本リポジトリ(ucgrb)内で作成された環境(.venv)に指定する必要がある。