PowerShellのパイプ入門:抽出・並べ替え・集計を順に試す

パイプで受け渡す作業データを、抽出、並べ替え、集計の3段階で処理する独自図解

PowerShellで一覧を並べたのに、欲しいデータが残らないときは、処理の順番を確認します。基本は、条件で絞り、並べ替え、必要な項目を選ぶ流れです。「|」は左の結果を右へ渡す記号で、処理をつないだ流れをパイプラインと呼びます。

この記事ではWindows PowerShell 5.1を通常の権限で開き、架空の作業4件から未完了の作業を選んで、時間順の一覧と合計を求めます。ファイルやサービスを変更せず、同じ画面で順番に進めます。最後に練習用の変数を消すところまで扱います。

先に結論

  • パイプで渡るのは、画面の見た目ではなく、値や名前付きの項目を持つデータです。
  • Where-Objectで作業を絞り、Sort-Objectで並べ、Select-Objectで項目や件数を選びます。
  • 先頭の件数を選ぶ位置と表示用に整形する位置で結果が変わるため、途中の出力を確認します。

1.PowerShellを開き、値が一つずつ渡ることを確かめる

練習専用のWindows PowerShell画面を開き、以後の例も同じ画面で実行します。

Windowsのスタートメニューで「Windows PowerShell」を検索し、通常の権限で新しい画面を開きます。管理者として起動する必要はありません。入力できる行が表示されたら、下の2つのコード欄を順に実行します。

最小例に出てくるカンマは、複数の値を並べる記号です。ForEach-Objectは入力一件ごとに処理するコマンドで、波括弧が処理の範囲を示します。$_は今受け取った値、*は掛け算を表します。

  1. 「版を確認する」の2行を実行します。実行記録の表示は5.1.26100.9818とDesktopです。5.1から始まる番号とDesktopなら同じ系列です。
  2. 表示が異なる場合は、スタートメニューで「Windows PowerShell」を選び直します。PowerShell 7は本稿では実行未確認です。対象の画面を確認できたら、「一つずつ渡る値を確かめる」を実行します。

版を確認する

$PSVersionTable.PSVersion.ToString()
$PSVersionTable.PSEdition

実行結果

5.1.26100.9818
Desktop

一つずつ渡る値を確かめる

2, 4, 6 | ForEach-Object { $_ * 3 }

実行結果

6
12
18

最小例で6、12、18と順に出れば、2、4、6が一つずつ渡り、それぞれ3倍になっています。画面のPSから始まる入力待ちの表示は、コードの一部ではありません。以後も各コード欄を末尾まで実行します。

2.名前・時間・完了状態を持つ作業4件を用意する

オブジェクトは、名前付きの項目と値をまとめたデータです。その項目をプロパティと呼びます。ここでは架空の作業4件を作ります。実在の作業実績ではなく、毎回同じ結果を確認するための練習データです。

変数は値を一時的に覚える名前で、作業一覧を$tasksへ入れます。配列は複数の要素をまとめたものです。例の@と丸括弧で配列を作り、[pscustomobject]と、それに続く@と波括弧で名前付きの項目を持つデータを作ります。

波括弧の中のセミコロンは、同じ行にある項目の区切りです。下の欄は先頭の代入から、最後に件数を表示する行までまとめて実行してください。練習では$tasks、$selected、$statsを使うため、同名の変数を別の作業で利用中なら専用の新しい画面で始めます。

  • Name:作業名です。設計、連絡、調査、確認の4件を用意します。
  • Minutes:予定時間を分で表した数値です。
  • Done:完了状態です。$trueは真で完了、$falseは偽で未完了を表します。

固定した練習データを用意する

$tasks = @(
    [pscustomobject]@{ Name = '設計'; Minutes = 12; Done = $false }
    [pscustomobject]@{ Name = '連絡'; Minutes = 6; Done = $true }
    [pscustomobject]@{ Name = '調査'; Minutes = 25; Done = $false }
    [pscustomobject]@{ Name = '確認'; Minutes = 9; Done = $true }
)
$tasks.Count

