数値データからグラフ画像を生成するPowerShellスクリプトの作成も完成目前だ。前回作成したPowerShellスクリプトにはまだハードコーディングした部分がいくつかあるので、今回はこれを整理して汎用的なツールとして使えるように書き換える。

→連載「PowerShell Core入門 - 基本コマンドの使い方」の過去回はこちらを参照。

PowerShellスクリプトからハードコーディング部分を書き換え

前回までに、グラフにしたいデータをCSVデータとして用意しておき、これを棒グラフの画像に変換するPowerShellスクリプトを作成した。Google Chartsの利用、Microsoft Edgeの外部からのコントロールなど、PowerShellを使いつつほかの機能を組み合わせて機能を実現している。

機能としては前回作成したPowerShellスクリプトでほぼ網羅しているが、データをハードコーディングしている部分がいくつかあるなど、まだ荒削りなところが残っている。今回はこうした部分を整理してパラメータで指定できるように書き換える。これで汎用的なツールとして利用できるようになるはずだ。

先に、書き換えたPowerShellスクリプト「csv2barchart.ps1」を掲載しておこう。

#!/usr/bin/env pwsh

#========================================================================
# 引数を処理
#   -CSVFile パス             グラフのCSVデータファイルパス
#   -PNGFile パス             生成するPNG画像のファイルパス
#   -OutFile パス             中間生成されるHTMLファイルパス
#   -GraphTitle タイトル        グラフのタイトル
#   -Width 幅                        生成するPNG画像の幅
#   -Height 高さ              生成するPNG画像の高さ
#========================================================================
Param(
    [Parameter(Mandatory=$true)][String]$CSVFile,
    [String]$PNGFile = (Get-Location).ToString() + '\out.png',
    [String]$OutFile = (Get-Location).ToString() + '\out.html',
    [String]$GraphTitle = 'グラフ',
    [Int]$Width = 2000,
    [Int]$Height = 1200
)

#========================================================================
# 気温データを取得
#========================================================================
$CsvData = Import-Csv $CSVFile -Header 1,2
# ヘッダを変数に格納
foreach     ($Row in $CsvData) {
    $CsvHeader1 = $Row.1
    $CsvHeader2 = $Row.2
    break
}

