自動変数

自動変数

PowerShell Coreには実行中にPowerShell Coreによって生成される変数がある。この変数は「自動変数」と呼ばれており、リードオンリーでの利用が想定されている。機能として自動変数を上書きすることはできるのだが、互換性の面からそういった利用はしない方がよいとされている。

PowerShell Coreに用意されている主な自動変数は次のとおり。

すべての自動変数を覚える必要はなく、必要なものだけ覚えておけばよい。以降でよく使うことになる自動変数とその使用例を取り上げる。

$TRUEと$FALSE

スクリプトを書いていると、ロジック的にここに処理がきた場合にはエラーとして処理したいとか、逆にコマンドの実行結果が成功していても失敗していても成功として処理させたいことがある。UNIX系オペレーティングシステムのシェルスクリプトであればtrueとfalseというコマンドが存在しているので、これを使うことになる。

trueアプリケーション - PowerShell Core/macOS

PS /Users/daichi> Get-Command true | Format-List


Name            : true
CommandType     : Application
Definition      : /usr/bin/true
Extension       :
Path            : /usr/bin/true
FileVersionInfo : File:             /usr/bin/true
                  InternalName:
                  OriginalFilename:
                  FileVersion:
                  FileDescription:
                  Product:
                  ProductVersion:
                  Debug:            False
                  Patched:          False
                  PreRelease:       False
                  PrivateBuild:     False
                  SpecialBuild:     False
                  Language:




PS /Users/daichi>

falseアプリケーション - PowerShell Core/macOS

PS /Users/daichi> Get-Command false | Format-List

Name            : false
CommandType     : Application
Definition      : /usr/bin/false
Extension       :
Path            : /usr/bin/false
FileVersionInfo : File:             /usr/bin/false
                  InternalName:
                  OriginalFilename:
                  FileVersion:
                  FileDescription:
                  Product:
                  ProductVersion:
                  Debug:            False
                  Patched:          False
                  PreRelease:       False
                  PrivateBuild:     False
                  SpecialBuild:     False
                  Language:




PS /Users/daichi>

しかし、このコマンドはWindowsには存在しておらず、実行しようとすれば次のようにエラーになる。

自動変数の$TRUEおよび$FALSEはそういった場合に利用できる。この変数を利用すればtrueやfalseといったコマンドが存在しないプラットフォームでも処理が機能することになる。

$?

$?は直前に実行したコマンドが成功しているか失敗しているかを保持する自動変数だ。常に成功するtrueと常に失敗するfalseというアプリケーション（UNIX系オペレーティングシステムのコマンド）を使って動作を確認すると次のようになる。

直前のコマンドが成功した場合の$?の中身

PS /Users/daichi> true
PS /Users/daichi> echo $?
True
PS /Users/daichi>

直前のコマンドが失敗した場合の$?の中身

PS /Users/daichi> false
PS /Users/daichi> echo $?
False
PS /Users/daichi>

この自動変数は直前のコマンドの実行を監視して、失敗した場合にはエラーメッセージを出すようにするとか、何らかの処理をリトライするとか、そういった動作をさせる場合に利用できる。

これを簡単に書くと次のようになる。

直前のコマンドが成功している場合には何もしない

PS /Users/daichi> true
PS /Users/daichi> if (! $?) { echo "failed." }
PS /Users/daichi>

直前のコマンドが失敗している場合にはエラーメッセージを出力

PS /Users/daichi> false
PS /Users/daichi> if (! $?) { echo "failed." }
failed.
PS /Users/daichi>

例えば、ネットワークを経由してほかのホストにファイルをコピーするような処理を書いたとする。それはscpでもftpでもなんでもよいのだが、ネットワークを経由してほかのホストにコピーするような処理では、必ずしも処理が成功するとは限らない。

そういった場合、コマンドが成功裏に終了したかどうかを調べ、失敗している場合にはある程度の時間待機してからもう一度同じコマンドを実行するといった処理を行うことがある。$?を使うとそうした処理を実現できる。

$ARGS

