TIL10. Python : NamedTuple 이란?

📌 이 포스팅에서는 Python의 NamedTuple을 사용하는 이유와 사용 방법에 대해 알아보겠습니다.

🌈 NamedTuple

🔥 namedtuple을 왜 쓸까요?

🔥 namedtuple 어떻게 사용할까?

🔥 namedtuple의 매서드 정리

🔥 namedtuple 활용 예시

1. namedTuple을 왜 사용하는가?

🤔 namedTuple 이란?

✔️ 네임드튜플은 객체의 인스턴스를 생성하 듯이 튜플을 생성하여 각 원소에 이름으로 접근이 가능한 튜플을 의미합니다.
✔️ 즉, 데이터의 값을 수정할 필요가 없다면 튜플의 값에 이름으로 접근할 수 있기 때문에 일반 튜플이 인덱스로 접근하는 것에 비해 직관적입니다.
✔️ 또한 네임드튜플은 일반 객체 형태보다 적은 메모리를 사용하고, 다양한 접근법을 지원합니다.
✔️ 메모리 효율성 일반적인 상황에서 리스트보다 튜플이 좋고, 튜플보다 네임드튜플이 좋습니다.

🤔 두 점 사이의 거리 구하기 문제

✔️ 두 점 사이의 거리를 구하는 공식을 예로 들어, 일반튜플과 네임드튜플의 차이를 알아보겠습니다. 두 점 사이의 거리는 아래 공식을 사용하여 구할 수 있습니다.

✔️ 일반 튜플은 인덱스 번호로 값에 접근할 수 있기 때문에 값을 직관적으로 이해하기 어려워 값을 외우고 있어야하거나, 주석이 필요합니다.

from math import sqrt
point1 = (1.0, 5.0) # x1=1.0, y1=5.0
point2 = (2.5, 1.5) # x2=2.5, y2=1.5
line_len = sqrt((point2[0]-point1[0]) ** 2 + (point2[1]-point1[1]) ** 2)
print(line_len) # 3.8078865529319543

✔️ 이에 반해, namedtuple을 사용하면 각 변수가 가르키는 값을 보다 직관적으로 접근하고 활용할 수 있습니다.
✔️ namedtuple은 이름에서 알 수 있듯이 네임드튜플은 이름을 가진 tuple을 의미하기 때문에 tuple의 각 요소에 레이블을 줄 수 있습니다.
✔️ 네임드튜플은 다양한 데이터 타입을 지원하는 collections 내에 존재하고, 객체처럼 생성하여 사용할 수 있습니다.

from math import sqrt
from collections import namedtuple # 👈 "namedtuple" import
Point = namedtuple('Point', 'x y') # 👈 namedtuple 선언
point1 = Point(1.0, 5.0)
point2 = Point(2.5, 1.5)
line_len = sqrt((point2.x-point1.x) ** 2 + (point2.y-point1.y) ** 2)
print(line_len) # 3.8078865529319543

2. namedtuple 어떻게 사용할까?

🤔 nametuple 선언 방법

✔️ 리스트 형태로 변수 선언 : 🔍 Point1 = namedtuple('Point', ['x', 'y'])
✔️ 콤마 삽입으로 선언 : 🔍 Point2 = namedtuple('Point', 'x, y')
✔️ 띄어쓰기 삽입으로 선언 : 🔍 Point3 = namedtuple('Point', 'x y')
✔️ rename 옵션 사용 : 🔍 Point4 = namedtuple('Point', 'x y x class', rename=True)

# 네임드 튜플 선언 방법
Point1 = namedtuple('Point',['x', 'y'])
Point2 = namedtuple('Point', 'x, y')
Point3 = namedtuple('Point', 'x y')
Point4 = namedtuple('Point', 'x y x class', rename=True) # default는 False임
print(Point1, Point2, Point3, Point4) # <class '__main__.Point'> <class '__main__.Point'> <class '__main__.Point'> <class '__main__.Point'>

🤔 rename 옵션이란?

✔️ namedTuple 또한 tuple처럼 불변의 특성을 지니고 있기 때문에 중복될 수 없고, 당연히 "class"와 같은 예약어 들은 인스턴스 변수처럼 지정할 수 없습니다.
✔️ 따라서 아래와 같은 code는 x값이 중복되어 있고, class라는 예약어가 선언 시 사용되었기 때문에 에러를 발생시킵니다.

• 🔎 Point4 = namedtuple('Point', 'x y x class') 👈 x중복, class 예약어

✔️ 이럴 경우, rename 옵션을 True로 활성화하면 중복되는 값 또는 예약어 등의 잘못된 변수로 선언 시 사용해도 오류를 반환하지 않고, 랜덤한 변수에 데이터를 할당해줍니다.
✔️ 뿐만아니라 더블아스타(**)를 사용해 딕셔너리의 형태도 언팩킹 해줍니다.

# 네임드 튜플 선언 방법
Point1 = namedtuple('Point',['x', 'y'])
Point2 = namedtuple('Point', 'x, y')
Point3 = namedtuple('Point', 'x y')
Point4 = namedtuple('Point', 'x y x class', rename=True) # 👈 default는 False입니다.
p1 = Point1(x=10, y=35)
print(p1) # Point(x=10, y=35)
p2 = Point2(20, 40)
print(p2) # Point(x=20, y=40)
p3 = Point3(45, y=20)
print(p3) # Point(x=45, y=20)
p4 = Point4(10, 20, 30, 40)
print(p4) # Point(x=10, y=20, _2=30, _3=40) 👈 자동으로 rename해줍니다:)
# 딕셔너리 언팩킹
temp_dict = {'x':75, 'y':55} 
p5 = Point1(**temp_dict) # 👈 딕셔너리 언팩킹
print(p5) # Point(x=75, y=55)
# unpacking 활용
x, y = p3
print(x+y) # 65

