Two Scoops of Django - #1장

회사 업무에서 사용되는 Django를 좀 더 배우고 싶어서

Two Scoops of Django를 읽으면서 내게 필요한 내용들을 간략하게 정리할 예정이다.

 

1장은 코딩 스타일에 대한 내용이다.

 

읽기 쉬운 코드를 만드는 것은 매우 중요. 당연한 이야기 중 내가 개선해야 할 사항들만 정리.

- 변수/함수명을 너무 축약하거나 함축시키지 말 것.

- 코드에 주석을 꼭 달 것.

- 웬만하면 PEP 8을 따르되, 현재 프로젝트 스타일이 따로 있다는 그것을 따를 것.

- 80 칼럼 제약의 경우도 지키는 게 좋으나(특히 오픈소스 프로젝트에서는), 각 프로젝트의 스타일이 있으면 거기에 따를 것.

 

임포트 순서에 대해.

1. 표준 라이브러리

2. 코어 장고

3. 장고와 무관한 외부 앱

4. 프로젝트 앱

 

묵시적 임포트를 사용하는 대신, 명시적 임포트를 사용하라.

from abc.models import a # 묵시적 임포트
from .abc.models import a # 명시적 임포트

앱의 이름이 변경되거나 경로가 변경될 경우 묵시적 임포트를 사용하는 경우,

사용되는 소스를 모두 찾아서 변경해야 하는 번거로움이 발생할 수 있다.

 

import * 는 사용하지 말 것. 필요한 것 만 import.

URL pattern, Template block name에는 대시(-) 대신 밑줄(_)을 이용할 것.

 

언제나 그렇지만 진행하는 프로젝트에서 정해놓은 룰을 따르는 게 우선이고

그 외의 것은 최대한 표준을 지향하는 것이 코딩 스타일을 정립하는데 기본 사항인 것 같다.