이펙티브 파이썬 3장 - 함수

Better way 19 함수가 여러 값을 반환하는 경우 절대로 네 값 이상을 언패킹하지 말라

함수가 여러 값을 반환하는 경우, 언패킹 과정에서 오류가 일어나기 쉽다.

# 안좋은 예시 - 언패킹하는 인자에서 순서가 바뀌었을 때, 오류를 인지하기 어렵다
def get_stats(numbers):
	minimum = min(numbers)
    maximum = max(numbers)
    count = len(numbers)
    average = sum(numbers) / count
    return minimum, maximum, count, average

# 정상적으로 호출
minimum, maximum, count, average = get_stats([1,2,3,4]) 

# average, count 순서를 잘못 호출 - 오류를 인지하기 어려움
minimum, maximum, average, count = get_stats([1,2,3,4])

 

해결 방법 1. namedtuple 사용

# 좋은 예시 1 - namedtuple
from collections import namedtuple
# namedtuple 정의
Stats = namedtuple('Stats', ['minimum', 'maximum', 'count', 'average'])

def get_stats(numbers):
    minimum = min(numbers)
    maximum = max(numbers)
    count = len(numbers)
    average = sum(numbers) / count
    return Stats(minimum, maximum, count, average)
    
# 호출 시, 이름으로 값을 접근하여 순서를 신경 쓸 필요 없음
stats = get_stats([1, 2, 3, 4])
print(stats.minimum)  # 1
print(stats.maximum)  # 4
print(stats.count)    # 4
print(stats.average)  # 2.5

 

해결 방법 2. dataclass 사용

# 좋은 예시 2 - dataclass 사용
from dataclasses import dataclass

# dataclass 정의
@dataclass
class Stats:
    minimum: int
    maximum: int
    count: int
    average: float

def get_stats(numbers):
    minimum = min(numbers)
    maximum = max(numbers)
    count = len(numbers)
    average = sum(numbers) / count
    return Stats(minimum, maximum, count, average)

# 호출 시, 객체의 속성으로 접근
stats = get_stats([1, 2, 3, 4])
print(stats.minimum)  # 1
print(stats.maximum)  # 4
print(stats.count)    # 4
print(stats.average)  # 2.5

 

namedtuple과 dataclass의 차이

특성	namedtuple	dataclass
변경 가능 여부	불변(immutable) 객체	기본적으로 가변(mutable) 객체, frozen=True로 불변 설정 가능
메서드 추가	메서드 추가 불가	메서드 추가 가능
상속 지원	상속 불가	상속 가능
기본 생성자	자동 생성됨	자동 생성됨
비교 연산자	자동 생성됨 (__eq__ 등)	자동 생성됨 (__eq__ 등)
__repr__	자동 생성됨	자동 생성됨
기타 특징	튜플과 호환되며 메모리 효율적	객체 지향적이며 확장성 있음

Better way 20 None을 반환하기보다는 예외를 발생시켜라

# 안 좋은 예시 - 오류 상황에서 None를 반환
def safe_divide(a, b):
    if b == 0:
        return None  # 0으로 나누는 경우 None 반환
    return a / b

result = safe_divide(10, 0)
if result is None:
    print("Error: Division by zero")
else:
    print("Result:", result)

• 예외 상황에서 None를 반환하면 호출하는 쪽에서 None을 검증하는 것이 부자연스럽다.
• 또한 여러 예외를 None 하나로 표현하여 반환하면 예외를 특정하기 어렵다.

# 좋은 예시 - 오류 상황에서 예외 발생
def safe_divide(a, b):
    if b == 0:
        raise ZeroDivisionError("Cannot divide by zero")
    return a / b

try:
    result = safe_divide(10, 0)
    print("Result:", result)
except ZeroDivisionError as e:
    print("Error:", e)

Better way 21 변수 영역과 클로저의 상호작용 방식을 이해하라

파이썬 인터프리터가 변수를 찾는 순서

• 현재 함수의 영역
• 현재 함수를 둘러싼 영역
• 현재 코드가 들어 있는 모듈의 영역 - 전역 영역(global)
• 내장 영역 (built-in-scope) - len, str 등의 함수가 들어 있는 영역

def sort_priority(values, group):
    def helper(x):
        if x in group:
            return (0,x)
        return (1,x)
    values.sort(key=helper)

helper 함수에서 group이 선언되어 있지 않지만 에러가 발생하지 않는다

왜냐하면 "현재 함수를 둘러싼 영역" 에서 group 변수를 찾을 수 있기 때문 -> 파이썬이 클로저를 지원하기 때문

 

