2016/01/11
関数内でのリソース解放処理
注:最後に書きましたが、この記事の内容には未解決問題が残っています。
はじめに
前回は、パイプラインを下流の関数内で打ち切る方法について説明しました。
今回は逆に、下流でパイプラインが打ち切られた場合、上流の関数ではどう対応すべきなのか、特にリソース解放処理を焦点にして考察してみます。
パイプラインが打ち切られるケース
前回も説明しましたが、パイプライン内の関数またはコマンドレットで何らかの例外が発生すると、パイプライン処理がその時点で打ち切られます。パイプライン処理が打ち切られると、後続のprocessブロックのみならず、パイプラインに含まれるすべてのendブロックの実行もスキップされてしまいます。
ところでコマンドレットや関数では何かエラーが発生した場合、コマンドレットではWriteErrorメソッド、関数ではWrite-Errorコマンドレットを使ってエラーストリームに、生の例外オブジェクトをラップしたErrorRecordを出力し、呼び出し側のErrorActionの設定にエラー時の処理を委ねるのが基本です。
呼び出し時のErrorAction指定がContinue、SilentlyContinue、Ignoreの場合は、パイプラインが中断することはありませんが、StopやInquireで中断した場合は例外(ActionPreferenceStopException)がthrowされ、パイプラインは打ち切られます。
(ちなみにv3からはStopで中断した場合は、コマンドレットがエラーストリームに書き出したErrorRecordに含まれるExceptionがthrowされる)
また、継続不能エラーが発生(ThrowTerminatingErrorメソッド)したり、.NETの生の例外がそのままthrowされたり(お行儀が悪いですが)、breakステートメント(FlowControlException)が実行されたり、Select-Object -First(StopUpstreamCommandsException)が実行された場合も、同様にパイプラインは打ち切られます。
つまり、下流のコマンドでパイプラインが打ち切られるケースというのは色々あり得るので、endブロックというのは実行が確約されたものでは全くない、ということに留意しておく必要があります。
関数内のリソース解放処理
確実に実行したい後処理というのは色々あると思いますが、特に確保したリソースの解放というのは確実に実行してもらわないと困ります。
しかし、前述のような背景があるので、何らかのリソースを用いる関数を書く際に、beginブロックでリソースを確保し、processブロックでリソースを利用し、endブロックでリソースを解放する、ということは基本はNGということになります。
この点、コマンドレットクラスであれば、IDisposableインターフェースを実装しておけば、コマンドレット終了時にDisposeメソッドをPowerShellが呼んでくれるので、その中にリソース解放処理を記述しておけばOKです。しかし関数ではこの手法が使えないので、代替案を考える必要があります。
パイプライン処理の後始末をしよう - 鷲ノ巣であえとす氏が考案した、beginブロックに後処理用の関数を定義しておく方法では、同じ関数内のprocessブロックで発生したエラーをcatchしてリソース解放処理を走らせることは可能です。が、残念ながら下流で発生した例外をcatchすることはできず、その場合は後処理がスキップされてしまいます。
リソース解放処理を含めた関数
あえとす氏の方法を若干アレンジして、下流で例外が発生した場合も確実にリソース解放の後処理を走らせる方法を考えてみました。以下にコードを示します。
※クラス構文を使ってますが、これは単に、Disposeできるオブジェクトのサンプルだと思ってください。
class SomeResource : IDisposable { [void]Dispose() { # ここで何らかのリソース解放処理を行ったものとする } } function Write-OutputWithResource { [CmdletBinding()] param([Parameter(ValueFromPipeline)][psobject[]]$InputObject) begin { $resource = New-Object SomeResource # 後で解放する必要のある何らかのリソース確保 function Clear-Resource { # リソースの解放処理 $resource.Dispose() } } process { try { $processing = $true Write-Verbose "output_start: $InputObject" $InputObject # パイプライン出力 Write-Verbose "output_end: $InputObject" $processing = $false } catch { # try内で例外が発生した場合はそのまま再スロー throw } finally { if($processing) { Write-Verbose "resource_dispose (on error)" Clear-Resource } Write-Verbose "output_finally: $InputObject" } } end { Write-Verbose "resource_dispose (at end)" Clear-Resource } }
processブロック内のtryブロックでパイプライン下流に値を出力したとき、下流で例外が出てもcatchブロックが実行されないので、代わりに、必ず実行されるfinallyブロックから後処理を呼び出すようにしてみました。
ただし、パイプライン下流で例外が発生しなかった場合には、processブロック内ではリソース解放処理はしたくないので、例外発生の有無を$processingという変数の値を見ることで確認しています。もしパイプライン出力したあと下流で例外が出ていれば、$processingの値は$trueのままになるので判断可能です。
パイプラインが中断することなく、最後まで実行される場合は、endブロック内でリソース解放処理を行います。
同じ関数内で例外が発生したときのリソース解放処理についても、$processing = $trueと$processing = $falseの間に例外が発生する可能性のある処理を記述した上で、catchブロックで再throwすれば、併せて対応できるのではないかと思います。(それ用のtry..catchを記述してもいいですが)
関数の実行例
PS> 1..3 | Write-OutputWithResource -Verbose | Select-Object -First 2 詳細: output_start: 1 1 詳細: output_end: 1 詳細: output_finally: 1 詳細: output_start: 2 2 詳細: resource_dispose (on error) 詳細: output_finally: 2
このように、下流でパイプライン打ち切りがあるとendブロックは実行されませんが、リソース解放処理は、きちんとprocessブロック内のfinallyブロックから呼び出されています。
PS> 1..3 | Write-OutputWithResource -Verbose 詳細: output_start: 1 1 詳細: output_end: 1 詳細: output_finally: 1 詳細: output_start: 2 2 詳細: output_end: 2 詳細: output_finally: 2 詳細: output_start: 3 3 詳細: output_end: 3 詳細: output_finally: 3 詳細: resource_dispose (at end)
もちろんパイプラインが最後まで正常に実行された場合も、ちゃんと最後にendブロックでリソース解放が行えるようになっています。
おわりに
本当に、こうするしかないんですかね…?
PowerShellにもリソース利用のusingステートメント欲しいです、が、begin, process, endにまたがって機能するusingってどういう構文になるんでしょうね。
(14:22追記)と、ここまで書いておいて、この方法では下流で発生した例外には対処できますが、上流で例外が発生した場合はリソース解放が実行されないという問題に気付きました…。どうすればいいんだ…。
2015/11/09
JapanesePhoneticAnalyzerを使ってPowerShellで形態素解析(後編)
分かち書きとは
中編で作ったGet-JpYomi関数は、JapanesePhoneticAnalyzerクラスの読み仮名取得機能にフォーカスを当てたラッパー関数でした。
今回は、JapanesePhoneticAnalyzerクラスの最大の使用目的と思われる、「分かち書き」を目的とした関数を作成します。分かち書きとは、文章を文節単位で分割することと考えて頂いて良いかと思います。
前々回作ったGet-JpWordは単語単位の分割を行うものでしたが、読みやすさや発音のしやすさを目的として文章を分割表記する場合は、単語単位では細かすぎると言えます。
よって単語単位ではなく、文を意味のあるまとまりとして区切ることのできる最小の単位である、文節単位で分割する方法を考えてみます。
Split-JpText関数
前編で作ったGet-JpWord関数をラップし、分かち書きに特化した関数Split-JpTextを作成しました。まずは以下にコードを示します。
function Split-JpText { param( [parameter(ValueFromPipeline=$true)] [PSObject[]] $InputObject, [ValidateSet("Text", "Yomi", "Detail")] [string] $Format = "Text", [ValidateSet("ByWord", "ByPhrase")] [string] $SplitMode = "ByPhrase", [string] $Separator = " ", [switch] $ToArray ) begin { if($Format -eq "Detail"){$ToArray = $true} } process { foreach($o in $InputObject) { $o.ToString() | Get-JpWord | foreach -Begin { $phrases = @() $phrase = $null } -Process { if($_.IsPhraseStart) { if($phrase){$phrases += $phrase} $phrase = New-Object psobject | Add-Member -MemberType ScriptProperty -Name Text -Value { -join $this.Words.DisplayText} -PassThru | Add-Member -MemberType ScriptProperty -Name Yomi -Value { -join $this.Words.YomiText} -PassThru | Add-Member -MemberType NoteProperty -Name Words -Value @() -PassThru } $phrase.Words += $_ } -End { if($phrase){$phrases += $phrase} if($SplitMode -eq "ByPhrase") { $out = switch($Format) { "Text" {$phrases.Text} "Yomi" {$phrases.Yomi} "Detail" {$phrases} } } else { $out = switch($Format) { "Text" {$phrases.Words.DisplayText} "Yomi" {$phrases.Words.YomiText} "Detail" {$phrases.Words} } } if($ToArray) { $out } else { $out -join $Separator } } } } }
パラメータの説明
パラメータ名 | 型 | 説明 |
InputObject | 任意の型 | 入力テキスト。文字列以外の型の場合は文字列に変換して評価される。パイプライン入力可能。 |
Format | string | Text(デフォルト):文字列のみ出力する。 Yomi:文字列ではなく読みを出力する。 Detail:文節の文字列、読み、各文節に含まれる単語の配列を含んだオブジェクトの配列を出力する。(SplitMode=ByPhraseの時のみ) |
SplitMode | string | ByPhrase(デフォルト):文を文節単位で分割する。 ByWord:文を単語単位で分割する。 |
Separator | string | 分割文字を指定。デフォルトは" "(半角スペース)。(Format=DetailもしくはToArray指定時には無効) |
ToArray | switch | 指定すると、単一の文字列ではなく、文字列の配列を出力する。 |
使用法
- 分かち書き(文節)
例:Split-JpText "今日はいい天気ですね。"
出力:今日は いい 天気ですね 。 - 分割文字指定
例:Split-JpText "今日はいい天気ですね。" -Separator /
出力:今日は/いい/天気ですね/。 - 分かち書き(単語)
例:Split-JpText "今日はいい天気ですね。" -SplitMode ByWord
出力:今日 は いい 天気 です ね 。 - 文節単位で読み仮名を表示
例: Split-JpText "今日はいい天気ですね。" -Separator / -Format Yomi
出力:きょうは/いい/てんきですね/。 - 分かち書きした文節を文字列配列として変数に格納
例:$phrases = Split-JpText "今日はいい天気ですね。" -ToArray
解説
ちょっと長めの関数ですが、ポイントはJapanesePhoneticAnalyzerクラスのGetWordsメソッドが返すJapanesePhonemeオブジェクトのIsPhraseStartプロパティです。
IsPhraseStartプロパティは、当該単語(Phoneme)が文節(Phrase)の開始部分にあたる単語であればTrueを返します。すなわち、JapanesePhonemeコレクションを文頭から文末まで列挙していったとき、IsPhraseStartプロパティがFalseからTrueに変わる部分が文節の境界になるわけです。
Split-JpText関数では、単語を列挙していき、文頭もしくは文節の境界に遭遇すると、文節に含まれる文字列(Textプロパティ)とその読み(Yomiプロパティ)と単語の配列(Wordsプロパティ)を格納するオブジェクトを新たに作成し、$phrase変数に代入します。一方で$phrase変数に元々入っていたオブジェクトは、$phrases配列に追加します。
$phraseオブジェクトのWordsプロパティには、列挙中の単語を都度、追加していきます。
なお、$phraseオブジェクトのTextプロパティとYomiプロパティはスクリプトプロパティとして定義しておき、必要時に値を取得するようにしてあります。
まとめ
3回に渡って、JapanesePhoneticAnalyzerクラスの使用法を具体的なラッパー関数を作成して紹介しました。
個人的には、PowerShellからなら中編で挙げた、読みの取得が一番使いでがあるかな?と思いました。今回取り上げた分かち書きは、意外と応用例が思いつきませんでした。
前編のGet-JpWord関数を使って、何らかの文書群の単語リストをあらかじめインデックスとして出力しておき、単語検索コマンドを実装するのも面白そうですね。
ただ、残念ながら品詞情報が取れないので、JapanesePhoneticAnalyzerをmecabとかの形態素解析エンジンの代替にするのはちょっと厳しいかもしれないです。まあ、標準機能のみでちょっとしたものを作れるのは大きいかと思います。何か日本語の文章を解析する必要があるときには使ってみてはいかがでしょうか。
2015/10/17
JapanesePhoneticAnalyzerを使ってPowerShellで形態素解析(前編)
はじめに
がりっち氏がWindows10 UWPに日本語解析のAPIが備わっていた件 | garicchi.com というエントリを上げていました。
実はWin10に限らず、Win8.1 / Server 2012R2以降であれば、Windows ランタイム(WinRT)のWindows.Globalization名前空間に含まれるJapanesePhoneticAnalyzerクラスを用いた形態素解析ができます。
形態素解析とは要するに文字列を単語(正確には形態素という、文字列の最小構成要素)ごとに分割し、それぞれの単語の品詞を判別する処理になります。(JapanesePhoneticAnalyzerクラスだと分割までで、品詞の情報は取得できない?ようですが…)
またJapanesePhoneticAnalyzerでは分割した単語の読み仮名を取得することができます。
WinRTならPowerShellからも使えるんじゃないかなーと思ってやったらできたので、紹介します。
WinRTのPowerShellからの利用法
WinRTについての説明は他サイト様に譲りますが、要はWindowsストアアプリやUWP(ユニバーサルWindowsプラットフォーム)アプリを動作させる実行環境とAPI群です。
じゃあデスクトップアプリであるPowerShellは関係ないのかというとそうではなくて、例えばストアアプリのサイドローディングを行うAppxモジュールというものがあります。
つまりWinRTは従来のデスクトップアプリからの相互運用もできるようになっています。(すべてのコンポーネントではない)
このあたりの話は、荒井さんの記事が参考になるかと思います。:特集:デスクトップでもWinRT活用:開発者が知っておくべき、ライブラリとしてのWindowsランタイム (1/5) - @IT
PowerShellからWinRTを利用するには.NET Frameworkに含まれるクラスを利用するのと基本は同じです。
ただし注意点としては、クラス名を指定する時は、クラスの「アセンブリ修飾名」を指定する必要があります。
今回の例ではJapanesePhoneticAnalyzerクラスを使いますが、アセンブリ修飾名はWindows.Globalization.JapanesePhoneticAnalyzer, Windows.Globalization, Version=255.255.255.255, Culture=neutral, PublicKeyToken=null, ContentType=WindowsRuntime
となります。
このうち必須となるのは
Windows.Globalization.JapanesePhoneticAnalyzer:クラスの完全修飾名
Windows.Globalization:クラスの含まれる名前空間
ContentType=WindowsRuntime:WinRTのコンポーネントであること
の3つだけのようです。
つまり、PowerShellからは
[Windows.Globalization.JapanesePhoneticAnalyzer, Windows.Globalization, ContentType=WindowsRuntime]
とすればクラスを参照することができます。
ちなみに任意の型のアセンブリ修飾名を知るには、[型名].AssemblyQualifiedName のようにすればOKです。
なお、WinRTにはPowerShellからも利用価値の高いクラスが他にも色々あるようです。ぎたぱそ氏が認証系のクラスについて書かれていますので、参考にしてみてください。:PowerShell も Windows Store Apps 同様に Windows.Security.Credentials namespace を使って認証情報を管理できるようにしてみる - tech.guitarrapc.com
単語を分割する
早速、形態素解析をやってみましょう。具体的にはJapanesePhoneticAnalyzerのGetWordsメソッドを呼び出すだけです。
すべての基本になるので軽く関数としてラップしておきます。
function Get-JpWord { param( [parameter(ValueFromPipeline=$true)] [ValidateLength(1,99)] [string[]] $Text, [switch] $MonoRuby ) process { foreach($t in $Text) { [Windows.Globalization.JapanesePhoneticAnalyzer, Windows.Globalization, ContentType=WindowsRuntime]::GetWords($t, $MonoRuby) } } }
GetWordsメソッドはスタティックメソッドなので、::演算子で呼び出します。戻り値はIReadOnlyList<JapanesePhoneme>というコレクションです。
GetWordsメソッドの第2引数にTrueを指定すると、漢字の含まれた単語をルビの振れる最小単位にまで分割する、Mono Rubyモードが有効になります。
なお、GetWordsメソッドはどうも文字数制限があるようです。だいたい100文字を超えると何も出力しない感じです。この制限値はリファレンスに書いてないようなので詳細不明ですが、一応関数では99文字までという制限を入れておきました。
例えば、Get-JpWord "最近急に寒くなってきました。" のようにすると結果は以下のように表示されます。
DisplayText IsPhraseStart YomiText ----------- ------------- -------- 最近 True さいきん 急に True きゅうに 寒くな True さむくな って False って き True き ました False ました 。 True 。
出力されるJapanesePhonemeオブジェクトは3つのプロパティを持ちます。
DisplayText | 分割された単語 |
IsPhraseStart | 単語が文節の開始であるかどうか |
YomiText | 単語の読み仮名 |
このように、入力した文章を単語単位に分割し、それぞれの単語の読み仮名を取得することができます。ただこれだけだと、「で、どうしろと」という感じなので、この出力結果を利用する、より実用的な関数を書いていきましょう。
長くなったので次回に続く。
2015/06/14
わんくま同盟大阪勉強会#63「PowerShell DSCリソースを書いてみよう」資料公開
わんくま同盟大阪勉強会#63でのセッション資料を公開します。
デモで使用したサンプルスクリプトも併せてご利用ください。
わんくま同盟の勉強会は今回の大阪#63で10年目に入ったのですが、実は私も9年前の大阪#4で勉強会セッションデビューをしていたりします。
さて、今回はPowerShell DSCリソースを作成するというテーマで話しました。DSCでは管理対象ごとにロジック(リソース)と設定(Configuration)を分離でき、一貫性を持ったインフラ構成の自動化が可能になる素敵な機能です。が、いかんせん、ビルトインリソース(OS標準で含まれるリソース)の種類が少ないので、実際の業務で使うにはカスタムリソースを作成する必要が出てくると思います。
今回のデモでは、テキストファイルの中身を自動構成するという、ごく単純なサンプルを作成して実演してみましたが、考え方や実装方法の基本はこれでカバーできるのではないかと思います。
より詳しくは、ぎたぱそ氏の記事を読んでいただければ良いかと思います。本番で使えるPowerShell DSCリソース作成入門 - Build Insider
サンプルスクリプトの説明
-
事前準備
今回のデモはWin10 Insider Preview(PowerShell 5.0)上で行いましたが、PowerShell 4.0環境でもおそらく動作すると思います。なお、今回のConfigurationはローカルコンピュータに対しPush適用(Start-DscConfigurationコマンドレットによる手動適用)することを想定しています。あらかじめ、DSCが実行可能な環境(スクリプト実行ポリシー、PSリモーティング、Local Configuration Managerの設定等)を整えておいてください。また、スクリプトはすべて管理者権限で実行してください。
-
xDSCResourceDesignerのインストール
DSCリソースのひな形を作成するためのxDSCResourceDesignerをインストールします。v5環境であればPowerShellGetを用い、Install-Module xDSCResourceDesigner で入ります。v4環境の場合はTechnetからDSC Resource KitをDLしてください。
-
xDSCResourceDesignerの使用方法の確認
xDSCResourceDesignerの使用方法を確認します。make_Foo_resource_template.ps1を実行すると、xDSCResourceDesignerを用いてDSCリソースFooのひな形が$env:ProgramFiles\WindowsPowerShell\Modules\TestResourceに作成されます。ひな形がどのように作成されるかを確認してください。また、Get-DscResource -Name Fooとして、DSCリソースがきちんと認識されているか、確認してください。
-
TextFileLineリソースの作成
今回のデモで作成したTextFileLineリソースは、make_TextFileLine_resource_template.ps1を実行してまずひな形を作成しました。作成されたひな形を用いて、TextFileLine.psm1に実際のロジックを記述し、DSCリソースを完成させました。zipに含まれるTestResourceフォルダの中身が、今回作成したDSCリソースモジュールになりますので、まずは内容を確認してみてください。特に、Set-TargetResource関数はどのように実装すると冪等性を保持して作成できるのかを念頭に置いてみてください。
-
TextFileLineリソースの展開
zipに含まれるTestResourceフォルダを$env:ProgramFiles\WindowsPowerShell\Modules\の下にコピーしてください。
Get-DscResource -Name TextFileLineとしてDSCリソースが認識されていることを確認してください。
-
TextFileLineリソースを用いたConfigurationの作成
start_dsc_configuration.ps1に含まれる、TextFileLineTestが、今回適用してみるConfigurationになります。
start_dsc_configuration.ps1を実行すると、ドキュメントフォルダにmofファイルを生成し、Start-DscConfigurationコマンドレットにより設定を反映させます。
正しくConfigurationが適用されれば、ドキュメントフォルダにlist.txtというファイルが生成し、中にプログラム言語のリストが記入されているはずです。
-
Configurationが反映されたことを確認
Test-DscConfigurationコマンドレットを実行すると、現在の状態とConfigurationに書かれた状態が一致していればTrueと表示されます。今はConfigurationを適用した直後なのでTrueになるはずです。
またGet-DscConfigurationコマンドレットを実行すると、現在の各プロパティの状態を表示してくれます。
list.txtに含まれる行をテキストエディタで編集して上書きしたりすると、Test-DscConfigurationの結果はFalseになるはずです。
list.txtを手動で変更した状態で、再度start_dsc_configuration.ps1を実行すると、再びConfiguration通りの状態に戻ると思います。その際、変更のなかったプロパティに関しては、処理がスキップされていることをログをみて確認してください。
-
その他
Configurationを色々書き換えて試してください。例えばEnsure="Absent"にすると対象項目が存在しない状態になります。
2014/12/24
PowerShellで位置情報を取得する
はじめに
この記事はPowerShell Advent Calendar 2014の24日目の記事です。
今回は、Windows 8から追加されたOSの機能である、「Windows 位置情報プラットフォーム」をPowerShellから呼び出して、位置情報(緯度、経度)を取得してみよう、という話になります。
Windows 位置情報プラットフォームとは
Windows 8から、「Windows 位置情報プラットフォーム」という機能が追加され、アプリケーションから現在位置情報(緯度、経度など)をAPIで取得できるようになっています。
Windows 位置情報プラットフォームでは、位置情報をGPSがあればGPSから、なければWi-Fiの位置情報あるいはIPアドレスなどから推定して取得します。すなわち、GPSがない場合でも位置情報を取得できる、いわば仮想GPSの機能がデフォルトで備わっているのがミソです。
(注:Windows 7にも「Windows センサー&ロケーションプラットフォーム」というのがありましたが、OSデフォルト機能としては仮想GPSはありませんでした。今は亡き、Geosense for Windowsというサードパーティー製アプリを追加すると仮想GPS使えたんですけどもね。あとWindows Phone?知らない子ですね…)
PowerShellでWindows 位置情報プラットフォームを利用する
さて、Windows 位置情報プラットフォームをPowerShellで使うには、.NET4.0以上に含まれている、System.Device.Location名前空間配下に含まれるクラスの機能を用います。アセンブリ名としてはSystem.Deviceとなります。
以下のような関数Get-GeoCoordinateを定義します。
Add-Type -AssemblyName System.Device function Get-GeoCoordinate { param( [double]$Latitude, [double]$Longitude ) if(0 -eq $Latitude -and 0 -eq $Longitude) { $watcher = New-Object System.Device.Location.GeoCoordinateWatcher $sourceId = "Location" $job = Register-ObjectEvent -InputObject $watcher -EventName PositionChanged -SourceIdentifier $sourceId $watcher.Start() $event = Wait-Event $sourceId $event.SourceEventArgs.Position.Location Remove-Event $sourceId Unregister-Event $sourceId } else { New-Object System.Device.Location.GeoCoordinate $Latitude,$Longitude } }
関数実行前に、まずAdd-Type -AssemblyName System.Deviceを実行して必要なアセンブリをロードする必要があります。
関数本体ではまず、System.Device.Location.GeoCoordinateWatcherオブジェクトを生成します。このオブジェクトのStartメソッドを実行すると、Windows 位置情報プラットフォームにアクセスして、位置情報の変化を監視します。位置情報の変化を感知すると、PositionChangedイベントが発生し、取得した位置情報を、イベントハンドラの引数にGeoPositionChangedEventArgs<T>オブジェクトとして返します。
さて、PowerShellでは、.NETクラスのイベントを取得するには、Register-ObjectEventコマンドレットを用い、イベントを「購読」します。
イベントが発生するたびに何かの動作をする、というような場合では、Register-ObjectEvent -Action {処理内容}のようにして、イベントハンドラを記述するのが一般的です。が、今回は位置情報の変化の最初の一回(つまり、初期値の取得)さえPositionChangedイベントを捕まえればOKなので、-Actionは使用しません。
代わりにWait-Eventコマンドレットを用い、初回のイベント発生を待機するようにしています。Wait-Eventコマンドレットは、当該イベントを示すPSEventArgsオブジェクトを出力します。
PSEventArgsオブジェクトのSourceEventArgsプロパティには、当該イベントのイベントハンドラ引数の値(ここではGeoPositionChangedEventArgs<T>オブジェクト)が格納されているので、あとはそこから.Position.Locationと辿ることで、位置情報を格納したGeoCoordinateオブジェクトが取得できます。
(注:あとで知ったんですけど、GeoCoordinateWatcherクラスには、同期的に位置情報を取得するTryStartメソッドというのがあって、これを使えばイベント購読は実は不要でした…まぁいっか)
なお、関数のパラメータとしてLatitude(緯度)、Longitude(経度)を指定すると、現在位置ではなく、指定の位置を格納したGeoCoordinateオブジェクトを生成するようにしています。
Get-GeoCoordinate関数の使い方
事前にコントロール パネルの「位置情報の設定」で「Windows 位置情報プラットフォームを有効にする」にチェックを入れておきます。
あとはGet-GeoCoordinateをそのまま実行するだけです。
Latitude : 34.799999 Longitude : 135.350006 Altitude : 0 HorizontalAccuracy : 32000 VerticalAccuracy : NaN (非数値) Speed : NaN (非数値) Course : NaN (非数値) IsUnknown : False
このように現在位置が表示されるかと思います。といっても、緯度、経度が表示されたところでちゃんと取得できてるのかよく分からないので、以下のような簡単な関数(フィルタ)を定義しておきます。
filter Show-GoogleMap { Start-Process "http://maps.google.com/maps?q=$($_.Latitude),$($_.Longitude)" }
このフィルタを使うと、指定の緯度経度周辺の地図を、標準のWebブラウザで開いたGoogleマップ上に表示してくれます。使い方はこんな感じ。
Get-GeoCoordinate | Show-GoogleMap
現在位置が表示されましたでしょうか? 位置測定に用いたソースによってはkmオーダーでズレると思いますが、それでも何となく、自分がいる場所が表示されるのではないかと思います。
なお、先ほども書いたように、パラメータで任意の緯度、経度を指定することも可能です。この関数だけではあんまり意味を成しませんが…
Get-GeoCoordinate 35.681382 139.766084
まとめ
PowerShellでも「Windows 位置情報プラットフォーム」を使って現在位置が取れるよ、という話でした。あんまりPowerShellでSystem.Device.Locationとかを使っているサンプルを見かけないので、何かの参考になれば幸いです。あとPowerShellでのイベントの扱い方についても復習になるかと。
ところでこうやって取得した位置情報を使って、Web APIを呼び出して活用しよう、というようなネタを書くつもりだったんですが、長くなったんでまたの機会としましょう。ではでは。
2014/12/11
PowerShellでMMLシーケンサーを作ってみた(その1)
MMLとは
この記事はPowerShell Advent Calendar 2014の11日目の記事です。
突然ですが、MMLってご存知ですか? MMLとはMusic Macro Languageの略で、その名の通り音楽演奏データを記述するための言語です。BASICのPLAY文で使うあれです。MIDIファイルに変換するコンパイラもありましたよね。
たとえば、「ねこふんじゃった」の最初の部分をMMLで書くとこんな感じです。MMLはいろんな記法があるのですが、よくあるのはこういうのです。
e-d-<g-4>g-rg-4e-d-<g-4>g-rg-4e-d-<g-4>g-4<e-4>g-4<d-4>frf4 e-d-<d-4>frf4e-d-<d-4>frf4e-d-<d-4>f4<e-4>f4<g-4>g-rg-4
ドの音をc、レの音をd、のように以下シの音をbまでアルファベット音階で割り当てます。半音上げる(シャープ)場合は音名のあとに+、半音下げる(フラット)場合は-を付与します。音の長さは4分音符なら4、8分音符なら8と書きます。付点は数字のあとに.を付けます。数字省略時は8分音符と解釈するのが普通のようです。オクターブを上げる場合は>、下げる場合は<と書きます(コンパイラによっては逆の解釈をする)。休符はrです。
本物のMMLでは、音色の指定だとかトラックの割り当てだとか、もっとたくさん命令があるんですが、基本はだいたいこんなもんです。
PowerShellで音を鳴らすには
PowerShellで音を鳴らすには、.NETのSystem.Console.Beepメソッドを使うのが一番手っ取り早いです。ビープ音ですね。比較的古いWindowsではハードウェアのビープスピーカーから、比較的新しいWindowsではサウンドデバイス上で鳴ります。今回のMMLシーケンサーも結局はBeepメソッドです。
そしてぎたぱそ先生がずっと以前に書いておられます。なので今回のはまあ、MMLシーケンサー部分を除けば二番煎じなんですけどもね。(そしてSmallBasicLibraryを使えば実はMML演奏もできるので、車輪の再発明でもあるんですが)
ちなみにwavやmp3なんかを鳴らすには、Windows Media PlayerをCOM経由で実行する方法や.NET(WPF)のSystem.Windows.Media.MediaPlayerクラスを使う方法などがあります。
音程の決め方
Beepメソッドでは第1引数にビープ音の周波数をHzで、第2引数に再生時間をミリ秒で指定します。つまりは音程(音の高さ)はHzで指定する必要があります。ここでドの音は何ヘルツで、みたいな対応表をどこかから探してきてそのデータを使ってもいいんですが、今回はせっかくなので、PowerShellで計算して求めてみます。
まず、ある音程の一つ上のオクターブの音程の間の周波数比は、1:2です。
ピアノ等の鍵盤楽器が近くにあれば、それを見てもらえば分かると思いますが、1オクターブには12の音程が含まれています。1オクターブの周波数比を12個均等に分割します(この周波数の決め方を平均律といいます)。つまり、隣り合う音程の周波数比は、1:12√2となるわけです。
さて、音程の周波数比はこれでわかりました。あとは基準となる音の周波数が分かれば、全ての音の周波数が計算できるわけです。時代や地域、演奏する楽器等によって微妙に違ってきますが、現代日本においては普通は、A(ラ)=440Hzが基準周波数です。
あとは単純にかけ算して周波数を求めて連想配列に入れておくだけです。コードにすればこんな感じですね。
$baseFrequency = 440.0 $pitches = @{ "c" = $baseFrequency * [math]::Pow(2, 3/12) "d" = $baseFrequency * [math]::Pow(2, 5/12) ... }
あと、+で半音上がる場合は[math]::Pow(2, 1/12)をかけ、-で半音下がる場合は割ればいいだけです。(別に$pitchesテーブルで最初から定義してもいいかもですが)
音価の決め方
音価というのは音の長さです。Beepメソッドの第2引数にはミリ秒で実際の時間を指定する必要があるので、これも計算で求めてやります。
4分音符というのは、1小節(全音符)を4分割、つまり1/4した音価を持ちます。同様に8分音符は1/8ですね。付点がつくと音価は1.5倍になります。
ではたとえば4分音符の具体的な音価はどうやって定めるのでしょうか。それを決めるのがテンポと拍子です。
テンポは1分間(つまり60000ミリ秒)の拍数(BPM、Bit Per Minuteともいう)で定義されます。今回作るシーケンサーは4/4拍子、すなわち1拍=4分音符とする4拍子固定とするので、1分間に4分音符がBPM回含まれることになります。
つまり、4分音符の音価=60000ミリ秒/BPMの値、全音符の音価=60000*4ミリ秒/BPMの値 となるわけです。
具体的なコードは…略します。単なるかけ算と割り算だけなんで。
MMLのパース
えっと時間がなくなってきたので、駆け足で説明します。
MMLのパースとは、要するに最初の例のようなMML(テキストデータ)から、実際に演奏する音程と音価の組み合わせのデータとして組み立てる作業になります。
今回のシーケンサーでは、繰り返し記号等はサポートしないので、単にMMLを一文字ずつ読み込んで、音名(cなど)を見つけたら、その後の文字を読んで、+があれば半音上げるなどして周波数を求め、その後に数字があればn分音符とみなし、先ほどの計算式から実際の音価を求めてやる。というのを全部の音でくり返すだけです。
この処理をやっているのがConvertFrom-MMLという関数です。MMLテキストを入力してやると、周波数(Frequency)や発音時間(Duration)などをプロパティとして含んだpscustomobject(Noteオブジェクト)を出力します。(Noteとは音符のことです)
MMLの演奏
パースしたMMLを実際に演奏するのがInvoke-Beep関数です。入力は、ConvertFrom-MMLで生成したNoteオブジェクトです。実際の処理は至って単純で、 [System.Console]::Beep($note.Frequency, $note.Duration)するだけです(えー)。あ、あと休符の時はDuration分だけSleepを入れてやっています。
MMLの>と<の意味を逆転する-Reverseスイッチ、BPMを指定する-Bpmパラメータ(デフォルト120)なんかも用意してます。
実際にはMMLから直接演奏できるように、Invoke-Mmlというラッパー関数を用意しています。
冒頭のねこふんじゃったのMMLを再生するにはこんな感じにします。
$s=@" e-d-<g-4>g-rg-4e-d-<g-4>g-rg-4e-d-<g-4>g-4<e-4>g-4<d-4>frf4 e-d-<d-4>frf4e-d-<d-4>frf4e-d-<d-4>f4<e-4>f4<g-4>g-rg-4 "@ Invoke-Mml $s
コード
function ConvertFrom-MML { [CmdletBinding()] param( [parameter(ValueFromPipeline=$true)][string[]]$mml, [int]$bpm = 120, [switch]$reverse = $false ) begin { $baseFrequency = 440.0 $scaleRatio = [math]::Pow(2, 1/12) $baseDuration = 60000 * 4 / $bpm $pitches = @{ "c" = $baseFrequency * [math]::Pow(2, 3/12) "d" = $baseFrequency * [math]::Pow(2, 5/12) "e" = $baseFrequency * [math]::Pow(2, 7/12) "f" = $baseFrequency * [math]::Pow(2, 8/12) "g" = $baseFrequency * [math]::Pow(2, 10/12) "a" = $baseFrequency * [math]::Pow(2, 12/12) "b" = $baseFrequency * [math]::Pow(2, 14/12) "r" = -1 } $currentOctave = 0 } process { $chars = [string[]]$mml.ToCharArray() 0..($chars.Length - 1)|%{ if($null -ne $pitches[$chars[$_]]) { $frequency = $pitches[$chars[$_]] $suffix = "" $denominator = "" $dot = $false if($_ -lt $chars.Length-1) { switch($chars[($_ + 1)..($chars.Length - 1)]) { {$pitches.Contains($_)} {break} "+" {$frequency *= $scaleRatio; $suffix += $_} "-" {$frequency /= $scaleRatio; $suffix += $_} {$_ -match "\d"} {$denominator += $_} "." {$dot = $true} } } $frequency *= [math]::Pow(2, $currentOctave) $denominator = [int]$denominator if($denominator -eq 0){$denominator = 8} $multiplier = 1 / $denominator if($dot){$multiplier *= 1.5} $duration = $baseDuration * $multiplier if($frequency -le 0){$on = $false}else{$on = $true} [pscustomobject]@{ Frequency = [int]$frequency Duration = $duration Note = "$($chars[$_])$suffix$denominator$(if($dot){"."})" Octave = $currentOctave Pitch = $chars[$_] Suffix = $suffix Denominator = "$denominator$(if($dot){"."})" On = $on } } elseif($chars[$_] -eq ">") { if($reverse) { $currentOctave-- } else { $currentOctave++ } } elseif($chars[$_] -eq "<") { if($reverse) { $currentOctave++ } else { $currentOctave-- } } } } } function Invoke-Beep { [CmdletBinding()] param([parameter(ValueFromPipeline = $true)][psobject[]]$note) process { if($note.On) { [System.Console]::Beep($note.Frequency, $note.Duration) } else { Start-Sleep -Milliseconds $note.Duration } } } function Invoke-Mml { [CmdletBinding()] param( [string]$mml, [int]$bpm, [switch]$reverse ) ConvertFrom-Mml @PSBoundParameters|Invoke-Beep }
おわりに
今回はMMLをパースしてBeepを演奏するスクリプトをPowerShellで作ってみました。これをシーケンサーというのはおこがましいと思いますが、まあたまにはこういう柔らかいネタもいいんじゃないでしょうか。ドレミの音がどうやって決められてるのかというのも、もしかして話のネタくらいにはなるかも。
そしてこれ、シーケンサーといいつつ、入力機能がないですよね。それについては次回やります。
PowerShellアドベントカレンダー2014はまだまだ残席ございます。ぜひ、あなたのPowerShell話を聞かせて下さい。
2014/10/12
「PowerShellコマンドの書き方」セッション資料とデモ用コード公開(PowerShell勉強会#4@大阪)
昨日10/11のPowerShell勉強会#4にお越しいただいた方、どうもありがとうございました。スタッフ一同、これからも定期的に開催していこうと考えておりますので、ぜひともよろしくお願い致します。
私のセッション資料を公開します。わんくま横浜で行ったものとほとんど同じですが、v5関係のスライドを少しだけ修正しています。
今回は高度な関数とコマンドレットの作り方を主に取り上げていますが、要するに、PowerShellコマンドはPowerShellスクリプトでもC#でもほぼ同じようにして同じようなものが書ける、ということなのです。なので、基本を押さえればどちらにも対応可能です。
両者は状況に応じて使い分ければOKかと思います。PowerShellよりC#が得意、というならばコマンドレットを書くと良いですし、スクリプト的なお手軽なコードで書きたい場合は高度な関数、とかですね。
速度が求められる部分とか、.NETアセンブリを多用する部分だけコマンドレットにして、他を高度な関数にする、あるいは、主要部はコマンドレットにして、その他はコマンドレットのラッパー的な高度な関数を用意する、のように両者を組み合わせたモジュールもよくあります。
以下はデモ用のサンプルスクリプトです。高度な関数の雛型的なものになります。使い方はスライド本文を参照してください。
function Get-Foo { [CmdletBinding()] param([string[]]$Name) end { foreach($n in $name) { $out = [pscustomobject]@{ Name = $n No = 0 } # PSCustomObjectのインスタンスに型名を付ける $out.PSTypeNames.Insert(0, "Winscript.Foo") $out } } } function Set-Foo { [CmdletBinding()] param( [parameter(ValueFromPipeLine=$true, Mandatory=$true, Position=0)] [PSObject[]] $InputObject, [parameter(Position=1)] [string] $Property, [parameter(Position=2)] [PSObject] $Value, [switch] $PassThru ) process { foreach($o in $InputObject) { $o.$Property = $Value if($PassThru) { $o } } } } # C#によるクラス定義 Add-Type -TypeDefinition @" using System; namespace Winscript { public class Foo2 { private string _name; private int _no; public Foo2(string name) { _name = name; _no = 0; } public string Name { get{ return _name; } set{ _name = value; } } public int No { get{ return _no; } set{ _no = value; } } } } "@ function Get-Foo2 { [CmdletBinding()] param([string[]]$Name) end { foreach($n in $name) { New-Object Winscript.Foo2 $n } } } function Set-Foo2 { [CmdletBinding()] param( [parameter(ValueFromPipeLine=$true, Mandatory=$true, Position=0)] [Winscript.Foo2[]] $InputObject, [parameter(Position=1)] [string] $Property, [parameter(Position=2)] [PSObject] $Value, [switch] $PassThru ) process { foreach($o in $InputObject) { $o.$Property = $Value if($PassThru) { $o } } } }
以下はデモで用いたC#のコードです。コマンドレットクラスの雛型的なものになっています。ビルドの際はSDKに含まれるPowerShell関係のdllを参照設定してください(詳しくはスライド)。また使用する際は、Import-Module ビルドで生成したdllのフルパス を実行してインポートして下さい。以下の例だとGet-Baz、Set-Bazの2コマンドレットがインポートされます。
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Management.Automation; namespace Winscript { [Cmdlet(VerbsCommon.Get, "Baz")] public class GetBazCommand : Cmdlet { [Parameter(Mandatory = false, ValueFromPipeline = false, Position = 1)] public string[] Name { get; set; } protected override void ProcessRecord() { foreach (var n in Name) { WriteObject(new Baz(n)); } } } [Cmdlet(VerbsCommon.Set, "Baz")] public class SetBazCommand : Cmdlet { [Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0)] public Baz[] InputObject { get; set; } [Parameter(Mandatory = true, ValueFromPipeline = false, Position = 1)] public string Property { get; set; } [Parameter(Mandatory = true, ValueFromPipeline = false, Position = 2)] public PSObject Value { get; set; } [Parameter(Mandatory = false, ValueFromPipeline = false)] public SwitchParameter PassThru { get; set; } protected override void ProcessRecord() { foreach(var o in InputObject) { if (Property == "No") { o.No = (int)Value.BaseObject; } else if(Property == "Name") { o.Name = (string)Value.BaseObject; } if (PassThru) { WriteObject(o); } } } } public class Baz { private string _name; private int _no; public Baz(string name) { _name = name; _no = 0; } public string Name { get { return _name; } set { _name = value; } } public int No { get { return _no; } set { _no = value; } } } }
2014/09/09
[Friendly] 任意ウィンドウのコントロールのテキストを読み書きするコマンドレット
8/23わんくま横浜勉強会で、PowerShellコマンドの書き方というセッションをしたのですが、その際、株式会社Codeerさんが公開されているFriendlyというライブラリを使ったコマンドレットを動作させるデモを行いました。
準備の時間がなくて、突貫工事で作ったサンプルで恐縮ですが、公開することにします。(一応動かしてみたら動いた、レベルのものなのであしからず…)
コード
using System; using System.Diagnostics; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Management.Automation; using Codeer.Friendly.Windows; using Codeer.Friendly.Dynamic; using System.Windows.Forms; namespace Winscript { [Cmdlet(VerbsCommon.Get, "FormControlText")] public class GetFormControlTextCommand : Cmdlet { [Parameter(Mandatory = false, ValueFromPipeline = false, Position = 1)] public string[] ControlName { get; set; } [Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0)] public Process Process { get; set; } protected override void ProcessRecord() { var _app = new WindowsAppFriend(this.Process); dynamic form = _app.Type<Control>().FromHandle(this.Process.MainWindowHandle); foreach (var c in form.Controls) { if (ControlName == null || ControlName.Contains((string)c.Name)) { WriteObject((string)c.Text); } } } } [Cmdlet(VerbsCommon.Set, "FormControlText")] public class SetFormControlTextCommand : Cmdlet { [Parameter(Mandatory = true, ValueFromPipeline = false, Position = 1)] public string ControlName { get; set; } [Parameter(Mandatory = true, ValueFromPipeline = false, Position = 2)] public string Text { get; set; } [Parameter(Mandatory = true, ValueFromPipeline = true, Position = 0)] public Process Process { get; set; } protected override void ProcessRecord() { var _app = new WindowsAppFriend(this.Process); dynamic form = _app.Type<Control>().FromHandle(this.Process.MainWindowHandle); foreach (var c in form.Controls) { if (ControlName == (string)c.Name) { c.Text = Text; } } } } }
ビルド方法
- Windows 8.1 SDK をインストールする。
- Visual Studio 2010以降でC#のクラスライブラリを新規作成する。
- C:\Program Files (x86)\Reference Assemblies\Microsoft\WindowsPowerShell\3.0 にある.dllを参照設定する。
- 対象フレームワークを.NET 4.5、対象プラットフォームをx64にする。
- 上記のコードを貼り付ける。
- NuGetでFriendlyおよびFriendly.Windowsを追加する。
- ビルドする。
使用方法
上記をビルドして生成したDLLにはGet-FormControlTextと、Set-FormControlTextの2つのコマンドレットが含まれます。
# コマンドレットのインポート Import-Module "dllのフルパス" # 操作対象のプロセスオブジェクト取得 $p = Get-Process WindowsFormsApplication1 # プロセスを指定して、すべてのコントロールのテキストを取得 Get-FormControlText -Process $p # プロセスとコントロール名を指定して、テキストを取得 Get-FormControlText -Process $p -ControlName textBox1 # 位置パラメータなので以下のようにも書ける Get-FormControlText $p textBox1 # パイプラインからプロセスオブジェクトを入力することもできる $p | Get-FormControlText -ControlName textBox1 # プロセスとコントロール名を指定して、テキストを変更する Set-FormControlText -Process $p -ControlName textBox1 -Text Wankuma Set-FormControlText $p textBox1 Yokohama $p | Set-FormControlText -ControlName textBox1 -Text 6
制限事項
フォーム直下に配置されたコントロールしか取得できない(と思います)。
Windows Formアプリケーションにしか対応していない(と思います)。
x64アプリしか操作できない(と思います。x86用はアセンブリを分ける必要がある??)。(←9/9追記)
コントロール名指定はCase sensitiveでワイルドカード不可です。(この辺ただの手抜きですが)
今後の方針?
上のコードをみてもらえればわかると思いますが、ちょっと触ってみたら一応動くものができるくらい、Friendlyは分かりやすいです。皆さんもぜひ使ってみてください。
本来は、テキストじゃなくてコントロールそのものをGetしたりSetしたりInvoke(クリックとか)したりできるようにしたかったんですが、Controlはシリアル化できないオブジェクトなので、Friendlyで実物を持ってきてコマンドレットに出力する、というのは無理でした。何らかのプロキシオブジェクトみたいなのでラップしたりすれば良いかと思います。
それにしてもPowerShellとFriendlyの組み合わせはものすごい可能性を秘めている予感がします。
システム管理方面では…
セッションでもやりましたが、PowerShellコマンドレットベースのアプリケーションを作ると、GUIとCUIのいいところどりが出来る、とはいうものの、コマンドインターフェースがなくGUIオンリーのアプリケーションはまだまだたくさんあるのが現実かと思います。そういうアプリケーションも、PowerShellデフォルトの機能のみではつらいですが、上記のようにFriendlyを併用すれば、GUI操作の自動化が容易になると思います。
開発方面では…
C#でFriendlyを使ったGUIのテストコードを書く以外に、上記のようなFriendlyの機能をラップしたコマンドレットを用意することで、PowerShellスクリプトでもテストコードを書くことができるようになると思います。その際、Pester等のPowerShell用テストフレームワークを併用すると、より一貫したテストコードが記述できるようになるんじゃないかと思います。
いずれは(いつ?)、Friendlyの機能をラップしたコマンドレット群をきちんと設計、実装して、モジュールとして公開したいですね!
2013/12/05
プロパティ値が変化するまで待機する関数 Wait-State を書いてみた
はじめに
この記事はPowerShell Advent Calendar 2013の5日目の記事です。
突然ですが、PowerShellにはJobが完了するまで待機するWait-Jobコマンドレットというのがあります。これはその名の通り、パイプラインから入力したJobオブジェクトがすべて(あるいはどれか一つが)完了状態になるまでスクリプトの実行を待機する効果があります。
当然ながらWait-JobはJobオブジェクトにしか利用できませんが、任意の入力オブジェクトに対して待機条件を指定してやれば、その条件を満たすまで実行を停止するコマンドがあると便利なんじゃないかな?と常々思っていたので書いてみました。
Wait-State関数
function Wait-State { [CmdletBinding(DefaultParameterSetName="ByProperty")] param( [Parameter(ValueFromPipeline=$true)] [PSObject]$InputObject, [Parameter(Position=1,Mandatory=$true,ParameterSetName="ByProperty")] [string]$Property, [Parameter(Position=2,ParameterSetName="ByProperty")] [object]$Value, [Parameter(Position=1,Mandatory=$true,ParameterSetName="ScriptBlock")] [Alias("Script")] [ScriptBlock]$FilterScript, [Parameter()] [switch] $Any, [Parameter()] [switch] $IgnoreImmutable, [Parameter()] [switch] $PassThru, [Parameter()] [switch] $AllOutput, [Parameter()] [int] $IntervalSec=1, [Parameter()] [int] $TimeoutSec=60 ) begin { $objects = @() $watch = New-Object System.Diagnostics.StopWatch $watch.Start() $firstChecked = $false } process { foreach($o in $InputObject) { $objects += $o } } end { while($true) { $remains = @() foreach($o in $objects) { if($firstChecked) { if($o.Refresh) { $o.Refresh() } } if($null -ne $FilterScript) { if($o|&{process{&$FilterScript}}) { if($PassThru) { if((!$IgnoreImmutable -or ($IgnoreImmutable -and $firstChecked))) { $o } } } else { $remains += $o } } else { if($Value -eq $o.$Property -and (!$IgnoreImmutable -or ($IgnoreImmutable -and $firstChecked))) { if($PassThru) { if((!$IgnoreImmutable -or ($IgnoreImmutable -and $firstChecked))) { $o } } } else { $remains += $o } } } if($remains.Length -eq 0) { break } elseif($Any -and $remains.Length -lt $objects.Length) { if($AllOutput -and $PassThru) { $remains } break } elseif($watch.Elapsed.TotalSeconds -ge $TimeoutSec) { if($AllOutput -and $PassThru) { $remains } break } $objects = @($remains) $remains = @() $firstChecked = $true Start-Sleep -Seconds $IntervalSec } } }
コマンド構文
Wait-State [-Property] <string> [[-Value] <Object>] [-InputObject <psobject>] [-Any] [-IgnoreImmutable] [-PassThru] [-AllOutput] [-IntervalSec <int>] [-TimeoutSec <int>] [<CommonParameters>] Wait-State [-FilterScript] <scriptblock> [-InputObject <psobject>] [-Any] [-IgnoreImmutable] [-PassThru] [-AllOutput] [-IntervalSec <int>] [-TimeoutSec <int>] [<CommonParameters>]
パラメータ
-InputObject:入力オブジェクト。パイプライン入力可。
-Property:変更を確認するプロパティ名。
-Value:-Propertyで指定のプロパティ値が、このパラメータに指定する値になるまで待機する。
-FilterScript:プロパティを指定する代わりに待機条件をスクリプトブロックで指定する。
-Any:入力のどれか一つが条件を満たすまで待機するようにする。(省略時は入力が全部条件を満たすまで待機)
-PassThru:入力オブジェクトが待機条件を満たした時点で、そのオブジェクトを出力する。省略時は出力なし。
-IgnoreImmutable:最初から条件を満たしている場合は出力しない。-PassThruと併用。
-AllOutput:タイムアウトした場合や-Any指定時に一部のオブジェクトしか出力していない場合でも、最終的に未出力のすべてのオブジェクトを出力してから終了する。-PassThruと併用。
-IntervalSec:プロパティ値のチェック、もしくは待機条件スクリプトの実行の間隔秒数を指定。デフォルト1秒。
-TimeoutSec:最大待機秒数。デフォルト60秒。この時間を過ぎると条件を満たしていなくても待機を終了する。
使用例
# 停止しているサービスがすべて開始するまで待機する。 Get-Service |? Status -eq Stopped | Wait-State -Property Status -Value Running # 上記と同じだが、開始したサービスを逐次表示する。 Get-Service |? Status -eq Stopped | Wait-State -Property Status -Value Running -PassThru # 停止しているサービスが少なくとも1つ開始するまで待機する。 Get-Service |? Status -eq Stopped | Wait-State -Property Status -Value Running -Any # プロセスのワーキングセットが100MBを超えた段階で逐次表示する。 Get-Process | Wait-State {$_.WorkingSet -ge 100MB} -PassThru # 上記と同じだが、最初から100MBを超えてるものは出力しない。 Get-Process | Wait-State {$_.WorkingSet -ge 100MB} -PassThru -IgnoreImmutable # ディレクトリ内のファイル容量がすべて50KBを超えるまで待機し、出力のFileInfo配列を変数に代入。 $files = Get-ChildItem | Wait-State {$_.Length -ge 50KB} -PassThru -AllOutput -TimeoutSec 3600
問題点
プロパティ値を取得するときにリアルタイムに値が反映されないオブジェクト(要するにGetした時点のプロパティ値がずっと固定されてるもの)に対しては正しく動作しません。というか、PowerShellで扱うオブジェクトはほとんどそうなんじゃないかと思います(汗
ServiceControllerオブジェクト、Processオブジェクト、FileInfoオブジェクト、DirectoryInfoオブジェクトについては、Refreshメソッドを実行すると、プロパティ値を現在の値に更新してくれるので、それを利用してプロパティ値を監視できるようにはしています。
それ以外についても監視できるようにするには、たぶんそれぞれのオブジェクトに応じた監視方法を地道に調査して実装していくしかないんじゃないかなあと思います。
INotifyPropertyChangedインターフェースを実装したクラスについては、PropertyChangedイベントをSubscribeしてプロパティ値の変更を追跡できるようにしてみようとちょっと思ったんですが、PowerShellで扱うオブジェクトにINotifyPropertyChangedを実装したクラスのものってそんなにあるんだろうか?と疑問を覚えたのでやめました。
WMIオブジェクトについては何か共通の方法でプロパティ値変更を監視できないかなあと思ったんですが、結局IntervalSec間隔でクエリを発行する方法になってしまい、低コストで行う方法がちょっと思いつきませんでした。
ただ、-FilterScriptパラメータをサポートしているので、ここに書くことでいかようにも待機条件をカスタマイズできるので、極端な話、条件スクリプトブロックに{(Get-Hoge -Name $_.Name).Property -eq “ほげ”}みたいなコードを書いてゴリ押しすることもできるかと思います。
感想
というわけで、なんだか微妙な成果になって恐縮ですが、なんで無いんだろうと思っていた関数を実際に書いてみると、無い理由が分かったりするものなんだなあ、と思ったりした次第です。
スクリプトの解説を何もしてないですが、あえて解説する程のものでもないこともないですが、まあ長くなるのでやめときます。
ただ、入力オブジェクトを一旦全部取得してから、後続パイプラインに流し込む例としていくらか参考になるかもしれません。(beginで入れ物を用意して、processで詰めて、endでメインの処理を書くだけですけど)
あとはフィルタースクリプトブロックの実装方法の一例としても参考になるかも? スクリプトブロックを二重にして$_に対象オブジェクトがきちんと格納されるようにする方法、若干トリッキーな気もしますが正式にはどう書くのが良いのか不明なのでこうしてみました。
2013/01/20
FizzBuzz再び
PowerShellでFizzBuzz問題をいかに短く書くかというのは、人類にとっての太古からの命題であり、色々な方がチャレンジしています。
以下は国内でのチャレンジを、 日時、チャレンジャー名、コード文字数(半角スペース消去後)、初出アドレス で時系列にまとめたものです。
2007/11/06 牟田口 89文字 リンク
2007/11/07 囚人さん 86文字 リンク
2007/11/07 よこけんさん 75文字 リンク
2007/11/13 よこけんさん 57文字 リンク
2013/01/19 guitarrapcさん 57文字 リンク
私の現在の最短コードはこれです。PowerShell 3.0でしか動きませんが、51文字です。
1..100|%{($t="fizz"*!($_%3)+"buzz"*!($_%5))+$_[$t]}
PowerShell 2.0でも動くバージョンは以下。54文字です。
1..100|%{($t="fizz"*!($_%3)+"buzz"*!($_%5))+@($_)[$t]}
きっと解説は不要だと思いますが蛇足を承知で少しばかり。
$_%3 は、剰余を求める演算子%を使っているので、$_が3の倍数のとき0を返します。
!(0)とすると、0はboolに型変換され$falseとなり、その論理否定なので!(0)は$trueになります。
”fizz”*$true とすると右辺はintに型変換されるので”fizz”*1が評価され、”fizz”を返します。PowerShellでは「文字列*整数値」で文字列を整数値回繰り返した文字列を返すことを利用しています。
同じことを”buzz”に対しても行い、結果を+で連結します。このとき、”fizz”か”buzz”か”fizzbuzz”か””(空の文字列)のいずれかを返します。得られた値を@とします。
($t=@) とすると$tに@の値を入れつつ、@の値を返します。
@($_)[$t] とすると、$tが””(空の文字列)の場合は型変換され@($_)[0]が評価されます。よって、$tが””のときは@($_)の0番目の要素、$_、すなわち元の数値が取り出されます。最後に””と元の数値を+で連結したものが出力されるので、結果として数値のみが出力されます。
$tが”fizz”か”buzz”か”fizzbuzz”の場合は@($_)[$t]は配列の範囲外なので$nullを返します。よって$t+$null、すなわち$tの文字列がそのまま出力されます。
PowerShell 3.0だと非配列変数でも[]演算子を使用することができます。よって$_[0]は$_と等しく、$_[文字列]は$nullです。これによって@($_)のように配列化する必要がなく、3文字短縮できたわけです。
Copyright © 2005-2018 Daisuke Mutaguchi All rights reserved
mailto: mutaguchi at roy.hi-ho.ne.jp
プライバシーポリシー