PowerShell : obtenir le chemin et le nom du script courant
Comparaison de $PSCommandPath et des propriétés de $MyInvocation, dans un script et dans une fonction.
Retrouver le nom ou le chemin du script en cours d'exécution est une source de confusion fréquente : les variables automatiques $PSScriptRoot et $PSCommandPath, ainsi que les propriétés PSScriptRoot et PSCommandPath de $MyInvocation, décrivent l'appelant (le script qui a invoqué le code) et non toujours le script courant. Cet article compare les variantes, directement dans le script et à l'intérieur d'une fonction (voir aussi la discussion sur Stack Overflow).
Script de test
function PSCommandPath() { return $PSCommandPath; }
function ScriptName() { return $MyInvocation.ScriptName; }
function MyCommandName() { return $MyInvocation.MyCommand.Name; }
function MyCommandDefinition() { return $MyInvocation.MyCommand.Definition; }
function MyInvocationPSCommandPath() { return $MyInvocation.PSCommandPath; }
Write-Host "PSVersion: $($PSVersionTable.PSVersion)"
Write-Host "`$PSCommandPath:"
Write-Host " * Direct: $PSCommandPath"
Write-Host " * Function: $(PSCommandPath)"
Write-Host "`$MyInvocation.ScriptName:"
Write-Host " * Direct: $($MyInvocation.ScriptName)"
Write-Host " * Function: $(ScriptName)"
Write-Host "`$MyInvocation.MyCommand.Name:"
Write-Host " * Direct: $($MyInvocation.MyCommand.Name)"
Write-Host " * Function: $(MyCommandName)"
Write-Host "`$MyInvocation.MyCommand.Definition:"
Write-Host " * Direct: $($MyInvocation.MyCommand.Definition)"
Write-Host " * Function: $(MyCommandDefinition)"
Write-Host "`$MyInvocation.PSCommandPath:"
Write-Host " * Direct: $($MyInvocation.PSCommandPath)"
Write-Host " * Function: $(MyInvocationPSCommandPath)"
Résultat (script C:\Test\test.ps1, PowerShell 5.1)
| Variable | Directement dans le script | Dans une fonction |
|---|---|---|
$PSCommandPath |
C:\Test\test.ps1 |
C:\Test\test.ps1 |
$MyInvocation.ScriptName |
vide | C:\Test\test.ps1 |
$MyInvocation.MyCommand.Name |
test.ps1 |
nom de la fonction |
$MyInvocation.MyCommand.Definition |
C:\Test\test.ps1 |
corps de la fonction |
$MyInvocation.PSCommandPath |
vide | C:\Test\test.ps1 |
Remarques
$PSCommandPathest la solution la plus simple : elle renvoie le chemin complet du script courant, aussi bien directement que depuis une fonction.$MyInvocation.MyCommand.Definitiondans une fonction renvoie le contenu de la fonction, pas un chemin.