Windows PowerShell 入門(10)-デバッグ編
対象読者
- Windows PowerShellでコマンドレット操作ができる方
- 何らかのプログラミング経験があればなお良い
必要環境
- Windows PowerShell
デバッグメッセージの出力
PowerShellではデバッグ用のメッセージを表示しながら開発が行えるように、Write-Debugという専用のコマンドレットを備えています。
コンソールにメッセージを表示するコマンドレットとしてはWrite-Hostコマンドレットがありますが、両者には次のような違いがあります。
- Write-Hostコマンドレットは、実行すれば必ず表示を行う。
- Write-Debugコマンドレットは、
$DebugPreference
シェル変数によって表示制御が行われる
$DebugPreference
シェル変数はデバッグ時の振る舞いを変更する特殊な変数であり、下記の4つの値を指定することが可能です。
値 | 説明 |
"Continue" | Write-Debugに指定されたメッセージを出力 |
"SilentlyContinue" | Write-Debugに指定されたメッセージを出力しない |
"Stop" | Write-Debugに指定されたメッセージを出力した後、動作を停止 |
"Inquire" | Write-Debugに指定されたメッセージを出力後、続行するかを確認 |
下記スクリプトを準備して(ここでは「C:\Work\Debug.ps1」として保存)、$DebugPreference
シェル変数のそれぞれの値の挙動を確認してみたいと思います。
$a = 2
$b = 3
$c = $a + $b
Write-Debug "Line4: $c"
$a = 4
$b = 5
$c = $a + $b
Write-Debug "Line8: $c"
Debug.ps1の各行の意味は下記の通りです。
- 1行目:$aに2を代入
- 2行目:$bに3を代入
- 3行目:$aと$bの和を$cに代入
- 4行目:Write-Debugコマンドレットによる文字列の出力。ここでは「Line4:」と変数$cに代入された値が連結した文字列を出力。
- 5行目:$aに4を代入
- 6行目:$bに5を代入
- 7行目:$aと$bの和を$cに代入
- 8行目:Write-Debugコマンドレットによる文字列の出力。ここでは「Line8:」と変数$cに代入された値が連結した文字列を出力。
Continue
$DebugPreference
に値Continue
を設定した場合の動作を見てみましょう。
まずは、下記のようにして $DebugPreference
の設定を変更します。
PS C:\Work> $DebugPreference = "Continue"
次に、作成したスクリプトを実行してみましょう。
PS C:\Work> ./Debug.ps1
デバッグ: Line4: 5
デバッグ: Line8: 9
Write-Debug
コマンドレットに指定したメッセージを出力することがわかります。
SilentlyContinue
$DebugPreference
に値SilentlyContinue
を設定した場合の動作を見てみましょう。
まずは、下記のようにして $DebugPreference
シェル変数の設定を変更します。
PS C:\Work> $DebugPreference = "SilentlyContinue"
スクリプトを実行します。
PS C:\Work> ./Debug.ps1
PS C:\Work>
スクリプト中の4行目と8行目にあるWrite-Debugに指定したメッセージは出力されずに終了することがわかります。
Stop
$DebugPreference
に値Stop
を設定した場合の動作を見てみましょう。
まずは、下記のようにして $DebugPreference
シェル変数の設定を変更します。
PS C:\Work> $DebugPreference = "Stop"
スクリプトを実行します。
PS C:\Work> ./Debug.ps1
デバッグ: Line4: 5
Write-Debug : シェル変数 "DebugPreference" が Stop に設定されているため、コマンドの実行が停止されました
発生場所 C:\Work\Debug.ps1:4 文字:12
+ Write-Debug <<<< "Line4: $c"
1つめのWrite-Debugで指定されたメッセージを表示した後、エラーメッセージを表示して処理を中断することが分かります。
Inquire
$DebugPreference
に値Inquire
を設定した場合の動作を見てみましょう。
まずは、下記のようにして $DebugPreference
シェル変数の設定を変更します。
PS C:\Work> $DebugPreference = "Inquire"
スクリプトを実行します。
PS C:\Work> ./Debug.ps1
デバッグ: Line4: 5
確認
この操作を続行しますか?
[Y] はい(Y) [A] すべて続行(A) [H] コマンドの中止(H) [S] 中断(S) [?] ヘルプ (既定値は "Y"):
1つめのWrite-Debug
で指定されたメッセージを表示した後に、スクリプトを実行するかを確認してくることがわかります。
ここで[Y]または[A]を押すと、スクリプトが続行されます。
確認
この操作を続行しますか?
[Y] はい(Y) [A] すべて続行(A) [H] コマンドの中止(H) [S] 中断(S) [?] ヘルプ (既定値は "Y"):
デバッグ: Line8: 9 確認
この操作を続行しますか?
[Y] はい(Y) [A] すべて続行(A) [H] コマンドの中止(H) [S] 中断(S) [?] ヘルプ (既定値は "Y"):
このように、Write-Debugコマンドレットと$DebugPreference
変数を使用することで、デバッグメッセージの出力の振る舞いを制御することが可能です。
Set-PSDebugコマンドレットによるデバッグ
PowerShellには、スクリプトのデバッグを行うために、Set-PSDebug
というコマンドレットがあります。書式は大きく2つに分けることができます。
下記は、スクリプトのデバッグ機能の切り替え、トレース レベルの設定、および strict モードの切り替えを行います。
Set-PSDebug [-Trace 数値] [-Step] [-Strict]
一方、こちらはすべてのスクリプトデバッグ機能を無効にします。
Set-PSDebug -Off
-Traceパラメータ
-Traceパラメータに指定できる値には下記の3つがあります。
値 | 説明 |
0 | スクリプトのトレースを無効にする |
1 | 実行されるスクリプト行をトレースする |
2 | スクリプト行、変数の代入、関数呼び出し、およびスクリプトをトレースする |
では、さきほどのスクリプトファイル(Debug.ps1)を使用して実験してみましょう。
-Traceに0を指定した場合
まずはSet-PSDebug
コマンドレットによるスクリプトファイルのデバッグ方法ですが
PS C:\Work> Set-PSDebug -trace 0; ./Debug.ps1
のようにします。
-Trace
パラメータに0を指定した場合の実行結果は下記の通りで、値0はトレースが無効となっているために1行だけ表示して終わっています。
デバッグ出力の行には、先頭に「デバッグ:」と表示されることに注意してください。
PS C:\Work> Set-PSDebug -trace 0; ./Debug.ps1
デバッグ: 1+ Set-PSDebug -trace 0; ./Debug.ps1
-Trace
に1を指定した場合は行トレースとなりますので、すべての行がデバッグ表示されます。
-Traceに1を指定した場合
PS C:\Work> Set-PSDebug -trace 1; ./Debug.ps1
デバッグ: 1+ Set-PSDebug -trace 1; ./Debug.ps1
デバッグ: 1+ $a = 2
デバッグ: 2+ $b = 3
デバッグ: 3+ $c = $a + $b
デバッグ: 4+ Write-Debug "Line4: $c"
デバッグ: 5+ $a = 4
デバッグ: 6+ $b = 5
デバッグ: 7+ $c = $a + $b
デバッグ: 8+ Write-Debug "Line8: $c"
-Traceに2を指定した場合
-Traceに2を指定した場合は変数の代入、関数呼び出しなど、各行で行われている詳細情報を見ることができます。
PS C:\Work> Set-PSDebug -trace 2; ./Debug.ps1
デバッグ: 1+ Set-PSDebug -trace 2; ./Debug.ps1
デバッグ: ! CALL script 'Debug.ps1'
デバッグ: 1+ $a = 2
デバッグ: ! SET $a = '2'.
デバッグ: 2+ $b = 3
デバッグ: ! SET $b = '3'.
デバッグ: 3+ $c = $a + $b
デバッグ: ! SET $c = '5'.
デバッグ: 4+ Write-Debug "Line4: $c"
デバッグ: 5+ $a = 4
デバッグ: ! SET $a = '4'.
デバッグ: 6+ $b = 5
デバッグ: ! SET $b = '5'.
デバッグ: 7+ $c = $a + $b
デバッグ: ! SET $c = '9'.
デバッグ: 8+ Write-Debug "Line8: $c"
上記を見るとわかるように、一番最初にスクリプトファイルの実行を行っているので
! CALL script 'Debug.ps1'
と表示されています。
また、変数に値がセットされるときは
SET $a = '2'.
のように表示されていることが分かります。
上記をまとめると-Trace
は、どの行を通って来たかを確認するだけであれば「1」を、詳細情報(変数にセットされた情報、関数呼び出しなど)を得たい場合には「2」を指定すれば良いことが分かります。
未定義の変数を調査する
Set-PSDebug
にパラメータ-Strict
を指定することで、未定義の変数をエラーとして処理することができます。
下記のように、Set-PSDebugコマンドレットを-Strictパラメータを指定して実行し、値の代入されていない変数を参照しようとするとエラーになることが分かります。
PS > Set-PSDebug -Strict
PS > $a
変数 $a は、設定されていないために取得できません。
発生場所 行:1 文字:2
+ $a <<<<
また、下記スクリプト(「C:\Work\Strict.ps1」として保存)を準備し
$a = 3
Write-Host ($a + $b)
コマンドラインから実行すると
PS C:\Work> ./Strict.ps1
変数 $b は、設定されていないために取得できません。
発生場所 C:\Work\Strict.ps1:2 文字:20
+ Write-Host ($a + $b) <<<<
スクリプトファイル中の変数$b
が値が設定されていないのに使用されたことをエラーとして報告します。
このように、-Strictパラメータを使用することで、未定義の変数を見つけることが可能です。
ステップ実行する
Set-PSDebug
コマンドレットに-Stepパラメータを指定すると、ステップ実行を行うことが可能となります。「ステップ実行」は、スクリプトを1行ずつ停止させながら実行することができるモードです。
最初の方で紹介したDebug.ps1を用いて確認してみましょう。
コマンドラインで
PS C:\Work> Set-PSDebug -step; ./Debug.ps1
と入力して実行してみると、1行実行されるごとにメッセージが表示されます。
PS C:\Work> Set-PSDebug -step; ./Debug.ps1
この操作を続行しますか?
1+ Set-PSDebug -step; ./Debug.ps1
[Y] はい(Y) [A] すべて続行(A) [N] いいえ(N) [L] すべて無視(L) [S] 中断(S) [?] ヘルプ
(既定値は "Y"):
デバッグ: 1+ Set-PSDebug -step; ./Debug.ps1
「規定値は"Y"」と表示されている箇所がありますが、これは[Enter]キーを押すと次の行が押されることを意味しており、[Y]キーを押すのと同操作となります。
次に[Enter]を2回続けて入力し
この操作を続行しますか?
2+ $b = 3
[Y] はい(Y) [A] すべて続行(A) [N] いいえ(N) [L] すべて無視(L) [S] 中断(S) [?] ヘルプ (既定値は "Y"): s
というメッセージが表示されたところで[S]を入力します。
この状態で[S]を入力した場合には、処理が一時中断され、プロンプトの表示が
PS C:\Work>>>
に変わります。
ここで、プロントに下記のように$aと入力すると
PS C:\Work>>> $a
2
ステップ実行を行っている地点での変数の値を確認することができます(この場合は変数$a
に2が代入されていることが分かります)。
プロンプトを終了して、デバッグを再会する場合には exit と入力します。
PS C:\Work>>> exit
ブレークポイントを使用する
ブレークポイントとは、プログラムの動作状態を確認するために、強制的に停止したい位置を設定する場所のことです。
ブレークポイントの設定は簡単で$host.EnterNestedPrompt()
をブレークポイントをかけたい場所に記述するだけです。
Debug.ps1を下記のように改善してスクリプトにブレークポイントを設定し、実験してみたいと思います(5行目に挿入しました。スクリプトは「C:\Work\Debug.ps1」として上書き保存します)。)
$a = 2
$b = 3
$c = $a + $b
$host.EnterNestedPrompt() #ブレークポイントの設定
Write-Debug "Line4: $c"
$a = 4
$b = 5
$c = $a + $b
Write-Debug "Line8: $c"
上記を実行してみます。
PS C:\Work> ./Debug.ps1
デバッグ: Line4: 5
PS C:\Work>>>
上記のように、ブレークポイントを設定した位置までコードが実行されプロンプトが表示されます。
この状態は、「ステップ実行する」で説明した「中断処理」と同様で、変数の状態を確認することが可能です。試しに$a
、$b
、$c
がどうなっているかみてみましょう。
PS C:\Work> ./Debug.ps1
デバッグ: Line4: 5
PS C:\Work>>> $a
2
PS C:\Work>>> $b
3
PS C:\Work>>> $c
5
PS C:\Work>>>
このようにブレークポイントを設定すると、ブレークポイントが設定された場所まで一気にコードが実行され、その時点での変数の値を確認することができます。プロンプトを終了するには exitと入力して[Enter]キーを押します。
PS C:\Work>>> exit
デバッグ: Line8: 9
PS C:\Work>
まとめ
今回は、PowerShellでのスクリプト開発におけるデバッグ機能について説明しました。
PowerShell自体にはVB.NETやC#のようにグラフィカルなデバッグ環境を持ち備えていません。しかし、今回紹介したデバッグ機能を用いることで、1行ずつステップ実行したり、変数の途中経過をウォッチすることが可能となります。
ぜひ、このデバッグ機能を有効に活用して、効率のよい開発を行っていただければ幸いです。
Windows PowerShell 入門(10)-デバッグ編的更多相关文章
- Windows PowerShell 入門(7)-関数編2
この連載では.Microsoftが提供している新しいシェル.Windows Power Shellの使い方を解説します.前回に引き続きPowerShellにおける関数の取り扱いとして.変数と関数のスコ ...
- Windows PowerShell 入門(2)-基本操作編 2
前回に引き続きMicrosoftが提供している新しいシェル.Windows Power Shellの基本操作方法を学びます.基本操作編第2弾の今回は.パイプの使用方法を中心としたコマンドレットの操作方 ...
- Windows PowerShell 入門(3)-スクリプト編
これまでの記事 Windows PowerShell 入門(1)-基本操作編 Windows PowerShell 入門(2)-基本操作編 2 対象読者 Windows PowerShellでコマンド ...
- Windows PowerShell 入門(8)-関数編3
この連載では.Microsoftが提供している新しいシェル.Windows PowerShellの使い方を解説します.今回は.フィルタ.スクリプトブロック.変数のスコープについて取り上げます. はじめ ...
- Windows PowerShell 入門(9)-エラー編
対象読者 Windows PowerShellでコマンドレット操作ができる方 何らかのプログラミング経験があればなお良い 必要環境 Windows PowerShell エラーをリダイレクトする リダ ...
- Windows PowerShell 入門(6)-関数編1
この連載では.Microsoftが提供している新しいシェル.Windows Power Shellの使い方を解説します.今回は.関数の作成基礎と引数.戻り値.Switchパラメータについて説明します. ...
- Windows PowerShell 入門(1)-基本操作編
Microsoftが提供している新しいシェル.Windows Power Shellの基本操作方法を学びます.インストール.起動終了方法.コマンドレット.命名規則.エイリアス.操作方法の調べ方について ...
- Windows PowerShell 入門(4)-変数と演算子
Windows PowerShellにおける変数と演算子の使用方法について学びます.今回は代表的な演算子として.算術演算子.代入演算子.論理演算子.比較演算子.範囲演算子.置換演算子.ビット演算子.型 ...
- Windows PowerShell 入門(5)-制御構文
Windows PowerShellにおける制御構文について学びます.数ある制御構文の中でもSwitch文は.他の言語に比べ豊富な機能が用意されています. 対象読者 Windows PowerShel ...
随机推荐
- 使用Thumb
目录 使用Thumb title: 使用Thumb tags: ARM date: 2018-10-24 19:28:32 --- 使用Thumb C文件使用编译选择增加 -mthumb即可,修改ma ...
- java类的加载和执行顺序
以前面试总会碰到涉及到类的执行过程的笔试题.下面记录我自己的测试结果: public class ClassA { public static ClassA classa = new ClassA() ...
- tomcat如何访问非webapp下的资源文件
只要在%tomcathome%\conf\server.xml文件,在标签中加入文件中加入如下代码即可: <Host name="localhost" appBase=&qu ...
- Kafka权威指南 读书笔记之(五)深入Kafka
集中讨论以下3 个有意思的话题 :• Kafka 如何进行复制:• Kafka 如何处理来自生产者和消费者的请求 :• Kafka 的存储细节,比如文件格式和索引. 集群成员关系 Kafka 使用 Z ...
- 服务发现 - consul 的介绍、部署和使用
什么是服务发现 相关源码: spring cloud demo 微服务的框架体系中,服务发现是不能不提的一个模块.我相信了解或者熟悉微服务的童鞋应该都知道它的重要性.这里我只是简单的提一下,毕竟这不是 ...
- windows批量修改文件后缀名
有时候需要批量修改一些文件的后缀名,下面介绍批量修改的方法. 1.在文件夹内新建一个.txt文本文档. 2.在文本文档内写:ren * *.mp3 (意思是把没有后缀名的全部改成.mp3的格式, ...
- 三十、Linux 进程与信号——信号的概念及 signal 函数
30.1 信号的基本概念 信号(signal)机制是Linux 系统中最为古老的进程之间的通信机制,解决进程在正常运行过程中被中断的问题,导致进程的处理流程会发生变化 信号是软件中断 信号是异步事件 ...
- ubuntu终端命令启动matlab方法
让所有用户都有权限使用matlab,在终端输入 sudo gedit /etc/profile 在后行写 export MATLABPATH=/home/ubuntu/MATLAB/R2016b:$M ...
- Docker 创建 mongo 容器
获取 docker 认证 mongo 镜像: docker pull mongo 创建运行 mongo 容器: docker run -d -it -p : --name mongo3 -m 512M ...
- 一颗树下的input框超出的部分打点鼠标移动显示