我列出的我在powershell模块清单中导出的变量实际上并没有导出

时间:2016-07-12 21:45:58

标签: powershell variables module export manifest

我正在创建一个脚本模块并使用清单导出脚本成员并设置其他模块属性。我已经跟踪了我发现的每个示例清单,甚至使用New-ModuleManifest来创建具有我想要的属性的基线清单,我仍然无法获得我想要导出到实际导出的变量。

这里的目的是在清单中执行所有声明,而不必在模块脚本中使用Export-ModuleMember

这是脚本模块:

#
# Widget.psm1
#

[System.Random]$rGen = New-Object System.Random;
[string]$WidgetBaseName = $null;
[string]$WidgetColor = "Blue";

function Get-WidgetName
{
    param
    (
        [Parameter(Mandatory=$true)]
        [string]$widgetName,
        [switch]$appendRandomNumber
    )

    if (![string]::IsNullOrEmpty($WidgetBaseName))
    {
        $widgetName = $WidgetBaseName + $widgetName;
    }

    if ($appendRandomNumber)
    {
        return [string]::Format("{0}{1:D4}", $widgetName, $rGen.Next(10000));
    }
    else
    {
        return $widgetName;
    }
}

function Get-WidgetBlessing()
{
    return [string]::Format("A thousand blessings upon your {0} widget!", $WidgetColor);
}

这就是明白:

#
# Widget.psd1
#

@{

# Script module or binary module file associated with this manifest
RootModule = 'Widget.psm1'

# Version number of this module.
ModuleVersion = '0.0.0.1'

# ID used to uniquely identify this module
GUID = 'c4437164-ea47-4148-97ed-48737bd5824d'

# Author of this module
Author = 'Widget Developer'

# Company or vendor of this module
CompanyName = 'Fictional Company Inc.'

# Copyright statement for this module
Copyright = '(c) 2016 Fictional Company. All rights reserved.'

# Description of the functionality provided by this module
Description = 'Widget Module'

# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of the .NET Framework required by this module
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module
FunctionsToExport = @( "Get-WidgetName", "Get-WidgetBlessing" )

# Cmdlets to export from this module
# CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = 'WidgetBaseName', 'WidgetColor'

# Aliases to export from this module
AliasesToExport = '*'

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess
# PrivateData = ''

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

要检查导出的成员,请在PowerShell窗口中运行以下命令:

Import-Module Widget
Get-Module -Name Widget | fl

这是输出。请注意显然没有任何导出的变量。

Name              : Widget
Path              : D:\SRE\PowerShell\Widget\Widget.psm1
Description       : Widget Module
ModuleType        : Script
Version           : 0.0.0.1
NestedModules     : {}
ExportedFunctions : {Get-WidgetBlessing, Get-WidgetName}
ExportedCmdlets   : 
ExportedVariables : 
ExportedAliases   : 

这是为什么?我使用了New-ModuleManifest生成的清单(New-ModuleManifest -VariablesToExport WidgetBaseName WidgetColor)。该工具是否已损坏,或清单中是否存在导致此行为的其他内容?

更新

我在模块脚本的末尾添加了以下行:

Export-ModuleMember -Variable WidgetBaseName, WidgetColor

我将VariablesToExport的值更改为' *'在清单文件中。

现在,当我导入模块并按上述方法运行检查时,我得到了这个:

Name              : Widget
Path              : D:\SRE\PowerShell\Widget\Widget.psm1
Description       : Widget Module
ModuleType        : Script
Version           : 0.0.0.1
NestedModules     : {}
ExportedFunctions : 
ExportedCmdlets   : 
ExportedVariables : {WidgetBaseName, WidgetColor}
ExportedAliases   : 

...导出的函数在哪里?

2 个答案:

答案 0 :(得分:4)

因此,为了完整起见,以及将来提出这个问题的任何人,我将总结我们在OP的问题评论中的对话。

默认情况下,所有函数都从模块导出,没有其他成员出现此行为。就好像从模块中隐式调用Export-ModuleMember -Function *一样。然后,您可以通过模块清单中的ExportedFunctions键进一步限制导出的功能,例如: ExportedFunctions : {Get-WidgetBlessing, Get-WidgetName}

如果要导出变量或别名,则必须在模块中明确添加对Export-ModuleMember -Variable <what you want to export>Export-ModuleMember -Alias <what you want to export>的调用。但是,一旦您向Export-ModuleMember添加了显式调用,则对Export-ModuleMember -Function *的隐式调用不再发生。如果您向Export-ModuleMember -Function *添加另一个显式调用,或者您的函数将不再继续导出,则必须记住将Export-ModuleMember显式添加到模块中。

答案 1 :(得分:0)

实际上注意到有效回复与文档相反。

来自Microsoft

要导出的功能

  

指定从此模块导出的功能,以实现最佳效果   性能,请勿使用通配符且请勿删除条目,请使用   如果没有要导出的函数,则为空数组。 默认情况下,否   功能已导出。您可以使用此键列出功能   由模块导出。模块将功能导出到   呼叫者的会话状态。呼叫者的会话状态可以是   全局会话状态,或者对于嵌套模块,为   另一个模块。链接嵌套模块时,所有   嵌套模块导出的内容将导出到全局会话   状态,除非链中的模块通过使用   FunctionsToExport键。如果清单导出了别名   函数,此键可以删除别名列在其中的函数   AliasesToExport键,但是此键无法将函数别名添加到   名单。示例:FunctionsToExport = @(“ function1”,“ function2”,   “ function3”)

VariablesToExport

  

指定模块导出到调用方的变量   会话状态。允许使用通配符。 默认情况下,全部   变量('*')已导出。您可以使用此键来限制   模块导出的变量。呼叫者的会话状态   可以是全局会话状态,对于嵌套模块,可以是会话   另一个模块的状态。当您链接嵌套模块时,所有   嵌套模块导出的变量将导出到   全局会话状态,除非链中的模块限制了   通过使用VariablesToExport键来变量。如果清单也   导出变量的别名,此键可以删除变量,   别名列在AliasesToExport键中,但是此键不能添加   列表的变量别名。示例:VariablesToExport =   @('$ MyVariable1','$ MyVariable2','$ MyVariable3')