Как правильно использовать параметры -verbose и -debug в пользовательском командлете - PullRequest
Новая
       6

Как правильно использовать параметры -verbose и -debug в пользовательском командлете

38 голосов
/ 29 ноября 2010

По умолчанию любая именованная функция, имеющая атрибут [CmdletBinding ()], принимает параметры -debug и -verbose (и несколько других) и имеет предопределенные переменные $ debug и $ verbose. Я пытаюсь выяснить, как передать их другим командлетам, которые вызываются внутри функции.

Допустим, у меня есть такой командлет: 

function DoStuff() {
   [CmdletBinding()]

   PROCESS {
      new-item Test -type Directory 
   }
}

если в мою функцию были переданы -debug или -verbose, я хочу передать этот флаг в командлет new-item. Какой правильный шаблон для этого?

Ответы [ 8 ]

33 голосов
/ 20 июля 2011

$PSBoundParameters не то, что вы ищете.Использование атрибута [CmdletBinding()] позволяет использовать $PSCmdlet в вашем скрипте, в дополнение к предоставлению подробного флага.На самом деле это тот самый Verbose, который вы должны использовать.

Через [CmdletBinding()] вы можете получить доступ к связанным параметрам через $PSCmdlet.MyInvocation.BoundParameters.Вот функция, которая использует CmdletBinding и просто сразу вводит вложенное приглашение, чтобы изучить переменные, доступные в области действия функции. 

PS D:\> function hi { [CmdletBinding()]param([string] $Salutation) $host.EnterNestedPrompt() }; hi -Salutation Yo -Verbose

PS D:\>>> $PSBoundParameters

____________________________________________________________________________________________________
PS D:\>>> $PSCmdlet.MyInvocation.BoundParameters

Key Value                                                                                                                                                                                                           
--- -----                                                                                                                                                                                                           
Salutation Yo                                                                                                                                                                                                              
Verbose   True

Итак, в вашем примере вы хотели бы следующее: 

function DoStuff `
{
    [CmdletBinding()]
    param ()
    process
    {
      new-item Test -type Directory `
        -Verbose:($PSCmdlet.MyInvocation.BoundParameters["Verbose"].IsPresent -eq $true)
    }
}

Это относится к -Verbose, -Verbose: $ false, -Verbose: $ true и случаю, когда переключатель вообще отсутствует.

31 голосов
/ 29 ноября 2010

Возможно, это звучит странно, но у командлета нет простого способа узнать его подробный режим или режим отладки.Посмотрите на соответствующий вопрос:

Как командлет узнает, когда он действительно должен вызывать WriteVerbose ()?

Один не идеальный, но практически разумный вариант - ввестиваши собственные параметры командлета (например, $MyVerbose, $MyDebug) и используйте их в коде явно. 

function DoStuff {
    [CmdletBinding()]
    param
    (
        # unfortunately, we cannot use Verbose name with CmdletBinding
        [switch]$MyVerbose
    )

    process {

        if ($MyVerbose) {
            # do verbose stuff
        }

        # pass $MyVerbose in the cmdlet explicitly
        New-Item Test -Type Directory -Verbose:$MyVerbose
    }
}

DoStuff -MyVerbose

ОБНОВЛЕНИЕ

Когда нам нужен только переключатель(не, скажем, значение уровня многословия), тогда подход с $PSBoundParameters, возможно, лучше, чем предложенные выше дополнительные параметры: 

function DoStuff {
    [CmdletBinding()]
    param()

    process {
        if ($PSBoundParameters['Verbose']) {
            # do verbose stuff
        }

        New-Item Test -Type Directory -Verbose:($PSBoundParameters['Verbose'] -eq $true)
    }
}

DoStuff -Verbose

В любом случае, все не идеально.Если есть лучшие решения, я бы очень хотел их узнать сам.

26 голосов
/ 30 декабря 2013

Нет необходимости.PowerShell уже делает это, как доказывает приведенный ниже код. 

function f { [cmdletbinding()]Param()    
    "f is called"
    Write-Debug Debug
    Write-Verbose Verbose
}
function g { [cmdletbinding()]Param() 
    "g is called"
    f 
}
g -Debug -Verbose

