about_Calculated_Properties

about_Calculated_Properties

PowerShell은 파이프라인으로 출력되는 객체에 새 속성을 동적으로 추가하고 출력 형식을 바꿀 수 있게 해 줘요. 이 문서에서는 그 핵심 기능인 계산된 속성(calculated property) 을 어떻게 활용하는지, 어떤 cmdlet이 지원하는지, 실제 예제까지 차근차근 살펴볼게요.

출처: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_calculated_properties (PowerShell 공식 문서, 영문 원문)

본문

간단한 설명

PowerShell은 파이프라인으로 출력되는 객체의 형식을 바꾸거나, 객체에 새 속성을 동적으로 추가하는 기능을 제공해요.

자세한 설명

여러 PowerShell cmdlet은 입력 객체를 변환·그룹화·처리하면서, 출력 객체에 새 속성을 만들 수 있는 매개변수를 사용해요. 이 매개변수로 입력 객체의 값을 바탕으로 새로 계산된 속성을 만들어 낼 수 있답니다. 계산된 속성 안에서는 $_ 또는 $PSItem 자동 변수로 입력 객체에 접근해요. (Expression 멤버 안에서 말이죠.)

계산된 속성은 hashtable로 정의해요. 새로 계산할 속성의 값을 지정하는 키-값 쌍을 담고 있죠. 일부 명령은 출력에서 속성이 어떻게 표시될지 정하는 추가 키-값 쌍도 지원해요.

지원하는 cmdlet

다음 cmdlet은 Property 매개변수에 계산된 속성 값을 지원해요. Format-* cmdlet은 GroupBy 매개변수에도 계산된 값을 지원하고요.

계산된 속성을 지원하는 cmdlet과, 각 cmdlet이 지원하는 키-값 쌍을 정리하면 이래요.

• Compare-Object

  • Expression

• ConvertTo-Html

  • Name/Label - 선택 (PowerShell 6.x에서 추가됨)
  • Expression
  • Width - 선택
  • Alignment - 선택

• Format-Custom

  • Expression
  • Depth - 선택

• Format-List

  • Name/Label - 선택
  • Expression
  • FormatString - 선택

  이렇게 동일한 키-값 쌍 세트는 모든 Format-* cmdlet의 GroupBy 매개변수에 전달되는 계산된 속성 값에도 그대로 적용돼요.

• Format-Table

  • Name/Label - 선택
  • Expression
  • FormatString - 선택
  • Width - 선택
  • Alignment - 선택

• Format-Wide

  • Expression
  • FormatString - 선택

• Group-Object

  • Expression

• Measure-Object

  • 식은 hashtable이 아니라 스크립트블록만 지원해요.
  • PowerShell 5.1 이하에서는 지원되지 않아요.

• Select-Object

  • Name/Label - 선택
  • Expression

• Sort-Object

  • Expression
  • Ascending/Descending - 선택

참고: Expression 값은 hashtable 대신 스크립트블록일 수도 있어요. 자세한 내용은 Notes 섹션을 참고하세요.

Hashtable 키 정의

• Name/Label - 만들 속성의 이름을 지정해요. Name 또는 그 별칭인 Label을 아무렇게나 써도 돼요.
• Expression - 새 속성의 값을 계산하는 데 쓰는 문자열 또는 스크립트블록이에요. Expression이 문자열이면 입력 객체의 속성 이름으로 해석돼요. 이렇게 하면 Expression = { $_.<PropertyName> }보다 더 짧게 쓸 수 있어요.
• Alignment - 표 형식 출력을 만드는 cmdlet이 값을 열에 어떻게 표시할지 정해요. 값은 'Left', 'Center', 'Right' 중 하나여야 해요.
• FormatString - 출력에서 값을 어떻게 형식화할지 정하는 형식 문자열을 지정해요. 형식 문자열에 대한 자세한 내용은 Format types in .NET을 참고하세요.
• Width - 값을 표시할 때 테이블 열의 최대 너비를 지정해요. 값은 0보다 커야 해요.
• Depth - Format-Custom의 Depth 매개변수는 모든 속성에 대한 확장 깊이를 지정해요. Depth 키는 속성별로 확장 깊이를 따로 지정할 수 있게 해 줘요.
• Ascending/Descending - 하나 이상의 속성에 대한 정렬 순서를 지정해요. 불리언 값이에요.

