PowerShellの結果が表で表示されても、必要な値の取り出し方が分からないことがあります。まずGetType()で型(値の種類)を確かめ、Get-Memberでプロパティ(情報の項目)とメソッド(呼び出せる操作)を調べるのが手掛かりです。
PowerShellは情報のまとまりをオブジェクトとして扱い、文字列もその一種です。この記事ではWindows PowerShell 5.1を新しく開き、架空のカード一件から順に練習します。値の取り出し方と画面用の整形の違いまで確認し、最後に練習用の変数を消します。ファイルやサービスは変更しません。
先に結論
- 知らない結果は、型を確認してからGet-Memberで項目と操作を調べると、中身を追いやすくなります。
- プロパティはドットで値を読み、メソッドは括弧を付けて呼び出します。操作の影響はメソッドごとに確認します。
- 項目名を残す選択、値だけの取り出し、画面用の整形は別の結果です。値を処理するときは元データを保ちます。
1.Windows PowerShell 5.1を新しく開く
この練習はWindows PowerShell 5.1が対象です。初めに練習用の画面を新しく開き、版を確かめます。後の例も同じ画面で順に進めるため、途中で画面を閉じないでください。管理者権限は不要です。
起動時の-NoProfileは、個人の起動設定を読み込まない指定です。以下では各コード欄を末尾まで貼り付け、最後にもEnterを押して実行します。実行結果の欄は、貼り付けずに手元の出力と見比べます。
- WinキーとRキーを押し、「ファイル名を指定して実行」を開きます。
- 実行ファイル名powershell.exeの後に半角スペースと-NoProfileを付けて入力し、Enterを押します。
- 開いた画面で、次の「版を確認する」のコード欄を2行とも実行します。
版を確認する
$PSVersionTable.PSVersion.ToString()
$PSVersionTable.PSEdition
実行結果
5.1.26100.9818
Desktop
1行目が5.1から始まる番号、2行目がDesktopなら対象の画面です。掲載結果の確認環境は5.1.26100.9818です。番号の末尾はWindowsの更新状態により異なります。
別の版が表示された場合は、上の起動手順から確認し直してください。PowerShell 7、リモート接続先のオブジェクト、外部プログラムの出力を扱う例は、本稿の実行確認範囲に含みません。
2.架空のカードを作り、型を確かめる
題名・ページ数・準備済みかどうかをまとめた架空のカードを作ります。Titleは題名、Pagesはページ数、Readyは準備済みかどうかです。現実のファイルではなく、開いた画面内に練習用のデータを用意します。
$cardは値を覚えておく変数です。先頭の$が変数名の目印で、=は値を入れる代入を表します。[pscustomobject]は名前付きの項目を持つデータを作る指定です。@{ }の内側に項目名と値を並べ、セミコロンで区切ります。
次の2行は、最初にカードを作り、続いてその型を表示します。Readyに入れる$trueは「真」を表し、ここでは準備済みという意味を持たせています。コード欄を2行とも実行してください。
練習用カードを作って型を確認する
$card = [pscustomobject]@{ Title = 'memo'; Pages = 24; Ready = $true }
$card.GetType().FullName
実行結果
System.Management.Automation.PSCustomObject
System.Management.Automation.PSCustomObjectと出れば、カードの型を確認できています。GetType()は型を返すメソッド、続くFullNameは型の正式名を読むプロパティです。長い型名を暗記する必要はありません。
3.ドットで項目の値を読み、その型を見る
前節で作ったカードから、項目ごとの値を読みます。変数名の後にドットと項目名を続けると、そのプロパティの値を取り出せます。次のコード欄では、前半3行で値を、後半3行でそれぞれの型を表示します。
文字列は文字の並び、整数は小数部分のない数です。真偽値は「真」か「偽」の二つで表す値で、Readyに入れた$trueもその一つです。6行を末尾まで実行し、値と型が同じ順番で並ぶことを確認します。
項目の値と型を確認する
$card.Title
$card.Pages
$card.Ready
$card.Title.GetType().FullName
$card.Pages.GetType().FullName
$card.Ready.GetType().FullName
実行結果
memo
24
True
System.String
System.Int32
System.Boolean
最初の3行はmemo、24、Trueです。順に題名、ページ数、準備済みかどうかを表します。Trueは、カード作成時に指定した$trueに対応する表示です。
後半のSystem.String、System.Int32、System.Booleanは、順に文字列・整数・真偽値の正式な型名です。画面上で文字に見えても、元の値には型があり、項目ごとに取り出して扱えます。
4.項目名が分からないときはGet-Memberで調べる
Get-Memberで項目や操作を調べると、表示された表だけに頼らず中身を確認できます。
項目名が分からないときは、Get-Memberで調べます。縦線の|は、左の結果を右の処理へ渡すパイプです。次の例ではカードをGet-Memberへ渡し、-MemberTypeにNotePropertyを指定して、自作カードの値の項目に絞ります。
Get-Memberが返す調査結果では、Nameが項目名を表します。続くSelect-Objectの-ExpandPropertyにNameを指定し、その名前だけを取り出します。コード欄は2行で一つの処理なので、2行とも貼り付けて実行します。
カードの項目名を調べる
$card | Get-Member -MemberType NoteProperty |
Select-Object -ExpandProperty Name
実行結果
Pages
Ready
Title
Pages、Ready、Titleの3項目が出れば、作ったカードと対応しています。ここに表示されるのは項目名で、memoや24といった項目の値ではありません。
NotePropertyは、今回の自作カードの項目に絞る指定です。他の種類のオブジェクトで、この条件から全項目が分かるとは限りません。Get-Memberを絞らずに実行すると、型の情報や操作も調べられます。
5.メソッドは括弧を付けて呼び出す
文字列もプロパティとメソッドを持つオブジェクトです。次の例では、Titleに入れた文字列memoのLengthで長さを読み、ToUpper()で大文字にした結果を受け取ります。Lengthには括弧を付けず、ToUpperには括弧を付けます。
メソッドの括弧には、操作へ渡す値を書くことがあり、その値を引数と呼びます。今回のToUpperは括弧内が空です。後半ではGet-Memberの-NameでToUpperを探し、MemberTypeで項目や操作の分類を読みます。
文字列の長さと大文字化を確かめる
$card.Title.Length
$card.Title.ToUpper()
$card.Title
$card.Title | Get-Member -Name ToUpper |
Select-Object -ExpandProperty MemberType
実行結果
4
MEMO
memo
Method
結果は順に4、MEMO、memo、Methodです。4は文字数、MEMOは大文字化で返された文字列です。その後のmemoから、元のTitleは変わっていないと分かります。MethodはToUpperがメソッドであることを示します。
すべてのメソッドが元の状態を保つわけではありません。ファイル削除など、別の操作では状態が変わる場合があります。今回の大文字化と同じ作用だと考えず、呼び出す操作ごとに影響を確認してください。
6.項目名を残す選択と、値だけの取り出しを比べる
同じmemoが見えても、項目を持つ結果と文字列そのものは別です。
Select-Objectの-PropertyにTitleを指定すると、Titleという項目を残した結果になります。-ExpandPropertyにTitleを指定すると、その項目の中身を取り出します。このカードでは、中身は文字列memoです。
次の例では、項目付きの結果を$picked、取り出した値を$valueに保存します。ConvertTo-Csvは、項目名と値をCSVという表形式の文字列に変換するコマンドです。-NoTypeInformationで型の注記を省き、画面に表示します。ファイルには保存しません。
コード欄を6行とも実行します。この節の比較表では、二通りの選択と表示用の整形を見比べられます。表のFormat-Tableの行は、後の整形例で確認します。
| 操作 | 受け取る結果 | 判断の目安 |
|---|---|---|
| Select-Object -Property Title | Titleという項目を持つオブジェクト | 項目名を残す。$picked.Titleで値を読む。 |
| Select-Object -ExpandProperty Title | Titleの値memo(文字列) | 文字列自体にもLengthやToUpper()がある。 |
| Format-Table -Property Title, Pages | 表示用の整形情報 | Pagesを持つ元データの代用にしない。 |
項目付きの結果と中身の値を比べる
$picked = $card | Select-Object -Property Title
$value = $card | Select-Object -ExpandProperty Title
$picked | ConvertTo-Csv -NoTypeInformation
$picked.GetType().FullName
$value
$value.GetType().FullName
実行結果
"Title"
"memo"
System.Management.Automation.PSCustomObject
memo
System.String
最初の2行は、引用符付きのTitleとmemoです。項目名と値を別々に確認できます。続くSystem.Management.Automation.PSCustomObjectは、$pickedが項目を持つオブジェクトであることを示します。
最後のmemoとSystem.Stringは、$valueの値と型です。$pickedではTitleという項目を介して値を読みますが、$valueはそれ自体が文字列です。後で項目名が必要か、値だけが必要かで選び分けます。
7.配列の一件と、配列自体を調べ分ける
Get-Memberへパイプで渡すと要素を、-InputObjectで渡すと配列自体を調べます。
配列は、複数の値を順番にまとめたものです。次の例では、先ほどのカードと別の架空カードを$cardsにまとめます。@( )は配列として受け取る指定、カンマは要素の区切りです。二件目のReadyには「偽」を表す$falseを入れます。
Countは配列の件数を読みます。[0]は先頭の一件を選ぶ指定です。位置の番号は0から始まるため、先頭が0、次が1になります。前半では、件数・先頭のカードの型・配列自体の型を順に表示します。
後半では、同じ配列をGet-Memberへ渡す方法を変えます。パイプではカードのTitle、-InputObjectでは配列のCountを調べます。-First 1は調査結果の先頭一件を選ぶ指定で、TypeNameは調べた対象の型名です。
配列の要素と配列自体を調べ分ける
$cards = @($card, [pscustomobject]@{ Title = 'guide'; Pages = 8; Ready = $false })
$cards.Count
$cards[0].GetType().FullName
$cards.GetType().FullName
($cards | Get-Member -Name Title | Select-Object -First 1).TypeName
(Get-Member -InputObject $cards -Name Count).TypeName
実行結果
2
System.Management.Automation.PSCustomObject
System.Object[]
System.Management.Automation.PSCustomObject
System.Object[]
最初の2はカードの件数です。続いてカードの型名とSystem.Object[]が出ます。System.Object[]は、複数の値を入れられる配列を表します。先頭の一件と、その一件を含む配列は別の対象です。
最後の2行も、カードの型名、配列の型名の順です。一覧を調べたのに期待する項目が見つからないときは、要素である一件を見ているのか、配列自体を見ているのかを確認します。
8.画面用の整形は、値の処理の最後に置く
後で値を処理する場合は元データを保ち、Format-Tableによる整形を最後に置きます。
Format-Tableは、結果を画面の表として見せる整形コマンドです。次の例ではTitleとPagesを表示する列に指定します。返されるのは表示用の情報で、カードの項目をそのまま保つ結果ではありません。
$displayには整形結果を配列として受け取り、先頭の情報を調べます。PSObjectは、PowerShellが用意する項目情報への入口です。続くPropertiesでプロパティの情報を参照します。
Matchは、括弧内で指定した名前に一致する項目を探す操作です。Countで見つかった数を読み、Pagesがあるかを元のカードと比べます。4行とも実行すると、最後に元のカードのページ数も表示されます。
表示用の整形情報と元の項目を比べる
$display = @($card | Format-Table -Property Title, Pages)
$display[0].PSObject.Properties.Match('Pages').Count
$card.PSObject.Properties.Match('Pages').Count
$card.Pages
実行結果
0
1
24
0、1、24が順に出ます。先頭の整形情報にはPagesがなく、元のカードにはPagesが一つあり、その値は24です。整形結果を受け取っても、元の$cardは残っています。
画面の表にPages列が見えることと、受け取った結果がPagesプロパティを持つことは別です。ページ数を計算するなど、値を扱う予定があるときは、表示用の情報を元データの代わりにしないでください。
9.何も表示されないときは、項目の存在も調べる
値がないことと、項目がないことは、値の比較だけでは区別できません。
$nullは値がない状態を表します。ただし、項目自体が存在しない場合も、参照結果が$nullになることがあります。何も表示されないときは、値に加えてプロパティの存在も調べます。
この例は、新しく-NoProfileで開いた画面の既定状態が前提です。存在しない項目の参照などをエラーにする「厳密モード」は無効になっています。途中で設定を変えた画面では、同じ結果にならない場合があります。
最初の2行では、カードにないMissing項目を調べます。後半では、Missing項目が存在し、値だけが$nullの$emptyを作ります。-eqは等しいかを調べる記号です。コード欄を5行とも実行し、値の比較と項目数を見比べます。
存在しない項目と空の項目を調べる
$null -eq $card.Missing
$card.PSObject.Properties.Match('Missing').Count
$empty = [pscustomobject]@{ Missing = $null }
$null -eq $empty.Missing
$empty.PSObject.Properties.Match('Missing').Count
実行結果
True
0
True
1
結果はTrue、0、True、1の順です。最初のTrueと0は、存在しない項目の参照結果が$nullと等しく、項目数は0であることを示します。後のTrueと1は、値は$nullでも項目が一つ存在することを示します。
どちらも値の比較はTrueになるため、それだけでは項目の有無を判定できません。途中でエラーが出た場合は、最初の起動方法とカード作成から確認し直してください。設定の異なる画面で同じ出力になるとは限りません。
10.練習用の変数を消し、やり直す場所を確認する
ここまでの例をすべて実行したら、練習用の変数を消します。Remove-Variableは指定した変数を消すコマンドです。削除する名前には、変数を参照するときの先頭の$を付けません。
続くTest-Pathは、指定先が存在するかを調べます。Variable:cardはcardという変数を示します。この例で片付けるのは画面内に作った練習用の変数で、ファイルやサービスを元に戻す操作はありません。
- 次の「練習用の変数を消す」のコード欄を2行とも実行します。
- 実行結果がFalseであることを確認します。
- やり直す場合はカード作成へ戻り、終了する場合は練習用の画面を右上の閉じるボタンで閉じます。
練習用の変数を消す
Remove-Variable -Name card, picked, value, cards, display, empty
Test-Path -LiteralPath Variable:card
実行結果
False
Falseならcard変数は存在しません。もう一度試す場合は、カード作成から順に実行します。途中の例だけを実行すると、必要な変数がなく、先へ進めないことがあります。
次に知らない結果へ出会ったら、まず一件を選び、GetType()で型、Get-Memberで項目と操作を調べます。その後で必要な値を読みます。文字列・項目付きの結果・配列・表示用の情報を区別することが、調べる手掛かりになります。
