主页 / coding / 问题 / 79193243
Accepted
alx9r
Asked: 2024-11-16 00:37:42 +0800 CST

是否可以从.ps1 脚本的脚本块在全局范围内创建函数？

  • 772

考虑一个名为内容的PowerShell 脚本s.ps1

1/0

和假设函数

NAME
    New-GlobalFunction

SYNOPSIS
    Creates a new function in global scope from a script.

SYNTAX
    New-GlobalFunction [-ScriptPath] <string> [-FunctionName] <string>

我希望能够使用这样的方法定义全局函数，从而产生显示正确文件的错误位置信息，类似于以下内容：Invoke-SNew-GlobalFunctionInvoke-S

PS C:\> New-GlobalFunction -ScriptPath .\s.p1 -FunctionName Invoke-S; Invoke-S
RuntimeException: C:\s.ps1:1
Line |
   1 |  1/0
     |  ~~~
     | Attempted to divide by zero.
----------

Attempted to divide by zero.
at <ScriptBlock>, C:\s.ps1: line 1

请留意提及的原始文件c.ps1。

PowerShell 的架构表明这应该是可能的，因为脚本和函数只是脚本块：

在 PowerShell 编程语言中，脚本块是可用作单个单元的语句或表达式的集合。语句集合可以用括号 ({}) 括起来，定义为函数，或保存在脚本文件中。

实际上， 定义的脚本块s.ps1可以通过 访问Get-Command .\s.ps1 | % ScriptBlock。 上面带有正确位置信息的错误是通过调用该脚本块产生的。 事实上，可以使用以下命令将该脚本块转换为本地函数

New-Item -Path Function: -Name Invoke-S -Value (Get-Command .\s.ps1 | % ScriptBlock)

然而，我还没有成功创建这样一个全局函数。

有没有办法定义，New-GlobalFunction使得文件中定义的脚本块产生的错误在-ScriptPath其错误位置消息中包含正确的文件？

无效的方法

下面的代码尝试了我尝试过的各种创建方法Invoke-S。它输出以下内容：

method                    new_error                 invoke_error                           stacktrace
------                    ---------                 ------------                           ----------
iex function global                                 Attempted to divide by zero.           at global:Invoke-S, <No file>…
function global: $sb      Missing function body in… The term 'Invoke-S' is not recognized… at <ScriptBlock>, C:\Users\Us…
New-Item Function:                                  The term 'Invoke-S' is not recognized… at <ScriptBlock>, C:\Users\Us…
New-Item global:Function: Cannot find drive. A dri… The term 'Invoke-S' is not recognized… at <ScriptBlock>, C:\Users\Us…
Get-Variable function:    Cannot find a variable w… The term 'Invoke-S' is not recognized… at <ScriptBlock>, C:\Users\Us…

这些方法要么没有创建函数以使其在调用者的范围内可用（错误消息'Invoke-S' is not recognized，要么堆栈跟踪没有提到正确的文件（错误消息at global:Invoke-S, <No file>）。

function New-GlobalFunction {
param(
    [Parameter(Mandatory)][string]   $ScriptPath  ,
    [Parameter(Mandatory)][string]   $FunctionName,
    [Parameter(Mandatory)][ValidateSet(
        'iex function global'      ,
        'function global: $sb'     ,
        'New-Item Function:'       ,
        'New-Item global:Function:',
        'Get-Variable function:'    )]$Method
)
switch ($Method) {
    'iex function global' {
        Invoke-Expression `
            -Command "function global:$FunctionName {
                        $(Get-Content $ScriptPath)
                     }"
    }
    'function global: $sb' {
        $sb =
            Get-Command           `
                -Name $ScriptPath |
            % ScriptBlock
        # function global:Invoke-S $sb
        throw 'Missing function body in function declaration.'
    }
    'New-Item Function:' {
        New-Item                       `
            -ErrorAction Stop          `
            -Path        Function:     `
            -Name        $FunctionName `
            -Value (Get-Command $ScriptPath |
                    % ScriptBlock            )
    }
    'New-Item global:Function:' {
        New-Item                    `
            -ErrorAction Stop       `
            -Path  global:Function: `
            -Name  $FunctionName    `
            -Value (Get-Command $ScriptPath |
                    % ScriptBlock            )
    }
    'Get-Variable function:' {
        Get-Variable          `
            -Name 'function:' `
            -ErrorAction Stop
    }
}}

