PowerShellの計算結果が想定と違うときは、計算する直前で止めて入力値を確認し、1文ずつ進めると原因を絞れます。デバッガは、プログラムを一時停止して、その時点の変数や実行位置を調べる機能です。
この記事では、練習用の7行で、入力値の120と3、引き算による117、保存した修正後の360を順に確認します。停止位置の設定から解除まで、同じPowerShell画面で進めます。
実行記録の対象はWindows PowerShell 5.1.26100.9818のコンソールです。PowerShell 7は公式7.6資料との照合のみで、ISE・VS Code・業務スクリプトは未実行です。練習用フォルダーと、メモ帳などのテキストエディターを用意してください。
先に結論
- 停止中に示される行は、これから実行する文です。入力値を確認し、vで進めてから計算結果を読みます。
- sは関数の中も追い、vは関数を実行して呼び出し後へ進みます。どちらも処理そのものは実行されます。
- qによる中止、停止位置の解除、保存したファイルの修正は別の操作です。中止や解除では、実行済みの変更は元に戻りません。
1.練習用ファイルへ7行だけ保存する
保存するのはコード欄の7行だけです。出力例はファイルへ貼り付けません。
業務ファイルと区別できるように、専用フォルダーへ練習用ファイルを作ります。後で3行目を指定して止めるため、次のコード欄には空行や行番号を追加せず、先頭から末尾までの7行を保存してください。
コード欄に続くanswer=117は、ファイル全体を通常実行した場合の出力例です。最初は保存だけを行い、実行は次節の停止位置を設定してから進めます。
- エクスプローラーで自分の作業場所を開き、PS-Debug-Practiceという練習用フォルダーを作ります。
- メモ帳などのテキストエディターを開き、次のコード欄の7行を貼り付けます。
- 練習用フォルダーへdebug-demo.ps1という名前で保存します。メモ帳の「名前を付けて保存」では、ファイルの種類を「すべてのファイル」にします。
- エクスプローラーの「表示」からファイルの拡張子を表示し、末尾が.ps1.txtになっていないことを確認します。
debug-demo.ps1へ保存する7行
function Get-LineTotal {
param([int]$Price, [int]$Count)
$lineTotal = $Price - $Count
$lineTotal
}
$answer = Get-LineTotal -Price 120 -Count 3
"answer=$answer"
実行結果
answer=117
Get-LineTotalは、この例で作る関数の名前です。関数は、一連の処理に名前を付けたものです。paramは受け取る値の定義で、Priceが単価、Countが個数、intが整数の指定です。$は変数の目印です。
3行目は、意図的に単価から個数を引く計算にしています。4行目で計算結果を出力し、6行目で120と3を渡した結果をanswerへ保存します。7行目は、その値を画面に表示する処理です。
金額は通貨単位を省いた練習用の値です。ここで求める合計金額は、単価に個数を掛けた値です。単価120の商品を3個そろえるため、目標の結果は360です。
2.同じPowerShell画面で3行目に停止位置を置く
ブレークポイントは、実行を一時停止する目印です。今回は保存したファイルの3行目に置き、計算する直前で止めます。設定しただけでは停止しないため、コード欄の最後にあるファイルの実行まで進めてください。
ここからはWindows PowerShell 5.1の同じ画面で操作します。管理者として起動する必要はありません。ISEやVS Codeのデバッグ用コンソールへ途中で移らず、練習用フォルダーから開いた画面を続けて利用します。
- エクスプローラーで、debug-demo.ps1を保存した練習用フォルダーを開きます。
- アドレス欄にpowershellと入力し、半角空白に続けて-NoProfileを付けてEnterキーを押します。
- 開いたWindows PowerShell画面で、次のコード欄の3行を上から1行ずつ入力し、それぞれEnterキーを押します。
同じPowerShell画面で3行目へ停止位置を設定
$demoPath = Join-Path $PWD 'debug-demo.ps1'
$bp = Set-PSBreakpoint -Script $demoPath -Line 3
& $demoPath
1行目は、現在のフォルダーを表すPWDとファイル名をJoin-Pathでつなぎ、保存先をdemoPathへ入れます。2行目はSet-PSBreakpointで停止位置を作ります。-Scriptが対象ファイル、-Lineが行番号の指定です。
bpには、今回作った停止位置1件を保存します。後でこの1件だけを解除するため、途中で別の値を入れないでください。最後の行の&は、demoPathに入ったファイルを実行する記号です。
3行目が表示され、入力待ちの先頭に[DBG]が出れば停止中です。通常の入力待ちとは状態が違うので、この表示を確認してから次節へ進みます。
3.停止中の入力欄で単価と個数を確認する
表示された3行目は、まだ実行されていません。
3行目で停止したら、[DBG]のある入力欄へ次の2行を順に入力します。練習用ファイルへ追記する操作ではありません。ここでは、計算に渡された単価と個数を読むだけです。
停止中に表示される文は、次に実行する文です。3行目が見えていても、その引き算が済んだという意味ではありません。入力値の確認と、計算後の結果の確認を分けて進めます。
停止中に2行を順に入力
$Price
$Count
実行結果
120
3
出力の1行目が単価の120、2行目が個数の3です。この2つが意図した入力と一致していれば、次は計算する文を確認します。入力値が違う場合は、関数へ渡す6行目を見直す手掛かりになります。
この段階では、lineTotalに今回の計算結果が入ったとは判断しません。停止した状態を保ち、次節で3行目を実行してから値を読みます。
4.vで計算を進め、117になった位置を確かめる
同じ停止中の入力欄で、次のコード欄を上から1行ずつ入力します。最初のvは、現在の文を実行して次へ進む操作です。続く行で、計算結果を保存したlineTotalの値を読みます。
2行をまとめて結果だけ見るのではなく、vの後に停止位置がどこへ移ったかも確認してください。実行前の3行目と、実行後の4行目を対応させることが、この例の確認点です。
vを入力してから計算結果を確認
v
$lineTotal
実行結果
117
vの後に4行目で停止し、lineTotalが117なら、3行目の引き算で120から3を引いた結果だと分かります。入力値は想定どおりなので、単価に個数を掛けて合計金額を求める目的に対して、演算子が合っていません。
掲載の出力は、通常出力の値だけを抜き出しています。実際のコンソールには停止行、入力待ちの表示、ファイルのパスなども出ます。ここでは停止したまま、次節で呼び出し関係を確認します。
5.呼び出し関係を見てからcで最後まで実行する
4行目で停止している入力欄へ、次の1行を入力します。Get-PSCallStackは、現在動いている関数と、その呼び出し元の関係を取得します。この重なりをコールスタックと呼びます。
パイプ記号は、左の結果を右へ渡す記号です。後半のSelect-Objectは取り出す項目を選び、-ExpandPropertyのFunctionName指定で、関数名の値だけを表示します。
停止中の呼び出し関係を確認
Get-PSCallStack | Select-Object -ExpandProperty FunctionName
検証記録では、Get-LineTotalの後に、スクリプト本体などを示すScriptBlockが並びました。表示名や行数は呼び出し方で変わるため、固定の2行になるとは限りません。まずGet-LineTotalが含まれるかを確認します。
コールスタックは、その時点の呼び出し関係です。終了した呼び出しを残し続ける履歴ではありません。確認後はcを入力してEnterキーを押し、残りの処理を続行します。
answer=117が表示され、[DBG]のない通常の入力待ちへ戻れば、この実行は終了です。ファイルはまだ引き算のままなので、続行しただけでは計算結果は変わりません。
6.関数の中を追うsと、呼び出し後へ進むvの違い
次の表は、[DBG]で停止している間の操作を比べたものです。sは関数の内部も追い、vは関数を実行して呼び出し後へ進みます。vでも関数内の処理は実行されます。oも、現在の関数の残りを実行して呼び出し元へ進む操作です。
これらはコンソールデバッガ用の入力です。長い名前のStepIntoやStepOverにもハイフンは付けません。第5節で通常の入力待ちへ戻った後は、表の文字を入力せず、内容を確認して次節の解除へ進んでください。
| 停止中の入力 | 進み方 | 判断すること |
|---|---|---|
| s | 次の文へ進み、関数の中も追う | 呼出し先の内部を確認する |
| v | 関数は実行し、中の文を一つずつ追わない | 呼出し後の結果を確認する |
| o | 現在の関数から呼出し元へ進む | 内部の処理も実行される |
| c | 次の停止位置または終了まで実行する | 別の停止位置があると再び止まる |
| q | 実行中のスクリプトを中止する | それまでの変更は取り消されない |
別の検証記録では、同じ7行の6行目で停止してsを入力すると、関数宣言の1行目へ入りました。vでは関数の計算を終え、7行目で停止しました。停止位置は構文によって変わるため、進めるたびに表示された行を読みます。
cは続行、qは実行中のスクリプトの中止です。qを入力しても、それまでに起きた変更は取り消されません。今回の例はメモリー内の計算と画面表示だけですが、業務処理では削除や送信などの影響を実行前に確認します。
7.今回の停止位置だけを無効化・再有効化・解除する
第5節のcで通常の入力待ちへ戻った状態で、次の6行を上から1行ずつ実行します。Disableは一時無効化、Enableは再有効化、Removeは解除です。第2節でbpへ保存した、今回の停止位置1件だけを操作します。
コード欄の最後は、練習ファイルに残る停止位置の件数を確認する行です。Removeまでで止めず、この件数の確認まで進めてください。
通常の入力待ちへ戻ってから今回の停止位置を片付ける
Disable-PSBreakpoint -Breakpoint $bp
$bp.Enabled
Enable-PSBreakpoint -Breakpoint $bp
$bp.Enabled
Remove-PSBreakpoint -Breakpoint $bp
@(Get-PSBreakpoint -Script $demoPath).Count
実行結果
False
True
0
出力は上からFalse、True、0です。Enabledは停止位置が有効かどうかを示し、Falseなら無効、Trueなら有効です。最後の0は、練習ファイルに停止位置が残っていないことを示します。
0になるのは、新しい専用画面で今回の1件だけを作った場合です。同じファイルに別の停止位置があれば件数は変わります。ほかの作業の停止位置までまとめて削除せず、保持したbpの1件を対象にします。
qで途中中止した場合も、停止位置は解除されず残ることがあります。実行の中止と停止位置の解除を分け、通常の入力待ちへ戻ってから片付けます。
8.ファイルを掛け算へ直し、再実行で360を確認する
停止中の値を書き換えるだけでは、保存したファイルは直りません。
単価120の商品を3個そろえた合計金額を求めるなら、必要なのは掛け算です。テキストエディターで3行目の演算子を直し、保存したファイルを実行し直します。*が掛け算の記号です。
次のコード欄は修正後の7行です。入力値やほかの行は変えず、3行目だけを合わせてください。コード欄に続くanswer=360は出力例なので、保存するファイルへは含めません。
- テキストエディターでdebug-demo.ps1を開き、3行目を次のコード欄と同じ掛け算へ直します。
- 同じ名前、同じ保存先へ上書き保存します。
- 停止位置を解除したPowerShell画面で、第2節のコード欄の最後にある実行の1行だけを再入力します。停止位置を作る行は繰り返しません。
3行目を掛け算に直して保存した7行
function Get-LineTotal {
param([int]$Price, [int]$Count)
$lineTotal = $Price * $Count
$lineTotal
}
$answer = Get-LineTotal -Price 120 -Count 3
"answer=$answer"
実行結果
answer=360
answer=360が表示されれば、同じ120と3に対して、保存した掛け算の修正が反映されています。117のままなら、編集したファイルの保存先と上書き保存の有無、3行目の演算子を確認します。
停止中の入力欄でlineTotalの値だけを変えても、ファイルの3行目は変わりません。修正の確認は、エディターで保存し、ファイルを実行し直すところまで行います。
元の例へ戻す場合は、エディターで演算子を引き算へ戻して保存できます。今回変更するのは練習用ファイルと一時的な停止位置です。終了後は専用画面を閉じ、ファイルは必要に応じて保管してください。
9.止まらない・値が違うときは症状から確認する
期待した位置で止まらないときは、保存したファイル、指定した行番号、操作中のPowerShell画面の順に確認します。設定を増やす前に、今回の7行と現在の実行位置が対応しているかを見直してください。
次の項目から、近い症状を選んで確認できます。実行が拒否される場合は、停止位置の問題と区別し、組織の制限や署名のエラーを弱める操作で進めないでください。
- 停止しない:保存したファイルと実行対象が同じかを確認します。ファイル名の末尾が.ps1.txtになっていないか、PowerShellの現在のフォルダーも見直します。
- 停止行が合わない:空行や行番号を追加していないか確認します。3行目が引き算の文になっていることと、上書き保存の有無を確かめます。
- 変数の値が見えない・想定と違う:その変数を作る文まで進んだか確認します。3行目で停止中なら計算前、vで4行目へ進んだ後なら計算後です。
- 途中で別画面へ移った:demoPathやbpは別画面へ引き継がれません。元の画面で続けるか、新しい専用画面では第2節から準備します。
- 組織の制限や署名のエラーで実行できない:制限を弱めず、表示されたエラーを基に管理者へ確認します。
argsやPSBoundParametersなど、PowerShellが自動で用意する変数では、停止中の確認処理側の値が見える場合があります。公式資料では、必要な値を事前に別名の変数へ保存してから停止する方法が案内されています。
Windows PowerShell ISEはWindows PowerShell向けです。今回の手順を、PowerShell 7をISEで実行する手順として読み替えないでください。PowerShell 7や各エディターの画面操作は、今回の実行確認に含まれていません。
Write-DebugやWrite-Verboseは診断用のメッセージを出す機能です。実行を一時停止して変数や呼び出し関係を調べるデバッガとは、確認する方法が異なります。
