cmdlet 如何知道它何时真正应该调用 WriteVerbose()？

Question

cmdlet 如何知道它何时真正应该调用WriteVerbose()， WriteDebug()等等？

也许我错过了一些简单的事情，但我找不到答案。所有 cmdlet 到目前为止我看到的实现只是调用WriteVerbose() 没有任何 犹豫。我知道这样做是正确，但它不是有效。

详细模式关闭但 cmdlet 仍在准备时，性能会受到影响 WriteVerbose() 调用的数据，也就是说，一无所有。

换句话说，在 cmdlet 中我希望能够：

if (<VerboseMode>)
{
    .... data preparation, sometimes expensive ...
    WriteVerbose(...);
}

但我不知道如何获得这个if (<VerboseMode>)。有什么想法吗？

---

结论： @stej 的答案显示了如何在理论上获得所需的信息。在实践中，这是 hacky 并且不太适合。因此，如果 cmdlet 产生非常昂贵的详细或调试输出，那么引入一个指定详细级别的附加参数看起来是合理的。

Answer 1

这是来自System.Management.Automation.MshCommandRuntime的方法。

internal void WriteVerbose(VerboseRecord record)
{
    if ((this.Host == null) || (this.Host.UI == null))
    {
        tracer.TraceError("No host in CommandBase.WriteVerbose()", new object[0]);
        throw tracer.NewInvalidOperationException();
    }
    ActionPreference verbosePreference = this.VerbosePreference;
    if (this.WriteHelper_ShouldWrite(verbosePreference, this.lastVerboseContinueStatus))
    {
        if (record.InvocationInfo == null)
        {
            record.SetInvocationInfo(this.MyInvocation);
        }
        this.CBhost.InternalUI.WriteVerboseRecord(record);
    }
    this.lastVerboseContinueStatus = this.WriteHelper(null, null, verbosePreference, this.lastVerboseContinueStatus, "VerbosePreference");
}

MshCommandRuntime 实现了接口ICommandRuntime，它对详细程度一无所知：| （通过反射器发现）。 MshCommandRuntime 的实例应该在 Cmdlet (public ICommandRuntime CommandRuntime { get; set; }) 中可用。

所以应该可以将属性CommandRuntime 转换为MshCommandRuntime 并检查详细程度。不管怎样，这真的很丑。

---

我完全同意应该有一种简单的方法来找出它。除此之外（梦想中的）编译器应该足够聪明，不会在这种情况下评估某些字符串：

$DebugPreference = 'SilentlyContinue'
$array = 1..1000
Write-Debug "my array is $array"

永远不会使用Write-Debug 的输入，因此不应在传递的字符串中评估$array。（可以测试它是否真的被评估为：Write-Debug "my array is $($array|%{write-host $_; $_})"

Answer 2

怎么样：

BEGIN {
    if ($PSCmdlet.MyInvocation.BoundParameters["Debug"].IsPresent) {
        $HasDebugFlag = $true
    }

    if ($PSCmdlet.MyInvocation.BoundParameters["Verbose"].IsPresent) {
        $HasVerboseFlag = $true
    }
}
PROCESS {
    if ($HasVerboseFlag) {
        expensive_processing
    }
}

警告：仅在 PowerShell 3 上测试。

Answer 3

因此，我们不仅要考虑 cmdlet 的公共参数 -Debug 和 -Verbose，还要考虑全局 $DebugPreference 和 $VerbosePreference 标志，以及如果 cmdlet 从另一个 cmdlet。

无需修改内部结构即可完成。

This answer 向您展示了它可以在 PowerShell cmdlet 中解决一些小问题。

function f { [cmdletbinding()]Param() 
    $debug = $DebugPreference -ne 'SilentlyContinue'
    $verbose = $VerbosePreference -ne 'SilentlyContinue'
    "f is called"
    "    `$debug = $debug"
    "    `$verbose = $verbose"
}
function g { [cmdletbinding()]Param() 
    "g is called"
    f 
}
f
f -Debug -Verbose
g
g -Debug -Verbose

在 C# 中，我们必须检查这些全局标志以及公共参数。请务必从 PSCmdlet 而不是 Cmdlet 继承以获取 GetVariableValue 方法。

bool debug = false;
bool containsDebug = MyInvocation.BoundParameters.ContainsKey("Debug");
if (containsDebug)
    debug = ((SwitchParameter)MyInvocation.BoundParameters["Debug"]).ToBool();
else
    debug = (ActionPreference)GetVariableValue("DebugPreference") != ActionPreference.SilentlyContinue;

bool verbose = false;
bool containsVerbose = MyInvocation.BoundParameters.ContainsKey("Verbose");
if (containsVerbose)
    verbose = ((SwitchParameter)MyInvocation.BoundParameters["Verbose"]).ToBool();
else
    verbose = (ActionPreference)GetVariableValue("VerbosePreference") != ActionPreference.SilentlyContinue;