Django의 코딩 스타일

Django의 코딩 스타일

Django의 코딩 스타일에 대해서 알아보자.

1. 읽기 쉬운 코드?

이 공부를 하는 이유는 간단하다.

읽기 쉬운 코드를 만들기 위해서이다.

읽기 쉬운코드를 만드는 이유는 코드의 가독성이 좋아지고 추후 유지보수도 쉬워지고 가장 좋은건 내가 편하다.

그렇기 때문에 코드는 읽기 쉽게 만들어야한다.

• 축약적이거나 함축적인 변수명은 피한다.
• 함수 인자의 이름들은 꼭 써 준다.
• 클래스와 메서드를 문서화 한다.
• 코드에 주석은 꼭 달도록 한다.
• 재사용 가능한 함수 또는 메서드 안에서 반복되는 코드들은 리팩터링을 해둔다.
• 함수와 메서드는 가능한 작은 크기를 유지한다. 스크롤 없이 읽을수 있는 길이가 적합하다.

위와 같은 사항들을 잘 지켜주면 읽기 쉬운 코드가 된다고 한다.

2. 코드 작성에도 정해진 규칙이 있다?

코드를 작성하는데 여러가지 규칙이 있다고 한다.

Python은 PEP8이라는 공식 스타일 가이드가 있는데

무조건 한번은 읽어보는 것을 추천한다.

예를 들어

• 들여쓰기에는 스페이스가 4칸 이용한다.
• 최상위 함수와 클래스 언언 사이를 구분 짓기 위해 두 줄을 띄운다.
• 클래스 안에서 메서드들을 나누기 위해 한 줄을 띄운다.
• 코드는 최대 79글자 까지만 가능하다.
  등 여러가지가 있다고 한다.

이것은 공통적으로 정해진 규칙이라 지키는것을 추천한다.

이런것을 자동적으로 해주는 플러그인을 다운받아서 사용해도 된다.

import에도 순서가 있다?

Django나 Python 코드를 작성할때 필요한 라이브러리가 있으면 import해서 사용을 한다.

import하는 것에도 순서와 그룹이 있다고 한다.
1. 표준 라이브러리 임포트
2. 코어 장고 임포트
3. 장고와 무관한 외부 앱 임포트
4. 프로젝트 앱 임포트

import json

from django.http        import JsonResponse
from django.views       import View
from django.db.models   import Q

from .models            import Post, Comment, Like, Follow
from users.models       import Account
from utils              import login_decorator

대충 위와 같이 하면 된다고 한다.

그룹마다 한칸의 공간을 두고 import해주면 된다고 한다.

그리고 또 한가지 확인할 것이 바로 이 '*'이다.