Add YAPF job

.gitlab-ci.yml

@@ -146,7 +146,7 @@ pytest:
       junit: tests/coverage.xml
 
 
-# Ensure we adhere to PEP8.
+# Ensure we pass the `flake8` linter.
 flake8:
   stage: test
   timeout: 5m
@@ -157,6 +157,27 @@ flake8:
       --exclude=shelllogger-env
 
 
+# Ensure we adhere to our style guide.variables:
+yapf:
+  stage: test
+  timeout: 5m
+  cache:
+    <<: *global_cache
+  script:
+    - python3 -m yapf
+      --diff
+      --recursive
+      . > yapf.diff.txt
+    - |-
+      if [[ "$(wc -l yapf.diff.txt | awk '{print $1}')" != "0" ]]; then
+        echo "----------"
+        echo "Your code does not match our Python style guide."
+        echo "Run 'yapf -i' on the following files:"
+        grep "^+++.*(reformatted)$" yapf.diff.txt | awk '{print $2}'
+        exit 1
+      fi
+
+
 # Ensure the examples run without problems.
 examples:
   stage: test

.style.yapf

@@ -0,0 +1,18 @@
+# YAPF Style Configuration
+
+# See: /~https://github.com/google/yapf#knobs for available options
+
+[style]
+# Base style
+based_on_style = pep8
+
+# Customizations
+arithmetic_precedence_indication = True
+blank_line_before_nested_class_or_def = True
+coalesce_brackets = True
+dedent_closing_brackets = True
+join_multiple_lines = False
+split_all_comma_separated_values = True
+split_before_arithmetic_operator = True
+split_before_dot = True
+split_complex_comprehension = True

tests/requirements.txt

@@ -6,3 +6,4 @@ psutil
 pytest >= 6.2
 pytest-cov >= 2.12
 pytest-mock >= 3.6
+yapf