Difference between revisions of "Documentation/Nightly/Developers/Style Guide/Python"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
(Moved to readthedocs)
Tag: 2017 source edit
Line 1: Line 1:
Follow PEP 8 standards: [http://www.python.org/dev/peps/pep-0008/ Official PEP 8 Guidelines]
| text = [https://slicer.readthedocs.io/en/latest/developer_guide/style_guide.html This page has been moved to read-the-docs.]
| background-color = 8FBC8F }}
== Rules ==
* Indentation is --- 4 spaces per level ---  
** ''Do not use tabs, EVER!'' Those who insist on using tabs for indentation will be a pariah in the community and summarily '''shot on sight'''.
* Text encoding
** ASCII or Latin-1 (Python 2+)
** UTF-8 preferred, Latin-1 acceptable (Python 3)
* '''Comparisons'''
** To singletons (e.g. None)
*** Use 'is' or 'is not', never equality operations
** To booleans (True, False)
*** Don't ever compare with True or False (For further explanation, see PEP 8)
== Guidelines ==
* Maximum line length is 79 characters
* Prefix class definitions with two blank lines
* '''Imports'''
** Grouped in order of scope/commonallity
**# Standard library imports
**# Related third party imports
**# Local apps/library specific imports
** One package per line (with or without multiple function/module/class imports from the package)
* Avoid extraneous whitespaces
* Naming conventions
** [http://www.python.org/dev/peps/pep-0008/#package-and-module-names Package and Module Names]
** When PEP 8 and Slicer naming conventions conflict, Slicer wins
== Checking your code ==
There is a handy command line tool to check your code against the PEP 8 standard called pep8. It has options to turn off specific warnings and errors in case you (almost always) have to break from the standard. You can download and install it from it's [https://github.com/jcrocholl/pep8 Github repo]

Latest revision as of 20:33, 15 March 2022

Home < Documentation < Nightly < Developers < Style Guide < Python