Changes between Version 33 and Version 34 of Submitting/Python

Timestamp:

Nov 17, 2020, 2:03:10 PM (4 years ago)

Author:

wenzeslaus

Comment:

Describe how to use Black and Flake8

Submitting/Python

@@ -62 +62 @@
 == Style ==
 
+=== Indentation ===
+
 Use 4-space indentation (GNU Emacs python-mode default). **Do not use tabs (tabulators) at all**.
 Note that Python determines nesting based upon indentation, so it is quite crucial to be consistent, i.e. use given rules.
 
+=== Automation ===
+
+Use Black to format new files:
+
+
+{{{
+black python_file.py
+}}}
+
+Use Flake8 to check formatting of all files:
+
+{{{
+flake8 --extend-ignore=E203,E266,E501 --max-line-length=88 python_file.py
+}}}
+
+If the file you changed gives too many error in lines you did not change,
+see if the directory or any parent directory contains a file called .flake8 which
+contains a less strict configuration for this legacy code.
+Use it with the `--config` pararameter:
+
+{{{
+flake8 --config {path_to_flake8_file} {path_to_python_file}
+}}}
+
+For example like this:
+
+{{{
+flake8 --config lib/python/.flake8 lib/python/temporal/register.py
+}}}
 === Editor settings for 4-space indentation ===