PowerShellスクリプトを書くようになると関数を作成する機会が増えると思うが、こういった場合に引数が格納されるのが$ARGSだ。

引数の利用例

PS /Users/daichi> function f() { echo $ARGS }
PS /Users/daichi> f a b c d
a
b
c
d
PS /Users/daichi>

基本的な機能なので覚えておく必要がある。

$HOMEと$PWD

$HOMEにはホームディレクトリ、$PWDにはカレントディレクトリが保持される。どちらも使う機会のある自動変数だ。

$HOMEはユーザのホームディレクトリ以下のデータにアクセスする場合に利用するし、$PWDはカレントディレクトリによって処理を変えたい場合などに利用する。

$ERRORと$STACKTRASE

インタラクティブシェルとして利用している場合も、シェルスクリプトとして利用している場合も、問題が発生した場合のデバッグに利用できる変数が$ERRORと$STACKTRASEだ。

$Errorが保持しているエラー情報

PS /Users/daichi> echo $Error
At line:1 char:3
+ if $(! $?)
+   ~
Missing '(' after 'if' in if statement.
s : The term 's' is not recognized as the name of a cmdlet, function, script file, or operable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:2
+ ;s
+  ~
+ CategoryInfo          : ObjectNotFound: (s:String) [], CommandNotFoundException
+ FullyQualifiedErrorId : CommandNotFoundException

PS /Users/daichi>

$StackTraceが保持しているスタックトレース情報

PS /Users/daichi> echo $StackTrace
   at System.Management.Automation.CommandDiscovery.LookupCommandInfo(String commandName, CommandTypes commandTypes, SearchResolutionOptions searchResolutionOptions, CommandOrigin commandOrigin, ExecutionContext context)
   at System.Management.Automation.CommandDiscovery.LookupCommandInfo(String commandName, CommandOrigin commandOrigin, ExecutionContext context)
   at System.Management.Automation.CommandDiscovery.LookupCommandInfo(String commandName, CommandOrigin commandOrigin)
   at System.Management.Automation.CommandDiscovery.LookupCommandProcessor(String commandName, CommandOrigin commandOrigin, Nullable`1 useLocalScope)
   at System.Management.Automation.ExecutionContext.CreateCommand(String command, Boolean dotSource)
   at System.Management.Automation.PipelineOps.AddCommand(PipelineProcessor pipe, CommandParameterInternal[] commandElements, CommandBaseAst commandBaseAst, CommandRedirection[] redirections, ExecutionContext context)
   at System.Management.Automation.PipelineOps.InvokePipeline(Object input, Boolean ignoreInput, CommandParameterInternal[][] pipeElements, CommandBaseAst[] pipeElementAsts, CommandRedirection[][] commandRedirections, FunctionContext funcContext)
   at System.Management.Automation.Interpreter.ActionCallInstruction`6.Run(InterpretedFrame frame)
   at System.Management.Automation.Interpreter.EnterTryCatchFinallyInstruction.Run(InterpretedFrame frame)
PS /Users/daichi>

すべての自動変数を覚える必要はないが、今回取り上げたような自動変数は利用する機会が多いのでおさえておきたいところだ。

参考資料

• Microsoft PowerShell Module Browser
• Microsoft PowerShell6｜Microsoft.PowerShell.Core｜About｜About Variables
• Microsoft PowerShell6｜Microsoft.PowerShell.Core｜About｜About Automatic Variables
• Microsoft PowerShell6｜Object Pipeline
• Microsoft PowerShell6｜Understanding the Windows PowerShell Pipeline
• Microsoft PowerShell6｜Microsoft.PowerShell.Core｜Get-Command
• Microsoft PowerShell6｜Microsoft.PowerShell.Utility｜Format-List
• Microsoft PowerShell6｜About Regular Expressions
• Microsoft PowerShell6｜Microsoft.PowerShell.Utility｜Get-Member
• Microsoft PowerShell6｜Microsoft.PowerShell.Management｜Get-Item
• Microsoft PowerShell6｜Microsoft.PowerShell.Management｜Get-ChildItem