#========================================================================
# Google Charts用HTMLの用意
#========================================================================
$GoogleChartsHTML1 = @"
<html>
  <head>
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Google Visualization APIおよびコアチャートパッケージを読み込み
      google.charts.load('current', {'packages':['corechart']});

      // Google Visualization API読み込み完了後に実行
      google.charts.setOnLoadCallback(drawChart);
      function drawChart() {
        // データテーブルを作成
        var data = new google.visualization.DataTable();
        data.addColumn('string', '');
        data.addColumn('number', '$CsvHeader2');
        data.addRows([
"@

$GoogleChartsHTML2 = @"
        ]);

        // チャートオプションを設定
        var options = {'title':'$GraphTitle',
                       'width':'$Width',
                       'height':'$Height'};

        // 初期化およびチャートの生成
        var chart = new google.visualization.BarChart(document.getElementById('chart_div'));

        // チャートイメージをbase64エンコードされたPNG画像データとして出力
        google.visualization.events.addListener(chart, 'ready', function () {
          document.getElementById('chart_base64').innerHTML = chart.getImageURI();
        });

        // チャートを描画
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <div id="chart_div"></div>
    <div id="chart_base64"></div>
  </body>
</html>
"@

#========================================================================
# CSVデータをGoogle Chartsで使える形式へ加工
#========================================================================
$GraphData = ""
$FirstLineIs = $true
foreach     ($Row in $CsvData) {
    if ($FirstLineIs) {
            $FirstLineIs = $false
            continue
    }

    $GraphData = $GraphData + "['" + $Row.1 + "'," + $Row.2 + "],"
}
$GraphData = $GraphData.trim(",")

#========================================================================
# Google Charts用のHTMLを出力
#========================================================================
$GoogleChartsHTML1                                  > $OutFile
$GraphData                                          >>$OutFile
$GoogleChartsHTML2                                  >>$OutFile

#========================================================================
# WebDriver起動
#========================================================================
webdriver_edge_start.ps1

#========================================================================
# Microsoft EdgeでGoogle Charts用のHTMLをオープン
#========================================================================
$FileURL = "file:///" + $OutFile.Replace('\','/')

'Microsoft Edgeでグラフを描画します。'
Set-SeUrl -Url $FileURL

#========================================================================
# 描画されたグラフをBase64エンコードされたPNGデータとして取得
#========================================================================
'描画したグラフをBase64エンコードされたPNGデータとして取得します。'
$Element = Get-SeElement -By XPath -Value '//*[@id="chart_base64"]'
$Base64 = $Element.Text -replace 'data:image/png;base64,',''

#========================================================================
# Base64エンコードデータをデコードしてファイルへ保存
#========================================================================
'Base64エンコードされたPNGデータをデコードして保存します。'
$Bytes = [Convert]::FromBase64String($Base64)
[IO.File]::WriteAllBytes($PNGFile, $Bytes)

#========================================================================
# WebDriverを終了
#========================================================================
webdriver_edge_stop.ps1

#========================================================================
# 作業用の一時ファイルを削除
#========================================================================
Remove-Item $OutFil

サンプルとして使うCSVデータ「data.csv」は前回と同じ次のデータだ。

"場所","気温"
"小河内","17.6"
"青梅","20.8"
"練馬","21.4"
"八王子","20.2"
"府中","20.7"
"東京","21.3"
"江戸川臨海","19.6"
"羽田","18.7"
"大島","19.8"
"大島北ノ山","19.2"
"新島","18.8"
"神津島","17.9"
"三宅島","19.0"
"三宅坪田","20.6"
"八重見ヶ原","21.2"
"八丈島","20.5"
"父島","24.2"

それでは書き換えた部分を見ていこう。

今回書き換えた部分

前回のPowerShellスクリプトでは、次の3カ所がハードコーディングされていた。

◆出力ファイルが固定パスになっている

$CSVFile    = $Args[0]
$OutFile    = $env:HOMEDRIVE + $env:HOMEPATH + '\out.html'
$PNGFile    = $env:HOMEDRIVE + $env:HOMEPATH + '\out.png'

◆グラフのタイトルが固定されている

$GraphTitle = '東京都の現在の気温'

◆グラフのサイズが固定されている

                       'width':2000,
                       'height':1200};

ということで、これらの部分をパラメータにまとめた。次のように整理してある。

#========================================================================
# 引数を処理
#   -CSVFile パス             グラフのCSVデータファイルパス
#   -PNGFile パス             生成するPNG画像のファイルパス
#   -OutFile パス             中間生成されるHTMLファイルパス
#   -GraphTitle タイトル        グラフのタイトル
#   -Width 幅                        生成するPNG画像の幅
#   -Height 高さ              生成するPNG画像の高さ
#========================================================================
Param(
    [Parameter(Mandatory=$true)][String]$CSVFile,
    [String]$PNGFile = (Get-Location).ToString() + '\out.png',
    [String]$OutFile = (Get-Location).ToString() + '\out.html',
    [String]$GraphTitle = 'グラフ',
    [Int]$Width = 2000,
    [Int]$Height = 1200
)

これに合わせてハードコーディングされていた部分は、次のように変数に置き換えるように書き換えを行っている。

        var options = {'title':'$GraphTitle',
                       'width':'$Width',
                       'height':'$Height'};

これがPowerShellスクリプトの優れた部分の一つなのだが、param()がスクリプトの内容を整理するための仕組みとしても機能してくれる。後発のプログラミング言語には、それまでのプログラミング言語の蓄積が反映されるので、こうした便利な機能が最初から導入されていることが多い。プログラミングの仕組みに従ってコーディングすると自動的に整理されたコードが書けるようになっているというわけだ。

実行して動作を確認

それでは早速動作を確認してみる。まず、次のようにPowerShellスクリプトを実行して動作を確認する。

csv2barchart.ps1 -CSVFile .\data.csv -GraphTitle '東京都の現在の気温'
  • csv2barchart.ps1の動作サンプル その1

    csv2barchart.ps1の動作サンプル その1

この実行で次のグラフが生成された。

  • csv2barchart.ps1の動作で生成されたグラフ その1

    csv2barchart.ps1の動作で生成されたグラフ その1

パラメータで動作が変わることを確認したいので、今度は次のようにPowerShellスクリプトを実行する。

csv2barchart.ps1 -CSVFile .\data.csv -GraphTitle 'タイトルを変更'
  • csv2barchart.ps1の動作サンプル その2

    csv2barchart.ps1の動作サンプル その2

この実行で次のグラフが生成される。

  • csv2barchart.ps1の動作で生成されたグラフ その2

    csv2barchart.ps1の動作で生成されたグラフ その2

パラメータの内容に合わせて生成されたグラフが変わっていることを確認できる。

生成される画像や中間ファイルのパスはホームディレクトリからカレントディレクトリへ変更してある。

汎用スクリプトとしてはこのあたりでまずは十分

汎用的に使用するPowerShellスクリプトとしては、まずこのあたりまで実装しておけば十分だと思う。ほかのスクリプトから呼び出したり、インタラクティブシェルから叩いて実行したりするのに必要最低限の機能は実装した状態だ。後は実際に使いながら、必要な機能が出てきたらその都度書き換えていけばよい。

数値データからグラフ画像を自動生成するスクリプトとなると、複雑なプログラミングが必要になるのではないかと考えるかもしれない。だが、実際には現在オープンに公開されている機能を組み合わせることで作ることができる。PowerShellがグルー言語であり、さまざまな機能の統合を簡単に行えることも、こうした機能の実現に役立っている。

もちろんPowerShellではなくほかのプログラミング言語を使ってグラフを生成してもよいのだが、Windowsの標準シェルであるPowerShellでこうした機能を実現できることは知っておいていただきたい。Windowsを使うのであれば、PowerShellはとにかく強力なシェルだ。その活用スキルを伸ばしておいて損をすることはまずないので、積極的に取り組んでもらえればと思う。

付録

webdriver_edge_start.ps1

#!/usr/bin/env pwsh

#========================================================================
# Microsoft Edge WebDriverを起動する
#========================================================================

#========================================================================
# 動作しているMicrosoft Edge WebDriverをすべて終了
#========================================================================
webdriver_edge_stop.ps1

#========================================================================
# Seleniumモジュールがない場合にはインストール
#========================================================================
if (-Not (Get-InstalledModule -Name Selenium 2> $Null)) {
    'Seleniumモジュールをインストールします。'
    Install-Module -Name Selenium -AllowPrerelease -Force
    Get-InstalledModule -Name Selenium
}

#========================================================================
# Microsoft Edge WebDriverを起動
#========================================================================
'Microsoft Edge WebDriverを起動します。'
$Size = '1200,800'
if  (-Not (Start-SeDriver -Browser Edge -Size $Size 2> $Null 3> $Null))
{
    #================================================================
    # Microsoft EdgeとMicrosoft Edge WebDriverのバージョンが一致して
    # いないためにドライバが動作しなかった可能性がある。
    #================================================================

    #================================================================
    # 不要なドライバプロセスを終了
    #================================================================
    webdriver_edge_stop.ps1

    #================================================================
    # Microsoft Edgeのバージョン番号
    #================================================================
    $EdgeDir='C:\Program Files (x86)\Microsoft\Edge\Application\'
    $EdgeVersion=(  Get-ChildItem -Name $EdgeDir                    | 
                    Where-Object { $_ -NotMatch "[a-zA-Z]+" }       |
                    Select-Object -First 1                          )
                    # ↑ 【Select-Object -First 1の理由】
                    # 更新前のバージョンと更新後のバージョンが同時に
                    # 存在するタイミングがあるので、更新後のバージョン
                    # のみを取得するためにSelect-Objectを実行している。

    #================================================================
    # Microsoft Edge WebDriverダウンロードURLとデプロイ先パス
    #================================================================
    $DriverURL="https://msedgedriver.azureedge.net/$EdgeVersion/edgedriver_win64.zip"

    $SeModVer=(Get-InstalledModule -Name Selenium).Version -replace "-.+$",""
    $DriverDir="$env:HOME\Documents\powershell\Modules\Selenium\$SeModVer\assemblies"
    $DriverDownloadDir="$DriverDir\_download"

    #================================================================
    # WebDriverダウンロード用の一時ディレクトリを作成
    #================================================================
    New-Item        $DriverDownloadDir -ItemType Directory -Force

    #================================================================
    # Microsoft Edgeと同じバージョンのMicrosoft Edge WebDriverを
    # ダウンロード
    #================================================================
    "Microsoft Edge WebDriver version $EdgeVersion をダウンロードします。"
    curl            -get                                            `
                    -o      $DriverDownloadDir\edgedriver_win64.zip `
                    $DriverURL

    #================================================================
    # Microsoft Edge WebDriverをデプロイ
    #================================================================
    "Microsoft Edge WebDriver version $EdgeVersion をインストールします。"
    Expand-Archive  -Path $DriverDownloadDir\edgedriver_win64.zip   `
                    -Destination $DriverDownloadDir                 `
                    -Force

    Copy-Item       -Path $DriverDownloadDir\msedgedriver.exe       `
                    -Destination $DriverDir\msedgedriver.exe        `
                    -Force

    #================================================================
    # WebDriverダウンロード用の一時ディレクトリを削除
    #================================================================
    Remove-Item     $DriverDownloadDir -Recurse -Force

    #================================================================
    # Microsoft Edge WebDriverを起動する
    #================================================================
    if      (-Not (Start-SeDriver -Browser Edge -Size $Size 2> $Null 3> $Null)) 
    {
            #========================================================
            # 原因不明の起動不能
            #========================================================

            #========================================================
            # 不要なドライバプロセスを終了
            #========================================================
            webdriver_edge_stop.ps1

            Exit
    }
}
'Microsoft Edge WebDriverの起動処理完了。'

webdriver_edge_stop.ps1

#!/usr/bin/env pwsh

#========================================================================
# Microsoft Edge WebDriverを終了する
#========================================================================

#========================================================================
# WebDriverプロセスを終了
#========================================================================
if  (Get-Process -Name msedgedriver 2> $Null) 
{
    '動作しているMicrosoft Edge WebDriverを終了します。'
    Get-Process -Name msedgedriver 2> $Null

    # Microsoft Edge WebDriverを終了
    Stop-SeDriver 2> $Null

    # まだ動作しているほかのMicrosoft Edge WebDriverを終了
    if      (Get-Process -Name msedgedriver 2> $Null) 
    {
            Get-Process -Name msedgedriver 2> $Null | Stop-Process
    }

    '動作しているMicrosoft Edge WebDriverの終了処理完了。'
}