chore(python): add nox session to sort python imports (#312)

Source-Link: googleapis/synthtool@1b71c10 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:00c9d764fd1cd56265f12a5ef4b99a0c9e87cf261018099141e2ca5158890416 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
GoogleCloudPlatform · Apr 21, 2022 · 8d86326 · 8d86326
1 parent 89db439
commit 8d86326
Show file tree

Hide file tree

Showing 14 changed files with 22 additions and 19 deletions.
diff --git a/document_ai/snippets/batch_parse_form_v1beta2_test.py b/document_ai/snippets/batch_parse_form_v1beta2_test.py
@@ -16,12 +16,9 @@
 import uuid
 
 from google.cloud import storage
-
 import pytest
-
 from samples.snippets import batch_parse_form_v1beta2
 
-
 BUCKET = "document-ai-{}".format(uuid.uuid4())
 OUTPUT_PREFIX = "TEST_OUTPUT_{}".format(uuid.uuid4())
 PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]

diff --git a/document_ai/snippets/batch_parse_table_v1beta2_test.py b/document_ai/snippets/batch_parse_table_v1beta2_test.py
@@ -16,12 +16,9 @@
 import uuid
 
 from google.cloud import storage
-
 import pytest
-
 from samples.snippets import batch_parse_table_v1beta2
 
-
 BUCKET = "document-ai-{}".format(uuid.uuid4())
 OUTPUT_PREFIX = "TEST_OUTPUT_{}".format(uuid.uuid4())
 PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]

diff --git a/document_ai/snippets/batch_process_documents_sample_test.py b/document_ai/snippets/batch_process_documents_sample_test.py
@@ -18,9 +18,7 @@
 
 from google.cloud import storage
 from google.cloud.exceptions import NotFound
-
 import pytest
-
 from samples.snippets import batch_process_documents_sample
 
 location = "us"

diff --git a/document_ai/snippets/noxfile.py b/document_ai/snippets/noxfile.py
@@ -22,14 +22,14 @@
 
 import nox
 
-
 # WARNING - WARNING - WARNING - WARNING - WARNING
 # WARNING - WARNING - WARNING - WARNING - WARNING
 #           DO NOT EDIT THIS FILE EVER!
 # WARNING - WARNING - WARNING - WARNING - WARNING
 # WARNING - WARNING - WARNING - WARNING - WARNING
 
 BLACK_VERSION = "black==22.3.0"
+ISORT_VERSION = "isort==5.10.1"
 
 # Copy `noxfile_config.py` to your directory and modify it instead.
 
@@ -168,12 +168,33 @@ def lint(session: nox.sessions.Session) -> None:
 
 @nox.session
 def blacken(session: nox.sessions.Session) -> None:
+    """Run black. Format code to uniform standard."""
     session.install(BLACK_VERSION)
     python_files = [path for path in os.listdir(".") if path.endswith(".py")]
 
     session.run("black", *python_files)
 
 
+#
+# format = isort + black
+#
+
+
+@nox.session
+def format(session: nox.sessions.Session) -> None:
+    """
+    Run isort to sort imports. Then run black
+    to format code to uniform standard.
+    """
+    session.install(BLACK_VERSION, ISORT_VERSION)
+    python_files = [path for path in os.listdir(".") if path.endswith(".py")]
+
+    # Use the --fss option to sort imports using strict alphabetical order.
+    # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections
+    session.run("isort", "--fss", *python_files)
+    session.run("black", *python_files)
+
+
 #
 # Sample Tests
 #

diff --git a/document_ai/snippets/parse_form_v1beta2_test.py b/document_ai/snippets/parse_form_v1beta2_test.py
@@ -16,7 +16,6 @@
 
 from samples.snippets import parse_form_v1beta2
 
-
 PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]
 INPUT_URI = "gs://cloud-samples-data/documentai/form.pdf"
 

diff --git a/document_ai/snippets/parse_table_v1beta2_test.py b/document_ai/snippets/parse_table_v1beta2_test.py
@@ -16,7 +16,6 @@
 
 from samples.snippets import parse_table_v1beta2
 
-
 PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]
 INPUT_URI = "gs://cloud-samples-data/documentai/invoice.pdf"
 

diff --git a/document_ai/snippets/parse_with_model_v1beta2_test.py b/document_ai/snippets/parse_with_model_v1beta2_test.py
@@ -16,7 +16,6 @@
 
 from samples.snippets import parse_with_model_v1beta2
 
-
 PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]
 INPUT_URI = "gs://cloud-samples-data/documentai/invoice.pdf"
 AUTOML_NL_MODEL_ID = "TCN3472481026502981088"

diff --git a/document_ai/snippets/process_document_form_sample_test.py b/document_ai/snippets/process_document_form_sample_test.py
@@ -17,7 +17,6 @@
 
 from samples.snippets import process_document_form_sample
 
-
 location = "us"
 project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
 processor_id = "90484cfdedb024f6"

diff --git a/document_ai/snippets/process_document_quality_sample_test.py b/document_ai/snippets/process_document_quality_sample_test.py
@@ -17,7 +17,6 @@
 
 from samples.snippets import process_document_quality_sample
 
-
 location = "us"
 project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
 processor_id = "7fcb597c523721b3"

diff --git a/document_ai/snippets/process_document_sample_test.py b/document_ai/snippets/process_document_sample_test.py
@@ -17,7 +17,6 @@
 
 from samples.snippets import process_document_sample
 
-
 location = "us"
 project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
 processor_id = "90484cfdedb024f6"

diff --git a/document_ai/snippets/process_document_specialized_sample_test.py b/document_ai/snippets/process_document_specialized_sample_test.py
@@ -17,7 +17,6 @@
 
 from samples.snippets import process_document_specialized_sample
 
-
 location = "us"
 project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
 processor_id = "feacd98c28866ede"

diff --git a/document_ai/snippets/process_document_splitter_sample_test.py b/document_ai/snippets/process_document_splitter_sample_test.py
@@ -17,7 +17,6 @@
 
 from samples.snippets import process_document_splitter_sample
 
-
 location = "us"
 project_id = os.environ["GOOGLE_CLOUD_PROJECT"]
 processor_id = "ed55eeb2b276066f"

diff --git a/document_ai/snippets/quickstart_v1beta2_test.py b/document_ai/snippets/quickstart_v1beta2_test.py
@@ -16,7 +16,6 @@
 
 from samples.snippets import quickstart_v1beta2
 
-
 PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]
 INPUT_URI = "gs://cloud-samples-data/documentai/invoice.pdf"
 

diff --git a/document_ai/snippets/set_endpoint_v1beta2_test.py b/document_ai/snippets/set_endpoint_v1beta2_test.py
@@ -16,7 +16,6 @@
 
 from samples.snippets import set_endpoint_v1beta2
 
-
 PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"]
 INPUT_URI = "gs://cloud-samples-data/documentai/invoice.pdf"