[OOP] (4) 추상화(Abstraction) : docstring, type hinting, 정적 동적 타입 언어

Hello👋 I'm Dona!:)

객체 지향프로그래밍 영어로는 OOP(Object-Oriented-Programming) 정리하기 4탄! 🏡

---

🔍 들어가며 : 프로그래밍에서 추상화란?

• 변수, 함수, 클래스를 사용해 사용자가 꼭 알아야만 하는 부분만을 겉으로 드러내는 것
• 프로그래머들이 특정 코드를 사용할 때, 필수적인 정보를 제외한 세부사항을 가리는 것
• 변수 추상화, 함수 추상화, 클래스 추상화 등이 있다.

추상화란, " 복잡한 내용은 숨기고, 주요 기능에만 신경쓰는 것 "

---

1.  추상화 잘하기 : 이름 잘 짓기

• 클래스, 변수, 메소드의 이름을 어디에 쓸 수 있고, 어떻게 사용하는지 직관적으로 유추되는 이름을 사용하자
• 변수 이름에 대한 규칙이 궁금하다면 PEP8을 참고하자 - python PEP8(코딩 스타일 가이드) 
• 필자가 코세라에서 파이썬 강의에서 배운 변수 이름을 니모닉(mnemonic)하게 짓는 것도 여기에 해당된다.
• 🥕니모닉 변수 이름(mnemonic varaiable name) : 보는 사람을 위해 적절히 선택된 변수 이름, 기억하기 쉬운 
• 웹에서 간편하게 변수의 주소를 확인하며 코딩을 할 수 있는 사이트를 소개한다

간단한 알고리즘 문제 풀이에 활용하기에 좋다

클래스, 변수, 메소드 추상화를 코드 예시로 느껴보자

# 추상화의 안 좋은 예시 : 어디에 쓰는 클래스, 함수, 변수인지 이해하기 힘들다
class SomeClass:
    class_variable = 0.02
    
    def __init__(self, variable_1, variable_2):
        self.variable_1 = variable_1
        self.variable_2 = variable_2
        
    def method_1(self, some_value):
        self.variable_2 += some_value

 

# 추상화의 좋은 예시 : 어디에 쓰는 클래스, 함수, 변수이고 어떻게 사용할지 직관적으로 알 수 있다
class BankAccount:
	'''은행 계좌 클래스'''
    interest = 0.02 # 이자
    
    def __init__(self, owner_name, balance):
        self.owner_name = owner_name # 이름
        self.balance = balance # 잔액
        
    def deposit(self, amount):
        # 예금
        self.balance += amount

---

2.  문서화(docstring = documentation string)

• 추상화를 더 잘하는 방법으로는 'docstring'이 있다
• 클래스를 만들 때, """이렇게""", 또는 '''이렇게''' 따옴표 세개를 사용하면 된다
• 이렇게 작성한 docstring 내용은 __doc__ 속성에 저장되며, help(class이름)로 확인이 가능하다
• 문서화에서 가장 중요한 것은 프로그램을 함께 만드는 팀원들과 문서화 포맷(style)에 관해 미리 약속을 하고 이를 잘 지키는 것! 🤙
• 혼자서 만드는 프로그램이라도 자신만의 포맷(style)을 일관성있게 사용한다면 나중에 프로그램을 수정할 때 좋다👍

# docstring 사용 예시
class BankAccount:
    '''은행 계좌 클래스'''
    interest = 0.02
    
    def __init__(self, owner_name, balance):
        '''인스턴스 변수 : name(문자열), balance(실수형)'''
        self.owner_name = owner_name
        self.balance = balance
        
    def deposit(self, amount):
        '''잔액 인스턴스 변수 balance를 파라미터 amount만큼 늘려주는 메소드'''
        self.balance += amount
        
    def withdraw(self, amount):
        '''잔액 인스턴스 변수 balance를 파라미터 amount만큼 줄여주는 메소드'''
        if self.balance < amount:
            print("Insufficient balance!")
        else:
            self.balance -= amount

# docstring 확인하기
help(BankAccount)

  

help(class이름)을 통해 docstirng 확인한 결과

---

📎 docstring style

docstring의 형식에 꼭 지켜야할 규칙은 없지만, 흔히 사용하는 포맷은 있다.

대표적인 문서화(docstring)의 3가지 포맷(style)을 코드 예시와 함께 알아보자.

   