지정한 이름 접두어가 모호하지 않다면 hashtable 키를 끝까지 쓰지 않아도 돼요. 예를 들어 Name 대신 n, Expression 대신 e처럼 줄여 쓸 수 있어요.

예제

Compare-Object

계산된 속성으로 입력 객체의 속성을 어떻게 비교할지 제어할 수 있어요. 이 예제에서는 값을 직접 비교하는 대신, 산술 연산(2로 나눈 나머지)의 결과끼리 비교하고 있어요.

Compare-Object @{p=1} @{p=2} -Property @{ Expression = { $_.p % 2 } }

 $_.p % 2  SideIndicator
---------- -------------
         0 =>
         1 <=

ConvertTo-Html

ConvertTo-Html은 객체 컬렉션을 HTML 테이블로 변환해 줘요. 계산된 속성으로 테이블이 어떻게 보일지 제어할 수 있답니다.

Get-Alias |
  ConvertTo-Html Name,
                 Definition,
                 @{
                    Name='ParameterCount'
                    Expr={$_.Parameters.Keys.Count}
                    Align='Center'
                 } |
    Out-File .\aliases.htm -Force

이 예제는 PowerShell 별칭 목록과 각 별칭 명령의 매개변수 개수를 담은 HTML 테이블을 만들어요. ParameterCount 열의 값은 가운데 정렬돼요.

Format-Custom

Format-Custom은 객체를 클래스 정의와 비슷한 형식으로 사용자 지정해 보여 줘요. 좀 더 복잡한 객체는 복잡한 타입이 깊게 중첩된 멤버를 담고 있을 수 있어요. Format-Custom의 Depth 매개변수는 모든 속성에 대한 확장 깊이를 지정하고, Depth 키는 속성별로 확장 깊이를 따로 지정하게 해 줘요.

이 예제에서 Depth 키는 Get-Date cmdlet의 사용자 지정 출력을 단순하게 만들어 줘요. Get-Date는 DateTime 객체를 반환하는데, 이 객체의 Date 속성도 DateTime 객체라서 중첩된 형태죠.

Get-Date | Format-Custom @{Expr={$_.Date};Depth=1},TimeOfDay

class DateTime
{
  $_.Date =
    class DateTime
    {
      Date = 8/7/2020 12:00:00 AM
      Day = 7
      DayOfWeek = Friday
      DayOfYear = 220
      Hour = 0
      Kind = Local
      Millisecond = 0
      Minute = 0
      Month = 8
      Second = 0
      Ticks = 637323552000000000
      TimeOfDay = 00:00:00
      Year = 2020
      DateTime = Friday, August 07, 2020 12:00:00 AM
    }
  TimeOfDay =
    class TimeSpan
    {
      Ticks = 435031592302
      Days = 0
      Hours = 12
      Milliseconds = 159
      Minutes = 5
      Seconds = 3
      TotalDays = 0.503508787386574
      TotalHours = 12.0842108972778
      TotalMilliseconds = 43503159.2302
      TotalMinutes = 725.052653836667
      TotalSeconds = 43503.1592302
    }
}

Format-List

이 예제에서는 계산된 속성으로 Get-ChildItem 출력의 이름과 형식을 바꿔 볼게요.

Get-ChildItem *.json -File |
  Format-List FullName,
              @{
                 Name='Modified'
                 Expression={$_.LastWriteTime}
                 FormatString='O'
              },
              @{
                 Name='Size'
                 Expression={$_.Length/1KB}
                 FormatString='N2'
              }

FullName : C:\Git\PS-Docs\PowerShell-Docs\.markdownlint.json
Modified : 2020-07-23T10:26:28.4092457-07:00
Size     : 2.40

FullName : C:\Git\PS-Docs\PowerShell-Docs\.openpublishing.publish.config.json
Modified : 2020-07-23T10:26:28.4092457-07:00
Size     : 2.25

FullName : C:\Git\PS-Docs\PowerShell-Docs\.openpublishing.redirection.json
Modified : 2020-07-27T13:05:24.3887629-07:00
Size     : 324.60

