feat: add blacken nox session (GoogleCloudPlatform#4378)

Takashi Matsuo · web-flow · commit 5614d1b97b26 · 2020-07-24T19:06:30.000-07:00
* feat: add blacken nox session fixes GoogleCloudPlatform#4377 * add blacken session to existing noxfiles
diff --git a/AUTHORING_GUIDE.md b/AUTHORING_GUIDE.md
@@ -22,7 +22,7 @@ This section covers guidelines for Python samples. Note that
 
 ### Folder Location
 
-Samples that primarily show the use of one client library should be placed in the 
+Samples that primarily show the use of one client library should be placed in the
 client library repository. Other samples should be placed in this repository
 `python-docs-samples`.
 
@@ -100,6 +100,20 @@ local variables” warnings.
 The use of [Black](https://pypi.org/project/black/) to standardize code
 formatting and simplify diffs is recommended, but optional.
 
+The default noxfile has `blacken` session for convenience. Here are
+some examples.
+
+If you have pyenv configured:
+```sh
+nox -s blacken
+```
+
+If you only have docker:
+```
+cd proj_directory
+../scripts/run_tests_local.sh . blacken
+```
+
 In addition to the syntax guidelines covered in PEP 8, samples should strive
 to follow the Pythonic philosophy outlined in the
 [PEP 20 - Zen of Python](https://www.python.org/dev/peps/pep-0020/) as well
@@ -485,7 +499,7 @@ Automated testing for samples is managed by
 including the flake8 linter, Python 2.7, Python 3.x, and App Engine tests,
 as well as automated README generation.
 
-__Note:__ 
+__Note:__
 
 **Library repositories:** If you are working on an existing project, a `noxfile.py` will already exist.
 For new samples, create a new `noxfile.py` and paste the contents of
diff --git a/appengine/flexible/memcache/noxfile.py b/appengine/flexible/memcache/noxfile.py
@@ -84,6 +84,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
diff --git a/dataflow/encryption-keys/noxfile.py b/dataflow/encryption-keys/noxfile.py
@@ -84,6 +84,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
diff --git a/dataflow/flex-templates/streaming_beam/noxfile.py b/dataflow/flex-templates/streaming_beam/noxfile.py
@@ -84,6 +84,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
diff --git a/ml_engine/online_prediction/noxfile.py b/ml_engine/online_prediction/noxfile.py
@@ -84,6 +84,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
diff --git a/noxfile-template.py b/noxfile-template.py
@@ -144,6 +144,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
diff --git a/pubsub/streaming-analytics/noxfile.py b/pubsub/streaming-analytics/noxfile.py
@@ -84,6 +84,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
diff --git a/run/markdown-preview/editor/noxfile.py b/run/markdown-preview/editor/noxfile.py
@@ -144,6 +144,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
diff --git a/run/markdown-preview/renderer/noxfile.py b/run/markdown-preview/renderer/noxfile.py
@@ -144,6 +144,18 @@ def lint(session):
     session.run("flake8", *args)
 
 
+#
+# Black
+#
+
+@nox.session
+def blacken(session):
+    session.install("black")
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #
