이전에 작성한 파이썬 코드들을 다시 보게되면서, 내가 파이썬이라는 언어를 잘 쓰고 있는가? 에 대한 고민을 시작하였다. 나름의 리펙토링(?)이라고 말하면서 list comprehension, 각종 간편화된 method들을 사용하는 것에만 끝난 것 같아, 파이썬 클린 코드를 공부해봐야겠다는 마음이 생겼다. 주변 지인들의 추천으로, "파이썬 클린코드"(마리아노 아나야 지음, 김창수 옮김)을 읽기 시작하였고 관련된 내용을 차근차근 정리하고자한다. 기회가 된다면, 본 책의 내용을 토대로 진행한 프로젝트의 코드를 수정할 생각도 하고 있다.
포스팅은 필자가 생각하는 중요한 부분을 위주로 정리를 할 예정이다.
클린코드란?
유지보수성 향상, 기술 부채의 감소, 애자일 개발을 통한 효과적인 작업 진행, 성공적인 프로젝트 관리를 위해서는 그에 맞는 코드 작성 방법 및 관리 방식이 필요하다. 클린 코드는 위와 같은 부분을 만족하는 코드를 의미한다. (기술 부채: 현재의 코드를 수정하는 것 보다 미래의 코드를 수정하는 거이 더욱 어렵다.)
파이썬에서는 PEP-8 표준을 대부분 준수하고, 개발자들은 유지보수성 향상, 기술 부채의 감소, 애자일 개발을 통한 효과적인 작업 진행, 성공적인 프로젝트 관리를 위해서 클린코드를 지향한다.
Docstring
코드를 작성할때 주석은 지양해야되는 부분 중 하나이다. 하지만, 코드를 사용하는 것에 대한 친절한 설명을 써 다른 개발자들의 이해를 돕고자 할때는 어떻게 해야 할까? 이에 대한 답이 Docstring이다. 다른 곳에 있는 method를 사용하는 것이 아닌 본인이 만든 method들의 사용방법들을 주석과 비교했을때 보다 깔끔하게 정리해 놓을 수 있다. Docstring을 확인 하기 위해서는 (method 이름).doc 을 파이썬 터미널에서 입력하면 통해서 알 수 있다.
Annotations
파이썬을 사용하다보면 딕셔너리 구조를 많이 마주하게 된다. 이러한 딕셔너리의 구조를 알려면 어떻게 해야할까? 이에 대한 정보를 쉽게 알 수 있는 방법이 PEP-3107에 서 소개된다. (dictionary 이름).annotations 을 파이썬 터미널에서 입력하면 {key 값: value 형식}이 나타나게된다.
프로젝트에서 클린코드를 유지하는 방법
프로젝트가 커지고 많은 개발자와 소통하면서 개발을 진행하는 경우에는 하나하나 모든 것을 확인하면서 진행하기는 어려울 것이다. 따라서, 이를 도와주는 도구들이 있다. 대표적인 방법으로는 Mypy, Pylint 등이 있다. 이에 대한 사용법은 직접 프로젝트를 진행하면서 정리하는 것이 더 좋을 것으로 판단되어 후에 다루도록 하겠다.