Format-Table

이 예제에서 계산된 속성은 파일을 콘텐츠 타입별로 분류하는 Type 속성을 추가해 줘요.

Get-ChildItem -File |
  Sort-Object Extension |
    Format-Table Name, Length -GroupBy @{
      Name='Type'
      Expression={
        switch ($_.Extension) {
          '.md'   {'Content'}
          ''      {'Metacontent'}
          '.ps1'  {'Automation'}
          '.yml'  {'Automation'}
          default {'Configuration'}
        }
      }
    }

   Type: Metacontent

Name              Length
----              ------
ThirdPartyNotices   1229
LICENSE-CODE        1106
LICENSE            19047

   Type: Configuration

Name                                Length
----                                ------
.editorconfig                          183
.gitattributes                         419
.gitignore                             228
.markdownlint.json                    2456
.openpublishing.publish.config.json   2306
.openpublishing.redirection.json    332394
.localization-config                   232

   Type: Content

Name            Length
----            ------
README.md         3355
CONTRIBUTING.md    247

   Type: Automation

Name                      Length
----                      ------
.openpublishing.build.ps1    796
build.ps1                   7495
ci.yml                       645
ci-steps.yml                2035
daily.yml                   1271

Format-Wide

Format-Wide cmdlet은 컬렉션에 있는 객체의 속성 하나를 여러 열로 나눠 표시해 줘요.

이 예제에서는 파일 이름과 크기(킬로바이트)를 한 화면에 넓게 보고 싶어요. Format-Wide는 속성을 하나만 표시할 수 있으니까, 계산된 속성으로 두 속성의 값을 하나로 합쳐 줘요.

Get-ChildItem -File |
  Format-Wide -Property @{e={'{0} ({1:N2}kb)' -f $_.Name,($_.Length/1kb)}}

.editorconfig (0.18kb)                          .gitattributes (0.41kb)
.gitignore (0.22kb)                             .localization-config (0.23kb)
.markdownlint.json (2.40kb)                     .openpublishing.build.ps1 (0.78kb)
.openpublishing.publish.config.json (2.25kb)    .openpublishing.redirection.json (324.60kb)
build.ps1 (7.32kb)                              ci.yml (0.63kb)
ci-steps.yml (1.99kb)                           CONTRIBUTING.md (0.24kb)
daily.yml (1.24kb)                              LICENSE (18.60kb)
LICENSE-CODE (1.08kb)                           README.md (3.28kb)
ThirdPartyNotices (1.20kb)

Group-Object

Group-Object cmdlet은 지정한 속성의 값에 따라 객체를 그룹으로 묶어 보여 줘요. 이 예제에서는 계산된 속성으로 콘텐츠 타입별 파일 개수를 세어 봐요.

Get-ChildItem -File |
  Sort-Object Extension |
    Group-Object -NoElement -Property @{
      Expression={
        switch ($_.Extension) {
          '.md'   {'Content'}
          ''      {'Metacontent'}
          '.ps1'  {'Automation'}
          '.yml'  {'Automation'}
          default {'Configuration'}
        }
      }
    }

Count Name
----- ----
    5 Automation
    7 Configuration
    2 Content
    3 Metacontent

Measure-Object

Measure-Object cmdlet은 객체의 숫자 속성을 계산해요. 이 예제에서는 계산된 속성으로 1부터 10 사이에서 3으로 나누어떨어지는 숫자의 개수를 구해 봐요.

스크립트블록은 숫자가 3으로 나누어떨어지면 $true, 나머지는 $false를 반환해요. Sum 연산은 $true 값을 1, $false 값을 0으로 취급해요.

1..10 | Measure-Object -Property {($_ % 3) -eq 0} -Sum

Count             : 10
Average           :
Sum               : 3
Maximum           :
Minimum           :
StandardDeviation :
Property          : ($_ % 3) -eq 0

참고: 다른 cmdlet과 달리 Measure-Object는 계산된 속성에 hashtable을 받지 않아요. 반드시 스크립트블록을 써야 해요.

Select-Object