3. namedtuple의 매서드 정리

🤔 _make() : 새로운 객체 생성

Point1 = namedtuple('Point', ['x', 'y'])
temp = [52, 38]
p4 = Point1._make(temp)
print(p4) # Point(x=52, y=38)

🤔 _fields() : 필드 네임 확인

Point1 = namedtuple('Point', ['x', 'y'])
Point2 = namedtuple('Point', 'x, y')
Point3 = namedtuple('Point', 'x y')
print(p1._fields, p2._fields, p3._fields,) # ('x', 'y') ('x', 'y') ('x', 'y')

🤔 _asdict() : 딕셔너리로 변환

Point1 = namedtuple('Point', ['x', 'y'])
p1 = Point1(x=10, y=35)
temp = [52, 38]
p4 = Point1._make(temp)
print(p1._asdict(), p4._asdict()) # {'x': 10, 'y': 35} {'x': 52, 'y': 38}
print(type(p1._asdict()), type(p4._asdict())) # <class 'dict'> <class 'dict'>

🤔 _replace() : 네임드튜플 또한 불변이기 때문에, 값을 수정하지 못합니다. 이에 수정된 "새로운" 객체 반환합니다.

Point2 = namedtuple('Point', 'x, y')
p2 = Point2(20, 40)
print(p2) # Point(x=20, y=40)
print(p2._replace(y=100)) # Point(x=20, y=100)

4. namedtuple 활용 예시

🤔 학급 구성은 만들어 봅시다!

✔️ 4개의 반(A,B,C,D)에 각 20명의 학생이 있을 때 학생 전체 그룹 생성
✔️ 1번부터 20번까지 학생 생성 : 🔍 numbers = [str(n) for n in range(1,21)]
✔️ 4개의 반 생성 : 🔍 ranks = 'A B C D'.split()

# 4개의 반에 A,B,C,D의 각 20명의 학생이 있을 때 학생 전체 그룹 생성
from collections import namedtuple
numbers = [str(n) for n in range(1,21)] # ['1', '2', '3', '4', ...... '17', '18', '19', '20']
ranks = 'A B C D'.split() # ['A', 'B', 'C', 'D']
Classes = namedtuple('Classes', ['rank', 'number']) # 객체명(classes)과 변수명(classes)을 일치시키는게 관례임
students = [Classes(rank, number) for rank in ranks for number in numbers]
print(len(students)) # 80
print(students)
"""
[Classes(rank='A', number='1'), Classes(rank='A', number='2'), Classes(rank='A', number='3'), Classes(rank='A', number='4'), 
Classes(rank='A', number='5'), Classes(rank='A', number='6'), Classes(rank='A', number='7'), Classes(rank='A', number='8'), 
Classes(rank='A', number='9'), Classes(rank='A', number='10'), Classes(rank='A', number='11'), Classes(rank='A', number='12'), 
Classes(rank='A', number='13'), Classes(rank='A', number='14'), Classes(rank='A', number='15'), Classes(rank='A', number='16'), 
Classes(rank='A', number='17'), Classes(rank='A', number='18'), Classes(rank='A', number='19'), Classes(rank='A', number='20'), 
Classes(rank='B', number='1'), Classes(rank='B', number='2'), Classes(rank='B', number='3'), Classes(rank='B', number='4'), 
Classes(rank='B', number='5'), Classes(rank='B', number='6'), Classes(rank='B', number='7'), Classes(rank='B', number='8'), 
Classes(rank='B', number='9'), Classes(rank='B', number='10'), Classes(rank='B', number='11'), Classes(rank='B', number='12'), 
Classes(rank='B', number='13'), Classes(rank='B', number='14'), Classes(rank='B', number='15'), Classes(rank='B', number='16'), 
Classes(rank='B', number='17'), Classes(rank='B', number='18'), Classes(rank='B', number='19'), Classes(rank='B', number='20'), 
Classes(rank='C', number='1'), Classes(rank='C', number='2'), Classes(rank='C', number='3'), Classes(rank='C', number='4'), 
Classes(rank='C', number='5'), Classes(rank='C', number='6'), Classes(rank='C', number='7'), Classes(rank='C', number='8'), 
Classes(rank='C', number='9'), Classes(rank='C', number='10'), Classes(rank='C', number='11'), Classes(rank='C', number='12'), 
Classes(rank='C', number='13'), Classes(rank='C', number='14'), Classes(rank='C', number='15'), Classes(rank='C', number='16'), 
Classes(rank='C', number='17'), Classes(rank='C', number='18'), Classes(rank='C', number='19'), Classes(rank='C', number='20'), 
Classes(rank='D', number='1'), Classes(rank='D', number='2'), Classes(rank='D', number='3'), Classes(rank='D', number='4'), 
Classes(rank='D', number='5'), Classes(rank='D', number='6'), Classes(rank='D', number='7'), Classes(rank='D', number='8'), 
Classes(rank='D', number='9'), Classes(rank='D', number='10'), Classes(rank='D', number='11'), Classes(rank='D', number='12'), 
Classes(rank='D', number='13'), Classes(rank='D', number='14'), Classes(rank='D', number='15'), Classes(rank='D', number='16'), 
Classes(rank='D', number='17'), Classes(rank='D', number='18'), Classes(rank='D', number='19'), Classes(rank='D', number='20')]
"""