RIDI Style Guide

Python 코딩 스타일

코드 규약은 PEP8과 Google의 스타일 가이드를 최대한 따른다. 위 가이드에서 중요한 부분이나 언급되지 않은 부분 그리고 서로 상충되는 부분은 따로 아래에 기술한다.

추가 규칙

• 리스트, 튜플, 딕셔너리 사용시 마지막에 ,(trailing commas)를 붙인다.
  • 데이터 추가시 diff 보기에 편하다.
• Mixin으로 사용할 경우 부모 클래스를 가장 마지막에 적는다.
  • ex) Child(Mixin1, Mixin2, Parent)
• 가독성 관련

  • 반복문과 분기를 한 라인이 같이 담는 식의 코드를 작성하지 않는다.

    # Bad
    content_ids = [content.id for content in contents if content is not None]
    

    # Alternative
    content_ids = [content.id for content in filter(None, contents)]
    # or
    content_ids = map(lambda content: content.id, filter(None, contents))
    

변경 규칙

• 1행에 140자까지 사용한다.
• 줄바꿈, 공백

  • 함수 인자 (아래 둘다 된다)

    foo = long_function_name(
            var_one, var_two,
            var_three, var_four
            )
    print(var_one)
    

    foo = long_function_name(
            var_one, var_two, var_three, var_four
            )
    print(var_one)
    

강조규칙

• 세미콜론을 사용하지 않는다.
  • 2개의 command 를 세미콜론을 사용해 한라인에 표현이 가능하지만 사용하지 않는다.
• 클래스
  • 클래스에서 private 멤버나 메소드는 이름 앞에 밑줄을 추가한다.
• 비교  - None과 비교, Boolean 비교는 is, is not 을 사용한다.  - Boolean 비교: if not is_ok:  - 객체의 타입을 비교할 때는 isinstance()를 사용한다.
• 문자열
  • string 모듈보다는 string 메소드를 사용한다.
    • 메소드가 모듈보다 빠르고 유니코드 문자열에 대해 같은 API 를 공유한다.  - 접두사나 접미사를 검사할 때는 startswith()와 endswith()를 사용한다.
• 이름규칙
  • module_name
  • package_name
  • ClassName
  • method_name
  • ExceptionName
  • function_name
  • GLOBAL_CONSTANT_NAME
  • global_var_name
  • instance_var_name
  • function_parameter_name
  • local_var_name

Pylint

Pylint 설치 pip3 install pylint

Pylint 설치 위치 확인 which pylint

PyCharm

• Preferences > Editor
  • Code Style
    • Line separator (for new files): Unix and OS X (\n)
    • Right Margin (columns) : 140
  • Code Style > Python > Other
    • (check) Add line feed at the end of file
    • (check) Use continuation indent for arguments
• Preferences > External Tools
  • ”+” 버튼을 눌러서 Pylint 추가
    • Name: Pylint
    • Program: which 로 찾은 경로 입력
    • Parameters: $FilePath$
  • Tools > External Tools > Pylint 체크되어 있는지 확인

패키지 관리

Library 개발시

• PyPI에 배포후 ridi 계정을 등록한 패키지의 Owner로 추가한다.
• PyPI에 등록하는 패키지명(setup.py의 name필드)은 ridi-로 시작하고 여러 단어로 이름지어진 경우 -(하이픈)으로 구분한다.
  • ex) ridi-cms-sdk
• PyPI의 패키지명과 import시 사용하는 패키지명은 가급적 일치시키되, import 이름에는 -를 사용하지 않는다.
• 최상위 패키지 이름은 ridi를 사용한다.

    # PyPI: ridi-cms-sdk
    # Directory tree: ridi/cms
    from ridi.cms import CmsClient
  

Application 개발시

• 최상위 폴더 또는 패키지 이름으로 ridi를 사용하지 않는다.  - 사내 Library의 최상위 패키지 이름이 ridi이므로 import 트랩가 발생할 수 있다.