-
-
파이썬 클린 코드 - 유지보수가 쉬운 파이썬 코드를 만드는 비결
마리아노 아나야 지음, 김창수 옮김 / 터닝포인트 / 2019년 2월
평점 :
구판절판
클린 코드는 단순하게 체커(checker)를 사용해 문법을 체크하거나, 린터(Linter)를 사용해 취약한 부분을 찾아내거나, 정적 분석기를 실행하는 것이 아니다. 클린 코드는 코드의 가독성을 높여 작업자 간의 이해도를 높임에 따라 코드 품질을 높이고 유지보수의 향상성을 가져온다.
PEP는 Python Enhancement Proposal을 말한다. 거기서 PEP-8은 핵심 파이썬 개발자가 만들었는데 PEP-8에 따라 코딩을 작성하여 코드의 이해도를 높이고 일관성을 유지해 코드의 품질을 높일 수 있다. PEP-8을 모두 준수한다고 해도 클린 코드의 요건을 충족하는 것은 아니다. 기본적인 코드 지침이라고 볼 수 있다. 코딩 가이드라인은 품질과 표준을 지키기 위해 따라야 하는 최소한의 요구사항이다. 가이드에 따라 코드가 일관되게 구조화되어 있으면 가독성이 높아지고 이해하기 쉬워진다.
Docstring은 주석을 다는 것이 아니라 설명을 기술하는 것이다. 코드의 특징이나 모듈, 클래스, 함수에 대한 것을 설명한다. 이전에는 소스코드에 주석을 달았는데 최근에는 코드에 주석을 다는 것은 나쁜 습관으로 본다. 생각을 코드로 제대로 표한하지 못하였기에 주석을 달아서 보충하는 것이다. 소스 코드만으로 쉽게 읽혀지고 동작하는 로직을 바로 볼 수 있도록 코딩해야 한다.
코드 리뷰에 시간을 투자하고 보다 좋은 코드가 무엇인지, 어떻게 하면 읽기 쉽고 관리하기 쉬운 코드인지 고민해야 한다. Mypy, Pylint 등과 같은 코드에 대한 검사는 자동화하는 것이 중요하다.