[파이썬 클린코드] 1장 (코드 포매팅과 도구) 정리

안녕하세요 Dibrary입니다. 아래 내용은 파이썬 클린코드의 1장 중에 핵심 내용만을 정리한 것입니다.

 

프로그래밍 언어의 진정한 의미는 아이디어를 다른 개발자에게 전달하는 것이다.

코드를 클린한 상태로 만들면 유지보수성 향상, 기술부채 감소, 민첩한 개발, 지속적인 배포등 여러 장점들이 있다.

클린코드는 품질 좋은 소프트웨어를 개발하고, 견고하고 유지보수가 쉬운 시스템을 만들고, 기술 부채를 회피하는 것을 말한다.

---

좋은 코드 레이아웃에서 가장 필요한 특성은 일관성.

파이썬이 따라야 하는 코딩 스타일은 PEP-8이다.

PEP 8 – Style Guide for Python Code | peps.python.org

코드에 주석을 넣는 행위는 가급적 피해야 한다.

주석 대신 docstring을 사용해서 가능한 많은 docstring을 추가하는 것이 좋다.

 

어노테이션을 사용해 예상 타입을 지정할 수 있다.

위 코드에서는 a와 b는 int 자료형이 들어온다고 알려준 것이고, 결과는 int로 반환된다고 알려준 것이다.

타입힌팅이란, 인터프리터와 독립된 추가 도구를 사용해 코드 전체에 올바른 타입이 사용되었는지 확인하고 호환되지 않는 타입이 발견되었을 때 사용자에게 힌트를 주는 것

 

클래스에서도 어노테이션을 사용할 수 있다.

초기 전달인자 name의 자료형은 str이라고 알려준 것이다. 물론, 이 어노테이션은 강제력이 없다. str로 써 놓았지만, 숫자를 넣어도 동작은 한다. 단지, 해당 코드를 이해하는데 있어서 도움이 될 수 있는 '정보'로써 존재하는 것이다.

 

---

개발자는 코드 리뷰에 시간을 투자하고, 훌륭한 코드가 무엇인지, 얼마나 읽기 쉽고 이해하기 쉬운 코드인지에 대해 고민해야 한다.

 

mypy = 파이썬 정적 타입 검사 도구

pylint = PEP-8을 준수했는지 여부 검사하는 도구