파이썬 코드 스타일 가이드(PEP8) 블랙(black)으로 자동화하기

2019. 5. 20. 06:34

직접 작성한 파이썬 코드라도 2~3개월 뒤에 보면 이해하는데 시간이 필요하다. 직접 작성한 코드도 그런데 남이 작성한 코드를 보는 것은 더욱 어렵다. 코드를 이해하기 어려운 이유는 여러가지가 있다. 그 중에 하나는 코드를 작성하는 방식이 서로 다르기 때문이다

오늘은 파이썬 코드 스타일 가이드(PEP8)를 블랙(black)으로 자동화하는 방법에 대해서 알아보도록 하겠다.


코드스타일_PEP8



1. PEP8과 블랙(black)이란?

각자 자신만의 스타일로 코드를 작성하면 가독성이 떨어질 수 밖에 없다. 그래서 일종의 코드작성 기준을 만들었는데 그게 PEP8(Python Enhacement Proposal #8)이라는 스타일 가이드이다. 제시하고 있는 기준을 몇 가지 살펴보면 아래와 같다.

( 참조: PEP8 전문 보러 가기


- 모든 행은 최대 97자로 작성합니다.

- 들여쓰기의 기준은 공백 4칸으로 합니다.

- 연속된 행으로 작성할 경우 들여쓰기를 이용하여 괄호, 중괄호, 대괄호 등의 요소를 수직 정렬합니다.

  ..........


이 외에도 많은 스타일 가이드가 있다. 이러한 기준을 준용하여 코드를 작성하면 좋겠지만, 아직 파이썬도 어색한데 스타일 가이드까지 따라가려니 스트레스다. 다행히 누군가 이러한 스타일 가이드를 자동으로 적용해주는 패키지를 개발하였다. 블랙(black)이라는 패키지이다. 터미널에서 pip install black을 실행하면, 블랙을 설치할 수 있다.


블랙은 PEP8을 준용한 스타일로 변경해 준다. 어떤 스타일로 변경해주는지 자세한 내용은 아래 링크를 참조해보자.
( 참조: 블랙 코드스타일 확인하러 가기 )


추천포스트



2. 블랙(blck)을 사용하는 방법은?

파이썬 코드에 블랙을 적용하기 위해서는 터미널에서 black <파일이름>으로 실행해야 한다. 하지만, 터미널에서 매번 실행해야 하는 것은 굉장히 귀찮은 일이다. 파이참에서는 블랙을 쉽게 적용할 수 있는 방법이 있다. [File] - [Settings] - [Tools] - [External Tools] 메뉴로 가보자. 여기서는 외부 응용프로그램을 등록해놓고 사용할 수 있도록 해 준다. 여기서 '+'버튼을 누르고 블랙을 추가해준다. 


파이참_블랙_설정방법

( 파이참 블랙 설정 방법)


외부 도구로 등록하는 방법은 위에 그림을 참조하기 바란다. Program에는 실행파일을 Arguments에는 현재 파일이름이 들어갈 수 있도록 설정하는 것이다.


이제 [Tools] - [External Tools] - [Black]을 클릭하면, 블랙의 코드 스타일이 바로 적용된다. 이미저도 불편하다면 단축키로 등록하여 사용할 수도 있다. 단축키를 등록하는 방법이 궁금하다면, 아래 포스팅을 참조해보자.
( 참조: 파이참 화면 레이아웃 알아보기 )


오늘은 이렇게 파이썬 코드 스타일 가이드(PEP8)를 블랙으로 자동화하는 방법에 대해서 알아보았다. 코드 스타일 가이드를 준용하면 가독성이 올라가 나중에 코드를 확인하거나 재사용할 때 유용하다. 다만, 익숙치 않을 때 이에 맞춰 코드를 작성하는 것은 피곤한 일이다. 블랙을 이용하면 코드스타일을 자동으로 바꿔주므로 이에 대한 고민 없이 코딩을 할 수 있다. 


몇 가지 팁이나 방법을 알면 파이썬을 더 효율적으로 코딩할 수 있는 방법들이 있다. 자세한 내용이 궁금하다면, 아래 링크를 참조해보자.
( 참조: 파이썬 효율적인 코딩팁과 방법들 )


댓글()