구글 Python 스타일 가이드

Google Python Style Guide
구글 파이썬 스타일 가이드

1 배경[ | ]

Python은 Google에서 사용하는 주요 동적 언어이다. 이 스타일 가이드는 파이썬 프로그램에서 dos and don'ts(해야 할 일과 하지 말아야 할 일)의 목록이다.

코드 형식을 올바르게 지정하는 데 도움이 되도록 Vim용 설정 파일을 만들었다. Emacs의 경우 기본 설정이면 괜찮다.

많은 팀에서 형식에 대한 논쟁을 피하기 위해 yapf 자동 포맷터를 사용한다.

2 파이썬 언어 규칙[ | ]

2.1 Lint[ | ]

코드에 대해 pylintrc를 사용하여 pylint를 수행한다.

2.1.1 정의[ | ]

pylint는 파이썬 소스 코드에서 버그와 스타일 문제를 찾기 위한 도구이다. C 및 C++와 같이 덜 동적인 언어에 대해 컴파일러에서 일반적으로 포착하는 문제를 찾는다. Python의 동적 특성으로 인해 일부 경고는 정확하지 않을 수 있다. 그러나 가짜 경고는 매우 드물게 발생해야 한다.

2.1.2 장점[ | ]

2.1.3 단점[ | ]

2.1.4 의사결정[ | ]

2.2 Imports[ | ]

2.3 Packages[ | ]

2.4 Exceptions[ | ]

2.5 Global variables[ | ]

2.6 Nested/Local/Inner Classes and Functions[ | ]

2.7 Comprehensions & Generator Expressions[ | ]

2.8 Default Iterators and Operators[ | ]

2.9 Generators[ | ]

2.10 Lambda Functions[ | ]

2.11 Conditional Expressions[ | ]

2.12 Default Argument Values[ | ]

2.13 Properties[ | ]

2.14 True/False Evaluations[ | ]

2.15 Lexical Scoping[ | ]

2.16 Function and Method Decorators[ | ]

2.17 Threading[ | ]

2.18 Power Features[ | ]

2.19 Modern Python: from __future__ imports[ | ]

2.20 Type Annotated Code[ | ]

3 파이썬 스타일 규칙[ | ]

3.1 Semicolons[ | ]

3.2 Line length[ | ]

3.3 Parentheses[ | ]

3.4 Indentation[ | ]

3.5 Blank Lines[ | ]

3.6 Whitespace[ | ]

3.7 Shebang Line[ | ]

3.8 Comments and Docstrings[ | ]

3.9 Strings[ | ]

3.10 Files, Sockets, and similar Stateful Resources[ | ]

3.11 TODO Comments[ | ]

3.12 Imports formatting[ | ]

3.13 Statements[ | ]

3.14 Accessors[ | ]

3.15 Naming[ | ]

3.16 Main[ | ]

3.17 Function length[ | ]

3.18 Type Annotations[ | ]

4 마치며[ | ]

5 참고[ | ]