$(foreach ($method in 'iex function global'         ,
                      'function global: $sb',
                      'New-Item Function:'          ,
                      'New-Item global:Function:'   ,
                      'Get-Variable function:'       ) {
    [pscustomobject]@{
        method       = $method
        new_error    = $(try {$null =
                              New-GlobalFunction       `
                                -ScriptPath  .\s.ps1   `
                                -FunctionName Invoke-S `
                                -Method       $method   }
                        catch {$_})
        invoke_error = ($e =
                       try {Invoke-S -ErrorAction Stop}
                       catch {$_}     )
        stacktrace   = $e.ScriptStackTrace
        e            = $e
    }
    Remove-Item Function:Invoke-S -ErrorAction SilentlyContinue
}) |
    Format-Table `
        -Property @{e='method'      ;width=25},
                  @{e='new_error'   ;width=25},
                  @{e='invoke_error';width=38},
                  @{e='stacktrace'  ;width=30}

参考

powershell

2 个回答

  1. Best Answer

    下面使用命名空间变量表示法似乎有效：

    $FunctionName = 'Invoke-S'
$ScriptPath = '.\s.ps1'
Invoke-Expression @"
`${Function:global:$FunctionName} = (Get-Command "$ScriptPath").ScriptBlock
"@

    在这种情况下，基于 cmdlet 的上述等效方法实际上更简单，因为函数名称可以直接用变量来表示：

    $FunctionName = 'Invoke-S'
$ScriptPath = '.\s.ps1'
Set-Content Function:global:$FunctionName (Get-Command $ScriptPath).ScriptBlock

    在您的功能上下文中：

    function New-GlobalFunction {
  param(
    [Parameter(Mandatory)] [string] $ScriptPath,
    [Parameter(Mandatory)] [string] $FunctionName
  )
  Set-Content Function:global:$FunctionName (Get-Command $ScriptPath).ScriptBlock
}

# Sample call
New-GlobalFunction -ScriptPath .\s.ps1 -FunctionName Invoke-S

    解释：

    具体来说，变量表达式（由[1]${Function:global:Invoke-S}解释的扩展形式）/传递给的参数（位置隐含的）分解如下：Invoke-Expression-PathFunction:global:Invoke-SSet-Content

    • Function:引用提供程序Function:公开的内置驱动器Function

    • global:Invoke-SInvoke-S指的是全局作用域内命名的函数；也global:就是作用域修饰符。

      • 这种范围修饰符在函数定义中并不常见，但它们确实有效；例如，在全局范围内function global:Test-Me { 'hi!' }定义一个函数。Test-Me

    • 函数名包含-，这是一个需要将整个（命名空间符号）变量名表达式括起来{...}才能被识别为单个变量表达式的字符。

      • 请注意，在解决方案的参数解析模式中这不是必需的；作为单个参数可以正常工作。Set-ContentFunction:global:Invoke-S

    通过分配/${Function:global:Invoke-S}使用该名称作为路径Set-Content，可以创建或更新全局Invoke-S函数；必须分配/传递给（位置隐含的）参数-Value的Set-Content是函数体（类似地，获取此变量的值/使用Get-Content Function:global:Invoke-S将返回函数的主体作为脚本块，假设该函数存在）。

    • 作为分配/传递脚本块的替代方法，您还可以将主体作为字符串（源代码文本）分配/传递；但是，在当前情况下，仅分配通过获取的脚本块Get-Command即可保留完整的来源信息，即包括来源文件的路径.ps1。

    在调用者范围内定义函数的变体解决方案：

    • 上述解决方案取决于能否在函数名称中使用范围修饰符，即global:

    • 但是，没有办法通过范围修饰符来指定相对范围，如果你想在调用者的范围中定义一个函数就需要这样做 - 无论调用者位于哪个范围。

      • 相对范围（例如1引用父范围）仅通过实体特定的-Scopecmdlet的参数支持，例如和；没有Set-VariableSet-Alias Set-Function删除指定名称的命令。

        • 然而，可以想象，即使是通用提供程序cmdlet（例如New-Item和Set-Content）也可以扩展以提供特定于实体的动态参数（此类参数的现有示例是特定于提供程序的-File和开关）。-DirectoryFileSystem

      • 这个遗漏是GitHub 讨论 #16881的主题（由于语言不当，建议读者谨慎使用），目前唯一的（次优的）解决方法是使用 .NET反射来访问非公共成员（不能保证其 [以该形式] 的持续存在），特别是内部.GetScopeByID()方法，正如您所说，它本身只能通过通过另一个非公共 API 获得的对象来访问。

      • 下面的解决方案使用了链接讨论中的代码的简化版本，并且与前者不同，它还支持将函数放入模块New-FunctionInCallerScope内，尽管假设它只能从该模块外部调用。

    function New-FunctionInCallerScope {
  param(
    [Parameter(Mandatory)] [string] $ScriptPath,
    [Parameter(Mandatory)] [string] $FunctionName
  )

  # Binding flags for finding non-public instance members via reflection.
  $bindingFlags = [System.Reflection.BindingFlags] 'NonPublic, Instance'
  # Get the caller's internal session state, via $PSCmdlet.SessionState
  $sessionStateInternal = [System.Management.Automation.SessionState].
                            GetMethod('get_Internal', $bindingFlags).
                            Invoke($PSCmdlet.SessionState, $null)
  # Determine the scope index relative to $PSCmdlet.SessionState[Internal],
  # which is the *caller's* session state:
  # * If this function is inside a module, it lives in a different "session state"
  #   (scope domain), so use the caller's *current* scope (0) 
  #   (the caller is assumed to be an *outside* caller).
  # * If this function is a non-module function, it runs in the same "session state"
  #   as the caller, but in a *child* scope (unless dot-sourced), so use the parent
  #   scope (1).
  $callerScopeIndex = if ($MyInvocation.MyCommand.Module) { 0 } else { 1 }
  # Retrieve the target scope.
  $scope = $sessionStateInternal.GetType().
             GetMethod('GetScopeByID', $bindingFlags, [type[]] [int]).
             Invoke($sessionStateInternal, $callerScopeIndex)
  # Get the scope's function table. 
  $funcTable = $scope.GetType().
                 GetMethod('get_FunctionTable', $bindingFlags).
                 Invoke($scope, $null)
  # Create / update the function with the given name and script block from the given file.
  # Note: A [System.Management.Automation.FunctionInfo] instance must be assigned, which is
  #       is obtained via an aux. transitory, scope-local function whose name doesn't matter.
  $funcTable[$FunctionName] = New-Item Function:UnusedName -Value (Get-Command $ScriptPath).ScriptBlock
}

# Sample calls:

# Define function Invoke-S in the caller's scope.
New-FunctionInCallerScope -ScriptPath .\s.ps1 -FunctionName Invoke-S

# The function is now visible in this scope (and its descendants), 
# but not in any parent scope.
Invoke-S

    [1] 请注意，虽然在这种特殊情况下使用Invoke-Expression（iex）是安全的，但通常应避免使用。

    • 2

  2. 存储CommandInfo在值脚本块中的另一种方法。

    function New-GlobalFunction {
    param(
        [Parameter(Mandatory)]
        [string] $ScriptPath,

        [Parameter(Mandatory)]
        [string] $FunctionName,

        [Parameter()]
        [switch] $Force
    )

    $command = Get-Command $ScriptPath -ErrorAction Stop
    $null = $PSCmdlet.SessionState.InvokeProvider.Item.New(
        'function:',
        "global:$FunctionName",
        'Function',
        $command.ScriptBlock,
        $Force.IsPresent)
}
    • 1

相关问题