def sort_priority2(numbers, group):
    found = False
    def helper(x):
        if x in group:
            found = True
            return (0, x)
        return (1,x)
    numbers.sort(key=helper)
    return found

위의 함수는 정상적으로 동작하지 않는다. (개발자 의도대로 동작 x)

영역 지정 버그(scoping bug)가 발생하기 때문이다. 

 

helper 함수의 "found = True" 구문은 sort_priority2에서 선언되어 있는 found 변수에 True을 할당하는 것이 아닌 helper 함수 내에서 found 라는 변수를 새로 만들고 True를 할당하기 때문이다.

 

def sort_priority3(numbers, group):
    found = False
    def helper(x):
        if x in group:
            nonlocal found = True
            return (0, x)
        return (1,x)
    numbers.sort(key=helper)
    return found

nonlocal 키워드를 사용하면 sort_priority3 의 found에 값이 정상적으로 할당할 순 있지만, nonlocal 키워드는 사용하지 말자 함수의 동작을 이해하는 데, 어려워진다.

 

구분	global	nonlocal
사용 목적	전역 변수를 함수 내부에서 수정할 때 사용	중첩 함수 내부에서 바깥 함수의 변수를 수정할 때 사용
적용 대상	전역 변수	현재 함수의 바깥 함수(non-global)의 지역 변수
선언 위치	함수 내부	중첩 함수 내부
변수 생성 여부	기존 전역 변수를 사용 (없으면 오류 발생)	기존 변수를 사용 (없으면 오류 발생)

Better way 22 변수 위치 인자를 사용해 시각적인 잡음을 줄여라

예를 들면 로그를 남기는 함수라고 하자

# 안 좋은 예시
def log(message, values):
	if not values:
    	print(message)
    else:
        values_str = ', '.join(str(x) for x in values)
        print(f'{message}: {values_str}')

log('내 숫자는', [1,2]) 
log('안녕', []) # values가 없는 경우에도 빈 리스트를 넣어줘야함

>>>
내 숫자는: 1, 2
안녕

# 좋은 예시 - * 키워드 사용
def log(message, *values): # 유일하게 달라진 부분
	if not values:
    	print(message)
    else:
        values_str = ', '.join(str(x) for x in values)
        print(f'{message}: {values_str}')

log('내 숫자는', 1, 2) 
log('안녕') # values가 없는 경우에는 생략 가능

>>>
내 숫자는: 1, 2
안녕

 

Better Way 25: 위치 전용 인자 또는 키워드 전용 인자를 사용해 함수 호출을 명확하게 만들라

함수 호출이 복잡하고 특정 인자를 키워드 전용 인자로 바꾸어 함수 호출을 명확하게 할 수 있다.

# 안 좋은 예시 
def move(x, y, speed):
    print(f"Moving to ({x}, {y}) at speed {speed}")

move(10, 20, 5)  # 속도가 위치인지 헷갈릴 수 있음


# 좋은 예시 - * 를 통해 키워드 전용 인자 설정이 가능
def move(x, y, *, speed):
    print(f"Moving to ({x}, {y}) at speed {speed}")

move(10, 20, 5)
>>>
TypeError: move() takes 2 positional arguments but 3 were given


move(10, 20, speed=5) # speed 키워드 인자 사용
>>>
Moving to (10, 20) at speed 5

Better way 26 functools.wrap을 사용해 함수 데코레이터를 정의하라

파이썬에서는 데코레이터를 정의할 수 있는 데, 이 때 functools.wrap을 사용하자

 

# 안 좋은 예시 - 메타 데이터가 사라짐 (디버거와 같이 인트로스펙션 하는 도구에서 문제가 발생)
def my_decorator(func):
    def wrapper(*args, **kwargs):
        print("Before function call")
        return func(*args, **kwargs)
    return wrapper

@my_decorator
def say_hello():
    """Returns a greeting."""
    print("Hello!")

print(say_hello.__name__)  # wrapper
print(say_hello.__doc__)   # None (문서 문자열이 사라짐)

 

# 좋은 예시
from functools import wraps

def my_decorator(func):
    @wraps(func)  # 원본 함수의 메타데이터 유지
    def wrapper(*args, **kwargs):
        print("Before function call")
        return func(*args, **kwargs)
    return wrapper

@my_decorator
def say_hello():
    """Returns a greeting."""
    print("Hello!")

print(say_hello.__name__)  # say_hello
print(say_hello.__doc__)   # "Returns a greeting."

 

 

 

Effective Python 2nd 이펙티브 파이썬 : 파이썬 코딩의 기술 : 네이버 도서