実行結果

4

4と出れば、4件を用意できました。Countは要素数を表します。データはこの画面のメモリ上だけにあり、ファイルには保存していません。画面を閉じると後の例から参照できなくなるため、そのまま次へ進みます。

3.項目名を調べ、未完了の作業だけを残す

Where-Objectは条件に合う作業を残し、Select-Objectは取り出す項目を選びます。

どの項目で絞れるか分からないときは、Get-Memberで項目名を調べます。-MemberTypeは調べる種類を指定する設定です。今回の自作データでは、名前付きの項目に当たるNotePropertyを指定します。

次に、Where-Objectで未完了の作業を残します。条件の中の$_は今受け取った作業で、そのDoneが完了状態です。-notは真偽を反転する指定なので、Doneが偽の作業が条件に合います。

  1. 「項目名を調べる」を実行し、Done、Minutes、Nameが表示されることを確認します。
  2. 「未完了の名前だけを確認する」を末尾まで実行し、残った作業名を確認します。

項目名を調べる

$tasks | Get-Member -MemberType NoteProperty |
    Select-Object -ExpandProperty Name

実行結果

Done
Minutes
Name

未完了の名前だけを確認する

$tasks | Where-Object { -not $_.Done } |
    Select-Object -ExpandProperty Name

実行結果

設計
調査

未完了の名前として、設計、調査が出れば対応しています。-ExpandPropertyは指定した項目の値だけを取り出します。最初の欄のNameは調べた項目の名前、次の欄のNameは作業名を指しています。

何も表示されない場合は、準備のコードを同じ画面で実行したか確認してください。まず項目名を調べ、次に条件で絞ると、どこで結果が違ったかを追いやすくなります。

4.未完了の作業を時間順に並べ、必要な項目を選ぶ

未完了だけを残してから時間の大きい順に並べ、作業名と時間を取り出します。

前の例は未完了の名前だけを表示しました。今度は時間も残し、長い作業から順に並べます。処理結果を$selectedへ保存するため、下の欄は先頭の代入から最後の変換行までまとめて実行してください。

行末のパイプは、処理が次の行へ続く合図です。途中で継続入力の行が表示されても、画面側の案内記号をコードに加えず、欄の末尾まで入力します。処理は次の3段階です。

最後のConvertTo-Csvは、項目をカンマで区切るCSV形式の文字列を返します。-NoTypeInformationは、データの種類を示す型情報の行を省く指定です。今回は画面で結果を確認するための変換で、ファイルには保存しません。

  • Where-Object:未完了の作業だけを残します。
  • Sort-Object:-Property Minutesで時間を比較し、-Descendingで大きい順に並べます。
  • Select-Object:-Propertyで指定したNameとMinutesだけを持つ新しいデータを返します。

抽出して時間順に並べ項目を選ぶ

$selected = $tasks | Where-Object { -not $_.Done } |
    Sort-Object -Property Minutes -Descending |
    Select-Object -Property Name, Minutes
$selected | ConvertTo-Csv -NoTypeInformation

実行結果

"Name","Minutes"
"調査","25"
"設計","12"

NameとMinutesの見出しに続き、調査25、設計12の順に出ます。CSVの引用符は各項目の値を囲む表示です。$selectedには文字列へ変換する前の2項目が残るため、後の例でも再利用できます。

5.先に2件へ絞ると、全体で時間の長い作業が抜ける

全体から時間の長い2件を選ぶなら、並べ替えてから件数を絞ります。

Select-Objectの-First 2は、入力の先頭2件を残す指定です。これを並べ替えより先に置くと、残りの作業は比較に参加しません。全体で時間の長い2件と、元の先頭2件の中で時間の長い順は、異なる結果になります。

