質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.57%

PowerShellスクリプトにオプションを追加する

解決済

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 1,764

kiritsukiR

score 10

 やりたいこと

以下のようなプログラムがあります。

# 引数を受け取って何かをするプログラム
function sample0 {
    # サンプル用に引数の表示
    Write-Output args:$args

    # $argsに対して何かをする
}


当然、引数にu1,u2,u3を与えると以下のようになります。

PS ***> sample0 u1 u2 u3
args:u1 u2 u3

このプログラムにいくつかのオプションを追加することを考えます。
ここでは値を取らないfalgと値を取るvalueの2つのオプションを取るとします。
つまり、以下のようにしたいです。

PS ***> sample u1 u2 u3
flag:False
value:
args:u1 u2 u3

PS ***> sample -flag u1 u2 u3
flag:True
value:
args: u1 u2 u3

PS ***> sample -value v u1 u2 u3
flag:False
value:v
args:u1 u2 u3

PS ***> sample -flag -value v u1 u2 u3
flag:True
value:v
args:u1 u2 u3

 やったこと

 引数の宣言

まずは、単純に引数として宣言しました。

# 純粋にオプションを用意した
function sample1([switch]$flag, [string]$value) {
    Write-Output flag:$flag
    Write-Output value:$value
    Write-Output args:$args
}


これを実行すると、以下のようにu1がvalueの値になってしまう場合がありました。

PS ***> sample1 u1 u2 u3
flag:False
value:u1 # u1がvalueの値になってしまっている
args:u2 u3

PS ***> sample1 -flag u1 u2 u3
flag:True
value:u1 # u1がvalueの値になってしまっている
args:u2 u3

PS ***> sample1 -value v u1 u2 u3
flag:False
value:v
args:u1 u2 u3

PS ***> sample1 -flag -value v u1 u2 u3
flag:True
value:v
args:u1 u2 u3

 配列を追加

valueに奪われているようなのでその前に配列として受け取ってしまえばいい、と考え配列argumentsを先頭に追加しました。

# 先頭にarrayを入れた
function sample2([array]$arguments, [switch]$flag, [string]$value) {
    Write-Output flag:$flag
    Write-Output value:$value
    Write-Output arguments:$arguments
    Write-Output args:$args
}

その結果、以下のように配列で渡すことで理想の挙動を得ることができました。

PS ***> sample2 u1, u2, u3
flag:False
value:
arguments:u1 u2 u3
args:

PS ***> sample2 -flag u1, u2, u3
flag:True
value:
arguments:u1 u2 u3
args:

PS ***> sample2 -value v u1, u2, u3
flag:False
value:v
arguments:u1 u2 u3
args:

PS ***> sample2 -flag -value v u1, u2, u3
flag:True
value:v
arguments:u1 u2 u3
args:

目的は達成しています。
しかし、以前のように入力すると失敗してしまいます。
可能であればフォーマットは変えたくありません。

PS ***> sample2 u1 u2 u3
flag:False
value:u2
arguments:u1
args:u3

PS ***> sample2 -flag u1 u2 u3
flag:True
value:u2
arguments:u1
args:u3

PS ***> sample2 -value v u1 u2 u3
flag:False
value:v
arguments:u1
args:u2 u3

PS ***> sample2 -flag -value v u1 u2 u3
flag:True
value:v
arguments:u1
args:u2 u3

 TL;DR

引数を宣言した順ではなく、-value vのように変数名とともに値が与えられたときのみ変数に格納するようにするにはどうすればいいでしょうか。

そもそも"PowerShellらしい引数の取り方"でしょうか(bashのシェルスクリプトを書く方が多いので、PowerShellではこんな書き方はしない等のツッコミがあれば是非)

またURLを貼る場合はどのような検索キーワードで辿り着いたかも合わせてお願いします。(検索の仕方が下手なのか、PowerShellのコマンドの使い方ばかりが出てしまう)

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+1

PowerShellの関数の仮引数の定義方法はいくつかありますが、詳細に動作を指定したい場合は関数本文内でparam()を使って定義する必要があります。

今回は質問のsample2をベースに$argumentsパラメータに各種属性を指定することで、希望と思われる動作とすることが出来ました。

各種属性は公式のヘルプである以下のページを参照して記述しました。

about_Functions_Advanced_Parameters | Microsoft Docs

(PowerShellの概念・機能の説明はabout_~からはじまるヘルプトピックに記載されています)

function sample3 {
    param(
        [switch]$flag,

        # 位置を明示・特に指定されないすべての引数を取得
        [parameter(Position=0,ValueFromRemainingArguments=$true)]
        [array]$arguments,

        [string]$value
    )

    Write-Output flag:$flag
    Write-Output value:$value
    Write-Output arguments:$arguments
    Write-Output args:$args
    Write-Host
}

確認に使ったスクリプト

'sample3 u1 u2 u3'
sample3 u1 u2 u3
<#
flag:False
value:
args:u1 u2 u3
#>

'sample3 -flag u1 u2 u3'
sample3 -flag u1 u2 u3
<#
flag:True
value:
args: u1 u2 u3
#>

'sample3 -value v u1 u2 u3'
sample3 -value v u1 u2 u3
<#
flag:False
value:v
args:u1 u2 u3
#>

'sample3 -flag -value v u1 u2 u3'
sample3 -flag -value v u1 u2 u3
<#
flag:True
value:v
args:u1 u2 u3
#>

結果

sample3 u1 u2 u3
flag:False
value:
arguments:u1 u2 u3
args:

sample3 -flag u1 u2 u3
flag:True
value:
arguments:u1 u2 u3
args:

sample3 -value v u1 u2 u3
flag:False
value:v
arguments:u1 u2 u3
args:

sample3 -flag -value v u1 u2 u3
flag:True
value:v
arguments:u1 u2 u3
args:

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/11/07 12:26

    回答ありがとうございます。
    無事に引数を取ることができました。

    キャンセル

0

$args に引数が順番に格納されてるので、それ見て振り分ければいいんじゃ

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.57%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る