背景

StrictDocをステップ実行し、動作を把握する必要があり、VsCode上でデバッグ環境をセットアップした。

前提

VsCodeにはPythonの開発に必要なExtensionがインストールされていること。

• Python extension for Visual Studio Code
• Python Debugger

Pythonの実行環境は、Hatchで管理されていること

本動作確認は、MacOS上で実施した。

Python仮想環境のセットアップ

適当はHatchの実行環境を作成し、Python環境のPathを取得する。

$hatch env show default

上記の結果のパスの末尾にbin/pythonを追加すると、Pythonのパスとなる。

デバッグ対象

仮想環境で作業する.

$ hatch shell

StrictDocのGitリポジトリをcloneする。 カレントディレクトリをそのパスに移動し、以下のコマンドを実行する。

$ pip install -e .

仮想環境にソースコードから最新の環境がインストールされる。

VsCodeのlaunch.jsonを編集

launch.jsonを作成する。

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Debug StrictDoc (Hatch)",
            "type": "debugpy",
            "request": "launch",
            "module": "strictdoc.cli.main",
            "args": [
                "export",
                "."
            ],
            "console": "integratedTerminal",
            "cwd": "${workspaceFolder}/strictdoc-examples/",
            "python": "XXX",
            "env": {
                // 必要に応じて環境変数を追加
            },
            "justMyCode": false
        }
    ]
}

個別の設定値については、以下を意図して設定している。

• args: strictdoc export .の実行を意図している
• python: 上記で取得したPythonパス
• cwd: WorkSpaceの直下にStrictDocの入力を格納している

デバッガの実行

VsCodeのデバッグ画面から上記のデバッグコンフィギュレーションを実行できるようになる。