ここでは未完了に絞った$selectedではなく、元の4件が入った$tasksを使います。コード欄には比較用の処理が2本あるため、中央の区切り行も含めて末尾までまとめて実行してください。

  • 前半:元の先頭2件を残し、その2件の中で時間の大きい順に並べます。
  • 後半:全4件を時間の大きい順に並べ、その先頭2件を残します。

先に件数を絞る場合と比較する

$tasks | Select-Object -First 2 |
    Sort-Object -Property Minutes -Descending |
    Select-Object -ExpandProperty Name
'---'
$tasks | Sort-Object -Property Minutes -Descending |
    Select-Object -First 2 -ExpandProperty Name

実行結果

設計
連絡
---
調査
設計

区切りの前は設計、連絡、後は調査、設計です。前半では12分と6分の2件だけを比較するため、25分の調査は残りません。結果が違うときは、並べ替える前に対象を減らしていないか確認します。

6.作業名と時間から、一件ずつ表示文字列を作る

一覧を短い文章で表示したいときは、ForEach-Objectで一件ずつ文字列を作れます。ここでは保存済みの$selectedを入力にするため、調査、設計の順です。$_に続くNameとMinutesで、今処理している作業の項目を参照します。

例の+は、左側の名前の文字列に、区切り、時間、単位を順につなぎます。文字列としてつなぐため、時間の数値も表示用の文字へ変換されます。この処理は文字列を出力するだけで、元の$selectedを書き換えません。

一件ずつ文字列を作る

$selected | ForEach-Object { $_.Name + ': ' + $_.Minutes + '分' }

実行結果

調査: 25分
設計: 12分

調査: 25分、設計: 12分と表示されます。この出力は各行が文字列です。後で時間を合計する場合は、表示文字列から数字を取り出し直すより、元の数値項目を集計に使うと処理を追いやすくなります。

7.未完了の件数と時間の合計を求める

練習データの未完了は2件で、予定時間の合計は37分です。

Measure-Objectは、件数や数値の合計を求めるコマンドです。今回はWhere-Objectで未完了だけを残した後、-Property Minutesで時間の項目を指定し、-Sumで合計を求めます。

集計結果を$statsへ保存し、Count、Sumの順に表示します。代入行だけで止めず、最後にSumを表示する行までまとめて実行してください。今回のMinutesは全件に数値があるため、Countを集計に参加した作業の件数として読めます。

未完了の件数と合計を調べる

$stats = $tasks | Where-Object { -not $_.Done } |
    Measure-Object -Property Minutes -Sum
$stats.Count
$stats.Sum

実行結果

2
37

2と37が順に出れば、未完了2件、25分と12分の合計37分という対応です。この値は練習データを計算した結果です。実際に作業へかかった時間や、PowerShellの処理速度を測った値ではありません。

8.Format-Tableを途中に挟むと、元の項目で絞れない

表の表示用整形はデータ処理の後に置き、CSVへの変換には元のデータを渡します。

Format-Tableは、画面へ表として表示するための情報を作ります。後へ渡るのは元の作業データではなく、表示用のオブジェクトです。そのため、続けて元のMinutesを使って絞っても期待する結果になりません。

次の比較は、前半だけFormat-Tableを途中に挟み、どちらもMinutesが10以上という条件で絞ります。-geは「以上」で、10も含みます。結果を配列にまとめてCountを調べているため、表示されるのは作業一覧ではなく件数です。

表示用の整形を途中に挟んだ結果を比較する

@($tasks | Format-Table -Property Name, Minutes |
    Where-Object { $_.Minutes -ge 10 }).Count
@($tasks | Where-Object { $_.Minutes -ge 10 }).Count

実行結果

0
2

今回の結果は前半0、後半2です。元のデータには10分以上の作業が2件ありますが、表示用の情報へ変わった後では同じように絞れません。

