目次

概要

PowerShell では throw で例外を投げて、trap で例外を処理します。

シェルスクリプト言語の割には例外処理がきっちりしていると思います。 (微妙に挙動がつかめないところもあるんだけど・・・。 外部スクリプト内で 0 除算(1/0 とか)すると例外が trap できなかったり。)

例外

PowerShell では、(タイプミスしたりして)未定義のコマンドを入力したり、 不正な型変換をしたり、0 除算したり、 なんらかのエラーが起きたとき、例外を投げます。

例外は、特に何もしなければ、例外の内容を赤字で表示します。

>  UndefinedName
用語 'UndefinedName' は、コマンドレット、関数、操作可能なプ
ログラム、またはスクリプト ファイルとして認識されません。用
語を確認し、再試行してください。
発生場所 行:1 文字:13
+ UndefinedName <<<<
>  1/0
0 で除算しようとしました。
発生場所 行:1 文字:3
+ 1/0 <<<<
>  [int]'test'
値 "test" を型 "System.Int32" に変換できません。エラー: "入
力文字列の形式が正しくありません。"
発生場所 行:1 文字:6
+ [int]' <<<< test'

.NET Framework オブジェクトのメソッドが投げる例外も同様の扱いになります。

>  [int]::Parse('test')
"1" 個の引数を指定して "Parse" を呼び出し中に例外が発生しました: 
"入力文字列の形式が正しくありません。"
発生場所 行:1 文字:13

$Error

ちなみに、例外の詳細は $Error 自動変数の中身を覗くことで分かります。 $Error には、過去に発生した例外のリストが格納されていて、 直前に発生した例外は $Error[0] に入っています。

$Error は ArrayList で、 System.Management.Automation.RuntimeException 型の値か System.Management.Automation.ErrorRecord 型が入っています。 「コマンドが見つからない」とか「型変換に失敗した」とか「0 除算」とかの、 PowerShell 内のエラーは RuntimeException に、 .NET Framework オブジェクトのメソッド中などで起きたエラーは ErrorRecord になります。

RuntimeException の場合、InnerException プロパティに例外の内容が格納されています。

>  1/0
0 で除算しようとしました。
発生場所 行:1 文字:3
+ 1/0 <<<<
>  $Error[0].InnerException.GetType().Name
DivideByZeroException

ErrorRecord 型の CategoryInfo プロパティに例外に関する情報が格納されています。

>  [int]::Parse('test')
"1" 個の引数を指定して "Parse" を呼び出し中に例外が発生しました: 
"入力文字列の形式が正しくありません。"
発生場所 行:1 文字:13
+ [int]::Parse( <<<< 'test')
>  $Error[0].CategoryInfo

Category   : NotSpecified
Activity   :
Reason     : MethodInvocationException
TargetName :
TargetType :

PowerShell Memo で、 ↑の説明に沿って発生した例外の型を調べる関数の例が示されています。 「発生した例外クラス名を調べる

例外の throw

例外は throw キーワードを使って自分で投げることもできます。 throw は文字列、.Net Framework の例外クラス、ErrorRecord 型のいずれかを受け取ります。 (どれを throw しても、 $Error の中身は RuntimeException になるみたい。)

文字列を throw に渡した場合、 $Error の中身は、 渡した文字列を Message プロパティに格納した RuntimeException になります。

>  throw 'error message'
error message
発生場所 行:1 文字:6
+ throw  <<<< 'error message'
>  $Error[0].InnerException.Message
error message
>  $Error[0].InnerException.GetType().Fullname
System.Management.Automation.RuntimeException

.Net Framework の例外クラスを throw した場合には、 throw した例外を InnerException として含む RuntimeException になります。

>  throw New-Object ArgumentException
値が有効な範囲にありません。
発生場所 行:1 文字:6
+ throw  <<<< New-Object ArgumentException
>  $Error[0].InnerException.GetType().Fullname
System.ArgumentException

ErrorRecord を throw するのはちょっと複雑なんですが、 例としては以下のような感じ。

>  throw New-Object Management.Automation.ErrorRecord
  (New-Object ArgumentException), 'test',
  ([Management.Automation.ErrorCategory]::InvalidArgument), ($null)
値が有効な範囲にありません。
発生場所 行:1 文字:6
+ throw  <<<< New-Object Management.Automation.ErrorRecord (
New-Object ArgumentException), 'test', ([Management.Automat
ion.ErrorCategory]::InvalidArgument), ($null)
>  $Error[0].ErrorRecord.FullyQualifiedErrorId
test
>  $Error[0].ErrorRecord.CategoryInfo

Category   : InvalidArgument
Activity   :
Reason     : ArgumentException
TargetName :
TargetType :

例外の trap

今までは例外を投げっぱなしの状態でしたが、 ちゃんと例外を拾って処理することもできます。 例外処理は trap キーワードを使って行います。

C# や Java なんかだと、 try ブロックを書いて、 try ブロック内で生じた例外を catch ブロックで拾うわけですが (参考: 「例外処理」)、 PowerShell の trap はちょっと書き方が違います。

PowerShell の trap は、C# や Java でいうところの catch の方に相当するもので、 例外を拾いたいブロック内のどこでもいいので書いておけば、ブロック内で生じた例外を拾います。

例えば、以下のようなスクリプトを書くと、 trap はスクリプト内で生じた例外を拾います。 (trap はスクリプト内のどこに書いても同じ)

1
[int]'test'
2

trap { 'trap exception' }
1
trap exception
値 "test" を型 "System.Int32" に変換できません。エラー: "入力
文字列の形式が正しくありません。"
2

まあ、結果を見ての通り、 例外を trap しても、その後、エラーメッセージを表示した上で処理は続行します。

trap 内の break, continue

ここで、trap ブロック内に break か continue を書くことで、 挙動を変更することができます。 まず、continue を書くと、 エラーメッセージは表示せず、trap 内に書かれた処理だけして、 あとは何事もなかったかのように処理を続行します。

1
[int]'test'
2

trap { 'trap exception'; continue }
1
trap exception
2

一方、break を書くと、 エラーメッセージを表示して、残った処理はせずにブロック(あるいはスクリプト)を抜けます。

1
[int]'test'
2

trap { 'trap exception'; break }
1
trap exception
値 "test" を型 "System.Int32" に変換できません。エラー: "入力
文字列の形式が正しくありません。"

ちなみに、この挙動は、要するに、break によって例外が再 throw されています。 上位のブロックで trap すればエラーメッセージは表示されなくなります。 (以下の例では、 function f 内の trap では break しているので、エラー発生後の 2 は表示されません。 一方、function 外の trap では continue しているので、エラーの発生源である f より後ろの 'b' が表示されます。)

function f
{
  trap { 'trap in function'; break }
  1
  [int]'test'
  2
}

'a'
f
'b'

trap { 'trap in script'; continue }
>  .\test.ps1
a
1
trap in function
trap in script
b

特定の例外だけ trap

trap {ブロック} と書くことで任意の例外を拾っていましたが、 trap [型] {ブロック} と書くことで特定の型の例外だけを拾えます

1
[int]'test'
2
UndefinedName
3

trap [InvalidCastException] { 'trap for invalid cast'; continue }
trap [SystemException] { 'trap for system'; continue }
>  .\test.ps1
1
trap for invalid cast
2
trap for system
3

更新履歴

test

[雑記]

ブログ