RidgeRun Developer Manual - Coding Styles - Python
WORK IN PROGRESS. Please Contact RidgeRun OR email to support@ridgerun.com if you have any questions. |
RidgeRun Developer Manual |
---|
Coding Styles |
Development Tools |
Editors |
Debugging Tools |
|
Profiling Tools |
Methodologies |
Design Patterns |
RidgeRun Developer Manual/Testing |
RidgeRun Developer Manual/Build Systems |
Contact Us |
Introduction to 'Python' Coding Styles
When writing Python code, RidgeRun tries to follow PEP8 - Style Guide for Python Code. Following we present some of the rules presented in this standard. For more information please visit PEP8.
Good practices
Be consistent with your code
In general, if you are adding code to an existent code, be consistent with the coding standard already being used. If no standard is used then follow this guide.
Code Layout
Indentation
Use 4 spaces per indentation level. See indentation for more information.
Maximum line length
Limit all lines to a maximum of 79 characters. See maximum line length for more information.
Imports
- Imports should usually be on separate lines
# Correct: import os import sys
# Wrong: import sys, os
- Imports are always put at the top of the file, just after any module comments and docstrings, and before module globals and constants.
- Imports should be grouped in the following order:
1. Standard library imports. 2. Related third party imports. 3. Local application/library specific imports.
You should put a blank line between each group of imports.
For more information see imports
Naming