Вывод 

g is called
f is called
DEBUG: Debug
VERBOSE: Verbose

Это не так просто, как передача -Debug следующему командлету.Это делается с помощью переменных $ DebugPreference и $ VerbrosePreference.Write-Debug и Write-Verbose ведут себя так, как вы и ожидали, но если вы хотите сделать что-то другое с отладкой или многословно, вы можете прочитать здесь как проверить себя.

5 голосов
/ 30 апреля 2013

С риском возрождения и старых веток. Вот мое решение. 

function DoStuff {
    [CmdletBinding()]
    param ()

    BEGIN
    {
    $CMDOUT=@{
        Verbose=If ($PSBoundParameters.Verbose -eq $true) { $true } else { $false };
        Debug=If ($PSBoundParameters.Debug -eq $true) { $true } else { $false }
    }
    } # BEGIN ENDS

    PROCESS
    {
    New-Item Example -ItemType Directory @CMDOUT
    } # PROCESS ENDS

    END
    {
    } #END ENDS
}

Чем это отличается от других примеров, так это тем, что оно будет отображать "-Verbose: $ false" или "-Debug: $ false". Для -Verbose / -Debug будет установлено значение $ true, только если вы используете следующее: 

DoStuff -Verbose
DoStuff -Verbose:$true
DoStuff -Debug
DoStuff -Debug:$true
2 голосов
/ 13 мая 2014

Лучший способ сделать это - установить $VerbosePreference. Это включит подробный уровень для всего сценария. Не забудьте отключить его по окончании работы скрипта. 

Function test
{
  [CmdletBinding()]
   param( $param1)


  if($psBoundParameters['verbose'])
  {
     $VerbosePreference = "Continue"
     Write-verbose " Verbose mode is on"
   }
  else
   {
     $VerbosePreference = "SilentlyContinue"
     Write-verbose " Verbose mode is Off"
    }
   <<your code>>
   }
2 голосов
/ 29 ноября 2010

Вы можете создать новую хеш-таблицу на основе связанных параметров отладки или подробностей, а затем разделить ее с внутренней командой.Если вы просто указываете переключатели (и не передаете ложное переключение, например, $ debug: $ false), вы можете просто проверить наличие отладки или подробного: 

function DoStuff() { 
   [CmdletBinding()] 

   PROCESS { 
        $HT=@{Verbose=$PSBoundParameters.ContainsKey'Verbose');Debug=$PSBoundParameters.ContainsKey('Debug')}
      new-item Test -type Directory @HT
   } 
}

Если вы хотите передатьзначение параметра более сложное, но может быть сделано с помощью: 

function DoStuff {  
   [CmdletBinding()]  
   param()
   PROCESS {  
   $v,$d = $null
   if(!$PSBoundParameters.TryGetValue('Verbose',[ref]$v)){$v=$false}
   if(!$PSBoundParameters.TryGetValue('Debug',[ref]$d)){$d=$false}
   $HT=@{Verbose=$v;Debug=$d} 
   new-item Test -type Directory @HT 
   }  
}
1 голос
/ 27 августа 2015

Вы можете установить VerbosePreference в качестве глобальной переменной при запуске скрипта, а затем проверить глобальную переменную в своем пользовательском командлете.

Сценарий: 

$global:VerbosePreference = $VerbosePreference
Your-CmdLet

Ваши командлеты: 

if ($global:VerbosePreference -eq 'Continue') {
   # verbose code
}

Проверка явно для «Продолжить» позволяет сценарию быть равным -verbose:$false, когда вы вызываете CmdLet из сценария, который не устанавливает глобальную переменную (в этом случае это $null)

0 голосов
/ 09 сентября 2013

Я думаю, что это самый простой способ: 

Function Test {
    [CmdletBinding()]
    Param (
        [parameter(Mandatory=$False)]
        [String]$Message
    )

    Write-Host "This is INFO message"

    if ($PSBoundParameters.debug) {
        Write-Host -fore cyan "This is DEBUG message"
    }

    if ($PSBoundParameters.verbose) {
        Write-Host -fore green "This is VERBOSE message"
    }

    ""
}
Test -Verbose -Debug
...