Documentation/4.1/Developers/Style Guide/Python - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:24:10Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

JChris.FillionR: /* Guidelines */

2012-06-13T22:14:36Z

Guidelines

JChris.FillionR: /* Checking your code */

2012-06-13T22:12:02Z

Checking your code

Dmwelch: Outlined PEP 8 briefly and added links

2012-06-05T15:48:12Z

Outlined PEP 8 briefly and added links

New page

Follow PEP 8 standards: [http://www.python.org/dev/peps/pep-0008/ Official PEP 8 Guidelines]

== 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
** 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.]]

← Older revision		Revision as of 07:24, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	Follow PEP 8 standards: [http://www.python.org/dev/peps/pep-0008/ Official PEP 8 Guidelines]		Follow PEP 8 standards: [http://www.python.org/dev/peps/pep-0008/ Official PEP 8 Guidelines]

← Older revision		Revision as of 22:12, 13 June 2012
Line 30:		Line 30:
	== Checking your code ==		== 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.]]	+	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]

@@ Line 26: / Line 26: @@
 * Avoid extraneous whitespaces
 * Naming conventions
 ** When PEP 8 and Slicer naming conventions conflict, Slicer wins