1. Google docstring

   # example : 유저를 위한 추천 영상을 찾는 메소드의 docstring을 작성해보자
   
   def find_suggestion_videos(self, number_of_suggestions=5):
       """유저에게 추천할 영상을 찾아준다
       Parameters:
         number_of_suggestions (int): 추천하고 싶은 영상 수
           (기본값은 5)
           
       Returns:
         list: 추천할 영상 주소가 담긴 리스트
       """

    
2. reStructuredText (파이썬 공식 문서화 기준)

   # example : 유저를 위한 추천 영상을 찾는 메소드의 docstring을 작성해보자
   
   def find_suggestion_videos(self, number_of_suggestions=5):
       """유저에게 추천할 영상을 찾아준다
       
       :param number_of_suggestions: 추천하고 싶은 영상 수
         (기본값은 5)
       :type number_of_suggestions: int
       :returns: 추천할 영상 주소가 담긴 리스트
       :rtype: list
       """

    
3. NumPy/SciPy (통계, 과학 분야에서 쓰이는 Python 라이브러리)

   # example : 유저를 위한 추천 영상을 찾는 메소드의 docstring을 작성해보자
   
   def find_suggestion_videos(self, number_of_suggestions=5):
       """유저에게 추천할 영상을 찾아준다
       
       Parameters
       ----------
       number_of_suggestions: int
         추천하고 싶은 영상 수 (기본값은 5)
       
       Returns
       -------
       list 
         추천할 영상 주소가 담긴 리스트
       """

---

📎 type hinting with python

• 파이썬을 정적 타입 언어처럼 타입을 표시할 수 있는 기능
• 파이썬은 동적 타입 언어(그때 그때 함수의 타입이 변한다)
• type hingting을 지키지않아도 error는 안나지만, 엉뚱한 결과가 나올 수 있음

# example
# 변수에 넣어야할 타입을 hinting
x : float = 0.02
y : int = 3

# 함수 : 함수의 리턴값의 타입을 hinting
def func -> float :

# 클래스
class BankAccount:
    '''은행 계좌 클래스'''
    interest: float = 0.02
    
    def __init__(self, owner_name: str, balance: float) -> None:
        '''인스턴스 변수 : name(문자열), balance(실수형)'''
        self.owner_name = owner_name
        self.balance = balance
        
    def deposit(self, amount: float) -> None:
        '''잔액 인스턴스 변수 balance를 파라미터 amount만큼 늘려주는 메소드'''
        self.balance += amount
        
    def withdraw(self, amount: float) -> None:
        '''잔액 인스턴스 변수 balance를 파라미터 amount만큼 줄여주는 메소드'''
        if self.balance < amount:
            print("Insufficient balance!")
        else:
            self.balance -= amount

---

📎 동적 타입 언어 vs 정적 타입 언어

[동적 타입 언어]

• 타입(자료형)을 변수를 선언할 때(컴파일) 정하는 것이 아니라 실행하면서 결정함
• 대표적으로 Python, Javascript, Ruby 등의 언어가 있음
• 장점 : 실행할 때까지 타입에 대한 결정을 가져갈 수 있기 때문에 선택의 여지가 있음, 코드가 간단함
• 단점 : 변수에 예상치 못한 타입이 들어와 TypeError가 발생할 수 있음

# 동적 타입 언어 : python
i = 0
j = 1.5
k = "DONA"

  

[정적 타입 언어]

• 변수 선언 시 앞에 타입(자료형)을 지정해주어야함, 맞지 않은 값이 들어있으면 컴파일 에러 발생
• 대표적으로 C, C#, C++, Java 등의 언어가 있음
• 장점 : 컴파일 시 타입에 대한 정보를 결정하기 때문에 속도가 빠르고, 타입 에러 문제점을 초기에 발견할 수 있기 때문에 안정성이 높음

# 정적 타입 언어 : java
int i = 0;
float j = 1.5;
String k = "DONA";
String k = new String("DONA");

---

📎 Reference

• mnemonic 위키백과
• 웹에서 간편하게 변수의 주소를 확인하며 코딩을 할 수 있는 사이트
• 정적 언어와 동적 언어 참고 블로그
• 점프 투 자바
• 코드잇 객체 지향 프로그래밍

🏡 해당 블로그 OOP series

• [OOP] (1) 클래스, 객체, 인스턴스, 객체지향 vs 절차지향 프로그래밍 정의
• [OOP] (2) 인스턴스 변수와 클래스 변수
• [OOP] (3) 메소드의 종류 : 인스턴스 메소드, 클래스 메소드, 정적 메소드 (with 파이썬 코드) & 특수메소드
• [OOP] (4) 추상화(Abstraction) : docstring, type hinting, 정적 동적 타입 언어