Keep in mind that сode is read more often than it is written.
We follow the Google Python Style Guide. This document highlights a number of peculiarities to pay special attention to, as well as complements the Google style guide on issues not specified there.
- Maximum line length is 80 characters.
- Indent code blocks with 4 spaces.
- Use parentheses sparingly.
- Naming:
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
- Avoid dashes (
-
) in any package/module name.
- Avoid dashes (
- Google-style docstrings:
- Summary line, blank line, followed by the rest of the docstring.
- All sentences must be terminated by a period, question mark, or exclamation point.
- The docstring should be descriptive-style ("Fetches rows from a Bigtable.") rather than imperative-style ("Fetch rows from a Bigtable.").
- Use
Args:
,Returns:
, andRaises:
for documenting functions.
- Comments:
- Either before the operation or on the same line.
- Comments on the same line should start at least 2 spaces away from the code with the comment character #, followed by at least one space before the text of the comment itself.
- Comments should be as readable as narrative text, with proper capitalization and punctuation.
- Either before the operation or on the same line.
- Use single quotes
'
(as opposed to"
) everywhere, except docstrings.
You are strongly encouraged to use PyCharm as IDE. A free educational license is available for both students and educators. However, any other IDE may be used as long as it is configured according to the settings below.
- Set maximum line length to 80 characters.
- Use spaces (instead of tabs) for indentation.