Select-Object cmdlet으로 출력되는 객체에 추가 멤버를 만들 때도 계산된 속성을 쓸 수 있어요. 이 예제에서는 C로 시작하는 PowerShell 별칭을 나열해요. Select-Object로 별칭, 매핑된 cmdlet, 그리고 cmdlet에 정의된 매개변수 개수를 출력해요. 계산된 속성으로 ParameterCount 속성을 만들어 냈어요.

$aliases = Get-Alias c* |
  Select-Object Name,
                Definition,
                @{
                    Name='ParameterCount'
                    Expr={$_.Parameters.Keys.Count}
                }
$aliases | Get-Member
$aliases

   TypeName: Selected.System.Management.Automation.AliasInfo

Name           MemberType   Definition
----           ----------   ----------
Equals         Method       bool Equals(System.Object obj)
GetHashCode    Method       int GetHashCode()
GetType        Method       type GetType()
ToString       Method       string ToString()
Definition     NoteProperty string Definition=Get-Content
Name           NoteProperty string Name=cat
ParameterCount NoteProperty System.Int32 ParameterCount=21

Name    Definition         ParameterCount
----    ----------         --------------
cat     Get-Content                    21
cd      Set-Location                   15
cdd     Push-MyLocation                 1
chdir   Set-Location                   15
clc     Clear-Content                  20
clear   Clear-Host                      0
clhy    Clear-History                  17
cli     Clear-Item                     20
clp     Clear-ItemProperty             22
cls     Clear-Host                      0
clv     Clear-Variable                 19
cnsn    Connect-PSSession              29
compare Compare-Object                 20
copy    Copy-Item                      24
cp      Copy-Item                      24
cpi     Copy-Item                      24
cpp     Copy-ItemProperty              23
cvpa    Convert-Path                   13

Sort-Object

계산된 속성으로 속성마다 서로 다른 정렬 순서를 적용할 수 있어요. 이 예제는 CSV 파일의 데이터를 Date 기준 오름차순으로 정렬하되, 같은 날짜 안에서는 UnitsSold 기준 내림차순으로 정렬해요.

Import-Csv C:\temp\sales-data.csv |
  Sort-Object Date, @{Expr={$_.UnitsSold}; Desc=$true}, Salesperson  |
    Select-Object Date, Salesperson, UnitsSold

Date       Salesperson UnitsSold
----       ----------- ---------
2020-08-01 Sally       3
2020-08-01 Anne        2
2020-08-01 Fred        1
2020-08-02 Anne        6
2020-08-02 Fred        2
2020-08-02 Sally       0
2020-08-03 Anne        5
2020-08-03 Sally       3
2020-08-03 Fred        1
2020-08-04 Anne        2
2020-08-04 Fred        2
2020-08-04 Sally       2

참고 사항 (Notes)

• 식 스크립트블록을 매개변수 인수로 직접 지정할 수도 있어요. hashtable의 Expression 항목으로 쓰는 대신 말이죠. 예를 들면:

  '1', '10', '2' | Sort-Object { [int] $_ }
  

  이런 방식은 Name 키로 속성 이름을 붙이지 않아도 되거나 지원하지 않는 cmdlet(Sort-Object, Group-Object, Measure-Object)에 특히 편리해요. 속성 이름 지정을 지원하는 cmdlet에서는 스크립트블록이 문자열로 변환되어 출력에서 속성 이름으로 쓰여요.

• Expression 스크립트블록은 자식 스코프에서 실행되기 때문에, 호출한 쪽의 변수를 직접 수정할 수 없어요.

• Expression 스크립트블록의 출력에는 파이프라인 로직이 적용돼요. 그래서 단일 요소 배열을 출력하면 그 배열이 풀려버릴 수 있어요.

• 대부분의 cmdlet에서는 식 스크립트블록 안에서 발생한 오류가 조용히 무시돼요. Sort-Object의 경우 문 종료 오류와 스크립트 종료 오류는 출력되지만 문을 종료하지는 않아요.

더 알아보기

• about_Hash_Tables
• ConvertTo-Html
• Format-Custom
• Format-List
• Format-Table
• Format-Wide
• Compare-Object
• Group-Object
• Measure-Object
• Select-Object
• Sort-Object
• Format types in .NET