[파이썬(python) 이야기 11화] 파이썬도 코드 작성 규칙, PEP STYLE GUID(PEP8), 코드 제대로(전문가처럼) 만들기

0. 파이썬도 스타일 가이드가 있다!

 

스타일 가이드란 코드 작성에 대한 규칙을 말합니다. 파이썬도 이러한 스타일 가이드가 있습니다. 스타일 가이드는 여러 사람이 같이 코드 작업을 할 때 매우 효과적입니다. 그 이유는 코드를 하나의 공통적인 규칙을 같지고 통일 시키기 때문입니다. 간단한 예시를 통해 살펴보겠습니다.  

5명의 개발자가 있다고 가정해 보겠습니다. 각 개발자들은 코드를 작성하는 스타일이 다 다를 것입니다. 어떤 개발자는 코드 한 줄이 매우 길고  어떤 개발자는 한 줄 한 줄 간의 간격을 크게하고 또 다른 개발자는  자신이 만든 모듈은 맨 아래에 패키지 모듈은 맨 위에 작성하는 등 다양한 경우가 있을 수 있기 때문입니다.   물론 혼자 개발하는 것은 당연이 이 부분이 문제가 되지 않습니다 하지만 여러 사람들이 같이 개발을 해야 하는 경우에는 어떨까요?

 

 

이러한 다양한 경우를 하나로 합치면  외부의 누군가가 이 코드를 검토할 때 정말 이상하게 보일 것입니다. 서로 규칙이 없으니 들쭉날쭉  다양한 스타일이 섞여 있기 때문입니다. 그럼 이 문제를 해결하기 위해 개발자들은 어떻게 할까요? 네 맞습니다. 우선 모여서 규칙을 만들 것입니다. 그리고 이를 지키기위한 다양한 업무프로세스를 구축해야만 합니다. 

 

잠깐 고민하기

 

실제 위의 과정이 정말 쉬울까요? 어떻게 생각하시나요?  

아마 여러분들도  취향이 있어서 실제 코드를 작성할 때 같이 작업을 하면 어려울 것입니다. 현장에서도 이 과정은 매우 어려운 과정입니다. 의견이 서로 제각각이라  하나의 통일된 규칙을 것부터  정말 어려운 일일 것입니다. 함께 작업을 할 때 항상 따르는 문제죠.

 

다행히 파이썬의 공식 기구에서는 이러한 부분을 이미 논의하고 있으며 가이드를 만들어 제공하고 있습니다. 알고보면 파이썬이 정말 많은 일을 하고 있습니다. 

 

자 그럼 이제 그 기준에 대해서 간단하게 살펴보도록 하겠습니다.

 

1. 파이썬 PEP 8 스타일 가이드

 

다양한 현장에서 이러한 문제가 대두됨에 따라, 파이썬은 공식적으로  이를 해결하기 위한 PEP8(PEP 풀 내임) 가이드를 마련하고 있습니다. 즉 개발자들 끼리 처음부터 규칙을 만들기 보다는 공식적으로  미리 기준을 제공해 다양한 곳에서 활용할 수 있도록 지원하고 있습니다. 

 

즉 개발자들이 보다 효과적으로 파이썬 개발에  집중할 수 있도록 지원합니다.  사실 하나의 개별 기업이나 조직이 이를  스스로 만든다는 건 매우 어려운 작업입니다.  효과가 있느냐, 매출이 오르냐 등 많은 장애요인이 의사결정 시에 발생하기 때문입니다.

 

이러한 부분에서 가장 큰 이유는 가시적인 성과를  증명하기 정말 어렵기 때문입니다. 실제로는 정말 필요한 일이고 프로세스가 존재하지 않으면 효율이 크게 낮기 때문입니다. 모든 프로젝트에 이런 것을 적용할 필요는 없지만 대규모 프로젝트에서는 반드시 이러한 규칙과 기준이 정립되어 있어야 합니다. 

 

PEP8 공식 가이드는 파이썬 공식페이지에서 확인할 수 있습니다. 

2. PEP8의 규칙 간단히 살펴보기

 

PEP8 스타일 가이드는 다양하지만, 대표적인 경우만 간단히 아래에 정리해 보았습니다. 

 

첫째, 들여쓰기 (Indentation)  
공백 4개를 사용하여 코드 블록을 들여쓰기해야 함, 특히 탭(tab) 대신 공백(space)을 사용해야함

 

둘째, 줄 길이 (Line Length): 

한 줄의 코드는 최대 79자로 제한되어야 함. 

 

셋째, 빈 줄 (Blank Lines): 

함수 정의와 클래스 정의 사이, 클래스 내의 메서드들 사이, import 문과 코드 사이에는 빈 줄을 하나씩 추가해야 함

 

넷째, 임포트 (Imports):

임포트문은 항상 파일의 맨 위에 작성되어야 함

→ 각각의 임포트 문은 다른 섹션으로 나누어져야 하며, 섹션 사이에는 빈 줄을 추가해야 함.

→ 임포트 순서는 표준 라이브러리 모듈, 서드파티 라이브러리 모듈, 로컬(자신이 작성한) 모듈 순서로 작성

 

다셋째, 함수와 클래스 네이밍 (Function and Class Naming):

함수와 메서드의 이름은 소문자와 밑줄을 사용하여 작성되어야 합니다. 클래스의 이름은 CapWords 방식으로 쓰여야 함

→ 예를 들어, 함수 이름은 calculate_average()처럼 작성하고, 클래스 이름은 MyClass처럼 작성해야 함

 

3. Pycham으로 실습하기!  - 모든 규칙을 알아야할까? 

 

"모든 규칙을 알아서 정리할 수 있다면?" 이란 생각을 하고 계실 것입니다. 물론 있습니다. 이번 포스트에서는 Pycham을 통해서 PEP8 규칙으로 코드를 손쉽게 고칠 수 있는 방법을 살펴보겠습니다. 

 

방법은 아주 간단합니다. 

(1)코드를 작성한다. 

 

→ 여기서 잠깐 살펴봐야할 것은 오른쪽 상단에 나타나는 경고 표시입니다. 이 경고 표시 대부분이 PEP8 스타일을 따르지 않기 때문입니다. 

 

(2) 메뉴에서 Code를 선택 →  Reformat Code를 선택합니다. 

`

→ 마지막으로 경고가 크게 줄어 든 것을 확인하실 수 있습니다. (세가지 표식중 가운데 표식이 준것을 확인할 수 있습니다)

 

4. 맺은말

 

PEP8 스타일 가이드를 적용하는 방법은 매우 다양한 방법이 있습니다. 모듈 중에는 Flake8, black 등이 있으며, Pycham이 아니더라도 Visual Studio Code에서 PEP 스타일 가이드를 적용하는 방법도 있습니다. 이 부분에 대해서는 이후 포스트에 다시 다뤄보도록 하겠습니다.