2012/12/14
型を定義する方法 [PS Advent Calendar '12]
本記事はPowerShell Advent Calendar 2012の14日目の記事になります。
前回(アドベントカレンダー1日目)は「PowerShellらしい関数の書き方」と題して、パイプライン内でうまく他のコマンドと連携させるための関数をどう書けばいいのか、ということについて書きました。前回の関数の例では入力型と出力型がstringだったのですが、実際は自分で定義した型を入力、出力値に取るように書くのが普通かと思います。今回は、それをするためにどうやって型を定義するのか、そしてその型を関数にどう指定するのか、という話をします。
PowerShellにはクラス定義構文がない
そもそもの話になるんですが、型を定義する、つまりはクラスを記述するためのPowerShellのステートメントやコマンドレットが無いため、PowerShell単独ではできません。なので無理です以上おしまい。…というわけにはいかないので、実際はどうするのがいいのかという話をしていきます。
方法としては大きく分けて二つあると思います。
1.C#など他の.NET言語を用いてクラスを記述する
2.ユーザー定義オブジェクトを作成する
今回は1の方法を説明します。
C#を用いてクラスを記述する
つまりはPowerShellでクラスを定義できないなら、C#を使えばいいじゃない。ということです。幸いPowerShell 2.0からはAdd-Typeというコマンドレットを用いると、C#やVBなど.NET言語のソースをその場でコンパイルしてアセンブリとして現在のセッションに読み込むことが可能です。
たとえば、論理ドライブを表すDriveというクラスを定義してみます。
Add-Type -TypeDefinition @" namespace Winscript { public enum DriveType { Unknown, NoRootDirectory, RemovableDisk, LocalDisk, NetworkDrive, CompactDisc, RAMDisk } public class Drive { public string Name {get;set;} public string VolumeName {get;set;} public DriveType Type {get;set;} public long Size {get;set;} public long FreeSpace {get;set;} public long UsedSpace {get;set;} public string RootPath {get;set;} } } "@ -Language CSharpVersion3
このようにC#のコードを文字列として-TypeDefinitionパラメータに与えると、コンパイルされて指定のクラス(ここではWinscript.Drive)がロードされます。
ここで-Language CSharpVersion3というパラメータは指定コードをC# 3.0としてコンパイルすることを指定するため、今回使用している自動実装プロパティなどC# 3.0の構文が利用できます。なおこのパラメータはPowerShell 3.0では不要です。ただし明示しておくとPowerShell 2.0でも正しく動作します。というのも-Languageパラメータ省略時はPowerShell 2.0ではC# 2.0でコンパイルされるのですが、PowerShell 3.0ではC# 3.0でコンパイルするためです(逆にPSv3でC#2.0でコンパイルするには”CSharpVersion2”という新しく追加されたパラメータ値を指定します)。
なお、ここでは-TypeDefinitionパラメータを用いてクラス全体を記述しましたが、この例のように列挙体も定義してそれをプロパティの型にするなどせず、すべて基本型のプロパティで完結するのならば、-MemberDefinitionパラメータを使ってメンバ定義だけを行う方が記述が短くなります。以下はWinscript.Manというクラスを定義する例です。
Add-Type -Namespace Winscript -Name Man -MemberDefinition @" public int Age {get;set;} public string Name {get;set;} "@ -Language CSharpVersion3
例のようにC#のコード内には特にロジックを記述せず、単にデータの入れ物となるクラスにとどめておくのが良いかと思います。別にロジックを書いてもいいのですが、ISEで記述する限りはC#の編集に関してはただのテキストエディタレベルの恩恵しか受けないですし、それなら最初からVisual Studio使ってC#で全部コマンドレットとして書けばいいのに、ともなりかねないので。PowerShellでは実現困難な処理などがあればそれをメソッドとして書く程度ならいいかもしれません。ただしメソッドを記述してもそれをユーザーに直接使わせるというよりも、関数でラップして使わせる形が望ましいでしょう。
さて、次はこのクラスのオブジェクトを扱う関数を記述していきます。
定義した型のオブジェクトを扱う関数の記述
ここでは3つの関数を定義しています。Get-Drive関数はシステムに含まれるすべての論理ドライブを取得、Show-Drive関数は指定のDriveオブジェクトをエクスプローラで開く、Set-Drive関数は指定のDriveオブジェクトのボリューム名(VolumeNameプロパティ)を変更するものです。
ちなみに関数の動詞部分(ここではGet, Show, Set)は、Get-Verb関数で取得できるリスト以外のものは基本的に使わないようにします。モジュールに組み込んだ場合、インポートのたびに警告が出てしまうので。
関数の基本については前回に書いているので、今回のコードはそれを踏まえて読んでみてください。
function Get-Drive { [OutputType([Winscript.Drive])] param( [string[]]$Name, [Winscript.DriveType]$Type ) Get-WmiObject -Class Win32_LogicalDisk | ForEach-Object { if($null -ne $Name -and $Name -notcontains $_.Name) { } elseif($Type -ne $null -and $_.DriveType -ne $Type) { } else { New-Object Winscript.Drive -Property @{ Name = $_.Name VolumeName = $_.VolumeName Type = [enum]::Parse([Winscript.DriveType],$_.DriveType) RootPath = if($_.ProviderName -ne $null){$_.ProviderName}else{$_.Name + "\"} Size = $_.Size FreeSpace = $_.FreeSpace UsedSpace = $_.Size - $_.FreeSpace } } } }
(↑10:33 foreachステートメントではなくForEach-Objectコマンドレットを使うように修正。Get-*な関数のようにパイプラインの先頭で実行する関数でも、内部でPowerShellのコマンドレットや関数の出力を利用する場合は、配列化してforeachするよりも、ForEach-Objectで出力を逐次処理した方が良いですね。内部関数の出力がすべて完了してから一気に出力するのではなく、内部関数が1個オブジェクトを出力するたびに出力するようにできるので。)
function Show-Drive { [OutputType([Winscript.Drive])] param( [Parameter(ValueFromPipeline=$true,Mandatory=$true)] [Winscript.Drive[]] $Drive, [switch] $PassThru ) process { foreach($d in $Drive) { Start-Process $d.Name if($PassThru) { $d } } } }
function Set-Drive { param( [Parameter(ValueFromPipeline=$true,Mandatory=$true)] [Winscript.Drive] $Drive, [Parameter(Mandatory=$true)] [string] $VolumeName ) process { Get-WmiObject Win32_LogicalDisk -Filter "DeviceID='$($Drive.Name)'" | Set-WmiInstance -Arguments @{VolumeName=$VolumeName} | Out-Null } }
細かい説明は省きますが、前回説明した関数の基本フォーマットに、自分で定義した型を適用してロジックを書くとこうなる、という参考例としてとらえてください。
一つだけ前回に説明し忘れてたことがあります。それは[OutputType]属性です。これは文字通り、関数の出力型を指定するものです。この属性を指定しておくと何が嬉しいかというと、関数の出力を変数に代入したりWhere-Objectコマンドレットでフィルタをかけるコードを記述する際、関数の実行「前」にもプロパティ名をちゃんとタブ補完してくれるようになります。残念ながらこの静的解析機能はPowerShell 3.0からのものなので2.0だとできませんが、OutputType属性自体は2.0でも定義可能なので、定義しておくことを推奨します。
さて、型の定義と関数の定義をしたので実際に関数を実行してみます。
PS> Get-Drive # 全ドライブ取得 Name : C: VolumeName : Type : LocalDisk Size : 119926681600 FreeSpace : 12262494208 UsedSpace : 107664187392 RootPath : C:\ Name : D: VolumeName : Type : LocalDisk Size : 500086886400 FreeSpace : 198589583360 UsedSpace : 301497303040 RootPath : D:\ Name : Q: VolumeName : Type : CompactDisc Size : 0 FreeSpace : 0 UsedSpace : 0 RootPath : Q:\ Name : V: VolumeName : Type : NetworkDrive Size : 1500299390976 FreeSpace : 571001868288 UsedSpace : 929297522688 RootPath : \\server\D PS> Get-Drive | where {$_.Size -gt 1TB} # Where-Objectでフィルタ Name : V: VolumeName : Type : NetworkDrive Size : 1500299390976 FreeSpace : 571001868288 UsedSpace : 929297522688 RootPath : \\server\D PS> Get-Drive -Type NetworkDrive | Show-Drive -PassThru | ConvertTo-Csv #ネットワークドライブのみエクスプローラーで開く。取得結果はCSVとして出力。 #TYPE Winscript.Drive "Name","VolumeName","Type","Size","FreeSpace","UsedSpace","RootPath" "V:","","NetworkDrive","1500299390976","571001868288","929297522688","\\server\D" PS> Get-Drive -Name D: | Set-Drive -VolumeName 新しいドライブ # D:ドライブのボリューム名を指定。(管理者権限で)
関数をきちんとPowerShellの流儀に従って記述したおかげで、このようにPowerShellの他の標準コマンドレットと同様の呼び出し方ができ、自作関数やそれ以外のコマンド同士をうまくパイプラインで繋げて実行することができています。
さて、おそらく一つ気になる点があるとすれば、ドライブの容量表示が見づらいということでしょう。容量であればGBとかの単位で表示してほしいですし、大きい数字は,で桁を区切ってほしいですよね。じゃあそういう値を文字列で返すプロパティを定義してやる必要があるというかと言えばそんなことはなく、PowerShellには型に応じた表示フォーマットを指定する方法が用意されています。次回はそのあたりを解説しようと思います。
また、C#とかめんどくさいしもうちょっと楽な方法はないのか?ということで、最初の方でちょっと触れた、ユーザー定義オブジェクトを利用する方法も、余裕があれば次回に。
さて、PSアドベントカレンダー、明日はsunnyoneさんです。よろしくお願いします!
2011/05/16
連想配列を変換してユーザー定義オブジェクトを簡単に作成する
昨日の記事で取り上げたJavaScriptSerializerを用いると、連想配列から楽にJSONを作成できることが分かったのですが、この記事を書いていて思ったのは、「PowerShellの連想配列って意外に使えるな」という点でした。
現在のところ、PowerShellは独自のクラスを記述する方法がありません(Add-Typeコマンドレットを用いてC#などでクラスを書いて利用することはできますが)。Add-Memberコマンドレットを用いると、既存のオブジェクトに対し、任意のプロパティやPowerShellスクリプトで記述したメソッドを追加することはできます。素のオブジェクトであるPSObjectをNew-Objectして作ったオブジェクトでもこれは可能なので、一応ユーザー定義オブジェクトを作ることは可能です。ですが、Add-Memberコマンドレットを使うのはちょっとめんどくさいです。
「Windows PowerShellインアクション」ではAdd-Memberを使いPowerShellの関数を駆使してクラス定義構文のようなものを実装した例はありますが、いささか大仰な感は否めません。
しかし連想配列をユーザー定義オブジェクト代わりに使うと、簡単にできますしそこそこ便利に使えます。
連想配列をオブジェクトの代わりにすることのメリットとデメリット
連想配列をオブジェクトの代わりにすることのメリットは以下の三点があるかと思います。
- 簡単な記述(連想配列のリテラル)でオブジェクトが作成できる
PowerShellの連想配列リテラル@{}を使うことで、簡単に記述できます。またそれを配列化するのも@()を使うと容易です。$pcItems= @( @{ code=25; name="ハードディスク2TB"; price=7000; }, @{ code=56; name="メモリ8GB"; price=8000; } )
- ドット演算子で値の参照、設定ができる
PowerShellの連想配列は「連想配列[キー名]」のほかに、「連想配列.キー名」でもアクセスできる。Write-Host $pcItems[1].name # 値の参照 $pcItems[1].name = "test" # 値の設定 $pcItems[0].maker = "Seagate" # 要素の追加
- 連想配列の配列に対してWhere-Objectコマンドレットでフィルタをかけることができる
これは2とも関係しているのですが、通常のオブジェクトと同様にWhere-Objectコマンドレットでのフィルタ、ForEach-Objectコマンドレットでの列挙が可能です。$pcItems|?{$_.price -gt 7000}|%{Write-Host $_.name}
このようにメリットはあるのですが、本物のオブジェクトではないのでそれに起因するデメリットがいくつかあります。
- 要素(プロパティ)をいくらでも自由に追加できてしまう
これはメリットではあるのですが、デメリットでもある点です。後述するデメリットのせいで、同じキーをもつ連想配列の配列を作ったつもりでも、どれかのキー(プロパティ名)を間違えていた場合、それを検出するのが困難です。 - メソッドがうまく記述できない
連想配列要素にスクリプトブロックを指定し、&演算子で実行することでメソッド的なことはできます。しかしこのスクリプトブロック内では$thisが使えず、オブジェクトのプロパティにアクセスすることができないのでいまいちです。$pcItem= @{ name="ハードディスク2TB"; price=7000; getPrice={Write-Host $this.price}; } &$pcItem.getPrice # 何も表示されない。$thisが使えない # getPrice={Write-Host $pcItem.price}ならOKだが…
- Get-Member、Format-List、Format-Tableなどが使えない
これらのコマンドレットはあくまで連想配列オブジェクト(Hashtable)に対して行われるので、意図した結果になりません。たとえば$pcItems|Format-Listした場合、Name : name Value : ハードディスク2TB Name : code Value : 25 Name : price Value : 7000 Name : name Value : メモリ8GB Name : code Value : 56 Name : price Value : 8000
こんな表示になってしまいます。
連想配列をユーザー定義オブジェクトに変換する関数ConvertTo-PSObject
このように、連想配列の記述のお手軽さは捨てがたいものの、いくつかの問題点もあるのが現実です。そこで連想配列のお手軽さを生かしつつ、ユーザー定義オブジェクトの利便性も取るにはどうすればいいか考えました。結論は、「連想配列を変換してユーザー定義オブジェクトにする関数を書く」というものでした。それが以下になります。
#requires -version 2 function ConvertTo-PSObject { param( [Parameter(Mandatory=$true, ValueFromPipeline=$true)] [System.Collections.Hashtable[]]$hash, [switch]$recurse ) process { foreach($hashElem in $hash) { $ret = New-Object PSObject foreach($key in $hashElem.keys) { if($hashElem[$key] -as [System.Collections.Hashtable[]] -and $recurse) { $ret|Add-Member -MemberType "NoteProperty" -Name $key -Value (ConvertTo-PSObject $hashElem[$key] -recurse) } elseif($hashElem[$key] -is [scriptblock]) { $ret|Add-Member -MemberType "ScriptMethod" -Name $key -Value $hashElem[$key] } else { $ret|Add-Member -MemberType "NoteProperty" -Name $key -Value $hashElem[$key] } } $ret } } }
ご覧のようにコード的には割にシンプルなものが出来ました。連想配列またはその配列をパラメータにとり、またはパイプラインから渡し、連想配列要素をプロパティまたはメソッドに変換してPSObjectにAdd-Memberしてるだけです。-recurseパラメータを付けると連想配列内に連想配列がある場合に再帰的にすべてPSObjectに変換します。
それでは実際の使用例を挙げます。
# 一番単純な例。パラメータに連想配列を渡すとPSObjectに変換する。 $book = ConvertTo-PSObject @{name="Windows PowerShell ポケットリファレンス";page=300;price=2000} Write-Host $book.name # 「Windows PowerShell ポケットリファレンス」と表示 $book.name="test" # プロパティに値をセットする Write-Host $book.name # 「test」と表示 #$book.size="A5" # 存在しないプロパティに値を代入しようとするとエラーになる # 連想配列をコードで組み立てていく例。 $mutaHash=@{} # 空の連想配列を作る $mutaHash.name="mutaguchi" # キーと値を追加 $mutaHash.age=32 $mutaHash.introduce={Write-Host ("私の名前は" + $this.name + "です。")} # スクリプトブロックを追加 $mutaHash.speak={Write-Host ($args[0])} # パラメータを取るスクリプトブロックを追加 $muta = $mutaHash|ConvertTo-PSObject # 連想配列はパイプラインで渡すことができる $muta.introduce() # 「私の名前はmutaguchiです。」と表示 $muta.speak("こんにちは。") # 「こんにちは。」と表示 # 連想配列の配列→PSObjectの配列に変換 $stationeryHashes=@() $stationeryHashes+=@{name="鉛筆";price=100} $stationeryHashes+=@{name="消しゴム";price=50} $stationeryHashes+=@{name="コピー用紙";price=500} $stationeryHashes+=@{name="万年筆";price=30000} $stationeries = ConvertTo-PSObject $stationeryHashes # "200円以上の文具を列挙" $stationeries|?{$_.price -ge 200}|%{Write-Host $_.name} # 「コピー用紙」と「万年筆」が表示 # 連想配列の配列をリテラルで一気に記述する $getPrice={Write-Host $this.price} # 共通のメソッドを定義 $pcItems= @( @{ code=25; name="ハードディスク2TB"; price=7000; getPrice=$getPrice }, @{ code=56; name="メモリ8GB"; price=8000; getPrice=$getPrice }, @{ code=137; name="23インチ液晶ディスプレイ"; price=35000; getPrice=$getPrice } )|ConvertTo-PSObject $pcItems[1].getPrice() # 「8000」と表示 $pcItems|Format-List <# 表示: name : ハードディスク2TB code : 25 price : 7000 name : メモリ8GB code : 56 price : 8000 name : 23インチ液晶ディスプレイ code : 137 price : 35000 #> # 連想配列の中に連想配列を含めたもの→PSObjectをプロパティの値に持つPSObject $blog= @{ utl="http://winscript.jp/powershell/"; title="PowerShell Scripting Weblog"; date=[datetime]"2011/05/16 00:25:31"; keywords=@("スクリプト","PowerShell","WSH"); # 配列を含めることもできる author=@{name="mutaguchi";age=32;speak={Write-Host "ようこそ私のブログへ"}} # 連想配列を含める }|ConvertTo-PSObject -recurse # -recurseパラメータを指定すると再帰的にすべての連想配列をPSObjectに変換する $blog.author.speak() # 「ようこそ私のブログへ」と表示 Write-Host $blog.keywords[1] # 「PowerShell」と表示 # ※配列要素に連想配列以外の値が含まれている場合は展開しない
このように簡単な関数一つで、連想配列にあった問題点をすべて解消しつつ簡単な記述で独自のオブジェクトを記述できるようになりました。おそらくかなり便利だと思いますのでぜひ使ってみてください。
余談:ScriptPropertyを使う場合
余談ですが、今回使用したNotePropertyはプロパティに代入できる型を指定したり、リードオンリーなプロパティを作ったりすることができません。そういうのを作りたい場合はScriptPropertyを使います。Add-Memberコマンドレットの-valueパラメータにゲッターを、-secondValueパラメータにセッターをそれぞれスクリプトブロックで記述します。
しかしこいつはあまりいけてないです。これらのスクリプトブロック内で参照するフィールドを別途Add-MemberでNotePropertyを使って作成する必要があるのですが、これをprivateにすることができません。よってGet-Memberでもばっちり表示されてしまいますし、フィールドを直接書き換えたりもできてしまいます。
また今回のように連想配列をPSObjectに変換する場合はprivateフィールド名も自動生成する必要があるのですが、それをScriptProperty内のゲッター、セッターから取得する方法がなく、たぶんInvoke-Expressionを使うしかありません。
これらを踏まえて元の連想配列要素の値の型を引き継ぎ、それ以外の型を代入できないようにしたScriptPropertyバージョンも一応書いてみました。ConvertTo-PSObject関数のelse句の部分を以下に置き換えます。
#$ret|Add-Member -MemberType "NoteProperty" -Name ("_" +$key) -Value $hash[$key] "`$ret|Add-Member -MemberType ScriptProperty -Name $key -Value {[" + $hash[$key].gettype().fullname + "]`$this._" + $key + "} -SecondValue {`$this._" + $key + "=[" + $hash[$key].gettype().fullname + "]`$args[0]}"|iex
まあこれはいまいちなんで参考程度に。
2012/08/23追記
この記事を書いた時は知らなかったのですが、実は単にNotePropertyだけを持つユーザー定義オブジェクトを作成するのであれば、もっと簡単な方法があります。
# PowerShell 1.0 $o=New-Object PSObject|Add-Member noteproperty Code 137 -pass|Add-Member noteproperty Name 23インチ液晶ディスプレイ -pass # PowerShell 2.0 $o=New-Object PSObject -Property @{Code=137;Name="23インチ液晶ディスプレイ"} # PowerShell 3.0 $o=[pscustomobject]@{Code=137;Name="23インチ液晶ディスプレイ"}
3つのコードはほぼ等価です。PowerShell 2.0と3.0では連想配列リテラルを用いて簡単にカスタムオブジェクトを作れるようになりました。
元記事:http://blogs.wankuma.com/mutaguchi/archive/2011/05/16/199086.aspx
Copyright © 2005-2018 Daisuke Mutaguchi All rights reserved
mailto: mutaguchi at roy.hi-ho.ne.jp
プライバシーポリシー