Changes between Version 6 and Version 7 of Submitting/Python

Timestamp:

Jun 23, 2014, 4:58:35 PM (10 years ago)

Author:

annakrat

Comment:

list main pep8 rules

Submitting/Python

@@ -80 +80 @@
 Note that Python determines nesting based upon indentation, so it is quite crucial to be consistent, i.e. use given rules.
 
-Make sure a new line is at the end of each file and there are no trailing spaces.
-
 Do not fix (intentionally or unintentionally) existing style issues in code (at lines) you are not changing.
 If you are fixing style issues, do it in a separate commit.
 
-Use named parameters in functions (without space around '='), e.g.
-
-{{{
-!python
+Summary of the most important rules:
+ * Make sure a new line is at the end of each file.
+
+ * Use three double quotes for docstrings (`"""..."""`). Use double quotes for translatable (user visible) strings, single quotes for the rest.
+
+ * Remove trailing whitespace from the end of lines. Empty lines should not contain any spaces.
+ * Put space between operators:
+
+{{{
+#!python
+angle = angle * pi / 180
+# not this:
+angle = angle*pi/180
+}}}
+
+ * Do not use space around parentheses:
+
+{{{
+#!python
+grass.run_command('g.region', rast='myrast')
+# not this:
+grass.run_command( 'g.region', rast='myrast' )
+}}}
+
+ * Do not use space around '=' in a keyword argument:
+
+{{{
+#!python
+grass.run_command('g.region', rast='myrast')
+# not this:
+grass.run_command( 'g.region', rast = 'myrast' )
+}}}
+
+ * Use space after comma:
+
+{{{
+#!python
+a = [1, 2, 3]
+# not this:
+a = [1,2,3]
+}}}
+
+ * Good practice is to use named parameters in functions:
+
+{{{
+#!python
 dlg = wx.FileDialog(parent=self, message=_("Choose file to save current workspace"),
                     wildcard=_("GRASS Workspace File (*.gxw)|*.gxw"), style=wx.FD_SAVE)
-}}}
-
-instead of
-
-{{{
-!python
+# not this:
 dlg = wx.FileDialog(self, _("Choose file to save current workspace"),
-                    _("GRASS Workspace File (*.gxw)|*.gxw"), wx.FD_SAVE)
-}}}
-
-Use three double quotes for docstrings (`"""..."""`). 
-Use double quotes for translatable (user visible) strings, single quotes for the rest.
-
-
+                     _("GRASS Workspace File (*.gxw)|*.gxw"), wx.FD_SAVE)
+}}}
 == Writing the code ==