表を表示するときは、抽出や並べ替えの後にFormat-Tableを置きます。CSVへ変換・保存するときは表示用に整形せず、元のデータを渡します。Export-Csvはファイルへ保存するコマンドで、Format-Tableの結果を渡すと表示用の内部情報が出力されます。本稿ではファイル保存は実行していません。

9.数値3個を一つずつ渡す場合と、配列ごと渡す場合を比べる

Measure-Objectでは、数値3個をパイプで渡すと3件、配列を直接渡すと1件です。

パイプで渡す場合と、-InputObjectへ直接指定する場合が、どのコマンドでも同じになるとは限りません。-InputObjectは、処理する入力を直接渡すための指定です。ここではMeasure-Objectが数える単位を比べます。

この例の入力は作業一覧ではなく、2、4、6の3つの数値です。2行を順に実行してください。同じ数値でも、要素ごとに渡すか、配列を一つ渡すかによって、受け取る入力の件数が変わります。

  • 前半:2、4、6をパイプで一つずつMeasure-Objectへ渡します。
  • 後半:3つの数値をまとめた配列を、-InputObjectへ一つ渡します。
掲載例 実行結果 判断できること
先に件数を絞る場合と比較する:前半 設計→連絡 入力先頭2件の中だけを時間順へ並べた
先に件数を絞る場合と比較する:後半 調査→設計 全4件を時間順にして上位2件を残した
表示用の整形を途中に挟んだ結果:前半 0件 表示用オブジェクトでは元のMinutesで絞れない
表示用の整形を途中に挟んだ結果:後半 2件 元のデータのMinutesが10以上の2件を残した
配列の渡し方で件数が変わる:前半/後半 3件/1件 要素ごとの入力と配列一つの入力を区別する

配列の渡し方で件数が変わることを確かめる

(2, 4, 6 | Measure-Object).Count
(Measure-Object -InputObject @(2, 4, 6)).Count

実行結果

3
1

結果は3、1の順です。パイプでは3つの数値が一つずつ渡り、直接指定では配列そのものが一つの入力になります。この違いを、外部実行ファイルやすべての引数へそのまま当てはめないでください。

この節の表は処理順・表示用整形・入力の渡し方を整理したものです。最後の行だけは作業4件ではなく、数値3個の比較です。結果とともに、何を入力した比較なのかも確認します。

10.結果が違うときの確認箇所と、練習の終え方

期待した結果が出ないときは、下の症状から確認箇所を選びます。直す場所が分からなければ、準備から各節を順にやり直し、最初に結果が違う場所を探してください。専用の新しい画面で最初から始める方法もあります。

入力途中のまま継続入力の行で止まった場合は、Ctrl+Cで未完了の入力を中断し、コード欄全体を貼り直します。Ctrl+Cは、既に実行した処理を取り消す操作ではありません。

練習を終えるときだけ、最後のコード欄を1回実行します。Remove-Variableは、練習で作った3つの変数と中身を削除します。-Nameには$を付けず変数名を指定します。末尾のTest-Pathは、$tasksが存在するかを確認する行です。

  • 何も出ない:同じ画面で練習データを用意したか、必要な変数を保存する節まで実行したか確認します。
  • 絞り込み結果が違う:Get-Memberで項目名を調べ、条件に使う項目が合っているか確認します。
  • 時間の長い作業が抜ける:並べ替える前に件数を絞っていないか確認します。
  • 項目を使った処理ができない:途中で文字列へ変換したり、Format-Tableで表示用に整形したりしていないか確認します。

練習変数を消して終える

Remove-Variable -Name tasks, selected, stats
Test-Path -LiteralPath Variable:tasks

実行結果

False

Falseは、$tasksが消えたことを示します。この確認行が調べる対象は$tasksです。もう一度練習するときは、データの準備からやり直してください。

掲載例の実行確認範囲は、Windows PowerShell 5.1の同じ画面で行うメモリ内の処理です。PowerShell 7、外部実行ファイル、リモート接続、速度比較は未実行です。