파이썬 계약에 의한 디자인(Design by Contract, DbC)

계약에 의한 디자인(Design by Contract, DbC)이란?

계약에 의한 디자인은 소프트웨어 개발에서 소프트웨어 컴포넌트 간의 상호 작용을 정의하고 문서화하는 방법론 중 하나

소프트웨어 개발 과정에서 컴포넌트의 명세를 명확하게 정의함으로써 소프트웨어의 신뢰성과 유지 보수성을 향상시킴

구성요소

• 사전조건 (precondition)
  • 함수가 실행되기 전에 참이어야 하는 조건
  • 일반적으로 파라미터의 유효성을 검사
• 사후조건 (postcondition)
  
  • 함수가 실행된 후에 참이어야 하는 조건
  • 일반적으로 함수의 반환값을 검사
• 클래스 불변식 (invairant)
  • 클래스의 인스턴스가 항상 유효한 상태를 유지해야 하는 조건
  • 모든 메서드 호출 후에도 이 조건이 유지되어야 함
  • 함수의 docstring에 불변식에 대해 문서화하는 것이 좋음
• 부작용 (side effect)
  • 함수가 호출된 후에 함수 외부에 미치는 영향
  • 선택적으로 docstring에 언급함

파이썬에서 DbC을 구현하는 방법

• 제어 메커니즘 추가
  • 함수, 메서드, 클래스에 사전 조건과 사후 조건을 검사하는 제어 메커니즘을 추가
  • 입력 값의 유효성을 검증하고, 함수 또는 메서드의 실행 결과를 확인할 수 있음
• 예외 발생
  • 검사에 실패할 경우 RuntimeError, ValueError, 또는 사용자 정의 예외를 발생시켜 에러를 처리
• assert문 사용
  • 함수나 메서드의 입력 값 검증에 assert문을 사용하여 사전 조건을 명시적으로 검사
• 문서화
  • 함수와 메서드에는 docstrings을 활용하여 각각의 계약을 명확히 문서화
• 타입 힌트 사용
  • typing 모듈을 활용하여 함수나 메서드의 인자와 반환 값의 타입을 명시하여 계약을 더욱 명확하게 정의
• 코드 격리
  • 사전조건과 사후조건의 검사, 핵심 기능의 구현을 가능한 한 격리된 상태로 유지
  • 작은 함수를 생성하거나, 데코레이터를 활용하여 구현

파이썬 DbC 구현 예시

파이썬에서는 계약에 의한 디자인을 구현하기 위하여 contract 모듈을 사용할 수 있음

from contract import contract

class Calculator:
    @contract(x='int', y='int', returns='int')
    def add(self, x, y):
        """Add two integers."""
        return x + y

# Calculator 객체 생성
calc = Calculator()

# 덧셈 기능 테스트
result = calc.add(3, 5)
print("결과:", result)  # 출력: 결과: 8

# 타입이 다른 인자를 전달하는 경우
result = calc.add(3.5, 5)  # ContractNotRespected 예외 발생

위 코드에서는 contract 데코레이터를 사용하여 add 메서드의 계약을 정의함

이 계약은 x와 y가 모두 정수인 경우에만 유효하며, 반환 값 또한 정수여야 함

만약 이 계약을 위반하면 ContractNotRespected 예외가 발생

이와 같이 DbC를 활용하면 개발자는 코드의 의도를 명확히 정의할 수 있고, 이로 인해 코드의 가독성과 유지 보수성이 향상됨