'local' 如何成为 PowerShell 模块中的函数参数

Question

我在 PowerShell 中发现了一个令我吃惊的行为，我正在寻找解释。请考虑以下名为 testParameter:

的 PowerShell 模块

testParameter.psd1:

@{
   RootModule         = 'testParameter.psm1'
   ModuleVersion      = '0.1'

   FunctionsToExport  = @(
      'get-embeddedString'
   )
}

testParameter.psm1:

set-strictMode -version 3

function embed-string {

   param (
      [string] $pre,
      [string] $post
   )

  "$($pre)$text$($post)"
}


function get-embeddedString {

   param (
      [string] $text
   )

   return embed-string '>>> ' ' <<<'
}

当我调用 get-embeddedString foo 时，函数 returns（或控制台打印）：

>>> foo <<<

我很惊讶，因为这个字符串是在函数 embed-string 中呈现的，它没有声明名为 $text 的局部变量，没有具有该名称的参数，也没有为在它被使用之前它被使用并且我期望该函数抛出一个The variable '$text' cannot be retrieved because it has not been set. 错误。

显然，embed-string 选择使用 $text 在 get-embeddedString 中的值，我认为它在不同且不相关的范围内。

我不明白这是怎么回事，也不知道在哪里可以找到与此行为相关的文档。

Answer 1

Nested/Child 函数可以访问所有父函数的变量。您甚至可以在子作用域中修改它们，它们在父作用域中返回到原始值。

function embed-string {
   param (
      [string] $pre,
      [string] $post
   )
    Write-Host $MyInvocation.BoundParameters
    Write-Host $MyInvocation.UnboundArguments

    Write-Host $text
    $text = "bar"

    "$($pre)$text$($post)"
}

function get-embeddedString {

    param (
       [string] $text
    )
    
    embed-string '>>> ' ' <<<'

    Write-Host $text
}

输出

[pre, >>> ] [post,  <<<]

foo
>>> bar <<<
foo

如果要在子函数中持久化对变量的更改，可以使用Set-Variable -Name text -Option AllScope。

Link about Nested Functions, applies to Child Functions too

Answer 2

about_Scopes 是描述 PowerShell 中 scopes 的官方概念性帮助主题（通常但不完全与 variables)，但让我提供一个简明的解释：

与大多数 shell 一样，PowerShell 使用动态而不是词法作用域.
- 也就是说，变量的可见性取决于运行时调用堆栈[，而不是仅对封闭的词法结构可见，例如函数定义=80=]。换句话说：给定函数或脚本看到的变量取决于调用它的人。

因此，因为您的 embed-string 函数是从您的 get-embeddedString 函数调用的，而后者定义了一个 $text 变量（通过参数声明在这种情况下），$text 变量对 embed-string 也是可见的 - 并且对从 it 调用的函数也是可见的（和依此类推）。

值得注意的陷阱:

虽然非限定（非作用域）读取访问祖先变量获取其值，分配一个值 隐式地创建了一个新的 local 变量，shadows 祖先变量.

例如，"$($pre)$text$($post)" 在您的 embed-string 函数中获取祖先 $text 变量的值，但是如果您要执行，比如说，$text = 'value' 在那里，你会创建一个同名的 局部变量 ，然后它对调用堆栈上的任何 embed-strings 后代可见，但不相关到原始 get-embeddedstring $text 变量。

仅限同一范围域中的范围（又名会话状态），在相同的运行空间，表现出这种关系； 每个模块都有自己的范围域，所有非模块代码共享一个单独的域。所有范围域共享的唯一一个范围是 global 范围，它是 all[=80= 的 root 范围] 范围域。

有关 PowerShell 作用域的全面概述，请参阅的底部部分。

'local' 如何成为 PowerShell 模块中的函数参数

How 'local' are function parameters in a PowerShell module

parameters

powershell

scope

module