[Python] 0719_파이썬 클린 코드

Chapter. 1 코드 포매팅과 도구

 

1.     클린 코드의 중요성

-       유지보수성 향상, 기술 부채의 감소, 에자일 개발을 통한 효과적인 작업 진행

 

1)     클린 코드에서 코드 포매팅의 역할

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

-       코드를 올바르게 포매팅하는 것은 작업 효율화를 위해 중요

 

2)     프로젝트 코딩 스타일 가이드 준수

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

•  가독성이 높아지고, 신속하게 패턴을 파악해 오류를 감지하는 것이 쉬워짐
•  PEP-8 표준 권장
•  검색 효율성 / 일관성 / 코드 품질

 

2.     Docstring과 어노테이션

-       파이썬은 동적으로 타입을 결정하기 때문에, 주석은 가급적으로 피하고 문서화, 어노테이션을 통해 정보를 명시하는 것이 효율적

 

1)     Docstring

-       소스 코드에 포함된 문서. 기본적으로 리터럴 문자열

-       코드의 특정 컴포넌트에 대한 문서화

 

2)     어노테이션

-       코드 사용자에게 함수 인자로 어떤 값이 와야 하는지 힌트를 주는 것

   Ex) type 지정, 변수 의도 설명하는 문자열, 콜백 / 유효성 검사 함수로 사용할 수 있는 callable

-       __annotations__로 문서 생성, 유효성 검증 또는 타입 체크 가능

 

3)     어노테이션은 docstring을 대체하는 것일까?

-       어노테이션과 docstring은 서로 보완적인 개념

-       Docstring은 입력 값과 반환 값의 예상 형태를 잘 이해할 수 있고, 단위 테스트에서도 유용한 정보로 사용

-       단, Docstring을 사용 시 이슈는 코드가 좀 커지고, 효과적인 문서가 되려면 보다 상세한 정보가 필요하다는 점

 

4)     기본 품질 향상을 위한 도구 설정

-       Mypy를 사용한 type hinting

-       Pylint를 사용한 코드 검사

-       자동 검사 설정

 

3.     요약

-       클린 코드란 코드의 구조나 레이아웃보다 기술 부채를 최소화하고 가독성, 유지 보수성과 타인의 이해를 높이는 효과적인 코드 작성 방법

 

---

 

※ 해당 글은 다음 책을 참고하여 작성하였습니다.

http://www.yes24.com/Product/Goods/69064790

파이썬 클린 코드 - YES24