0. 목차

1**. Python 버전**

• 3.8+ 이상을 사용합니다.

2. 사용할 툴들

기본적으로 다음 툴들을 이용하여, 코드 스타일의 기본 레이아웃을 일관성있게 만듭니다.

• isort
  • import 순서를 자동으로 정렬해줍니다.
• black
  • 코드의 레이아웃을 일관성있도록 맞춰주는 코드 포매터입니다.
  • 한 줄에 최대 88자가 기본 값이지만, 우리 팀은 최대 120자를 사용합니다.

이 툴들을 사용하기 위한 IDE (vscode, pycharm) 세팅은 깃허브 템플릿 페이지에 이미 세팅되어 있습니다.

👉 파이참에서 적용하는 방법

3. 스타일 규칙

린트와 포매터 툴을 사용하더라도, 일관성 있는 스타일이 완전히 맞춰지는 것은 아닙니다.
여전히 우리는 몇몇 스타일들을 직접 약속하고 규정해야 합니다.
다음은 이런 스타일들을 직접 정의합니다.

기반 문서

모든 스타일을 하나씩 다 정의하지는 않습니다.
기본적으로 다음 문서들을 기반으로 합니다.

• PEP8
• Google Python Style Guide (한글 번역 버전은 여기)
• The Black code style

위 문서들은 꽤나 세세하고 방대하게 스타일에 대해 말하고 있습니다.
다만, 이 스타일을 완전히 따르지 않고, 우리 팀에 맞게 조금 변형합니다.
이렇게 변형하거나 강조할 내용들을 아래에서 다룹니다.