Skip to content

Commit 34f3a42

Browse files
chore(python): add nox session to sort python imports (#229)
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>
1 parent 145861d commit 34f3a42

7 files changed

+24
-11
lines changed

datalabeling/snippets/create_annotation_spec_set_test.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
import create_annotation_spec_set
2424
import testing_lib
2525

26-
2726
PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
2827

2928

datalabeling/snippets/create_instruction_test.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import create_instruction
2525
import testing_lib
2626

27-
2827
PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
2928
INSTRUCTION_GCS_URI = "gs://cloud-samples-data/datalabeling" "/instruction/test.pdf"
3029

datalabeling/snippets/import_data_test.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import import_data
2525
import testing_lib
2626

27-
2827
PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
2928
INPUT_GCS_URI = "gs://cloud-samples-data/datalabeling/image/image_dataset.csv"
3029

datalabeling/snippets/label_image_test.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@
2424
import label_image
2525
import testing_lib
2626

27-
2827
PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
2928
INPUT_GCS_URI = "gs://cloud-samples-data/datalabeling/image/image_dataset.csv"
3029
INSTRUCTION_GCS_URI = "gs://cloud-samples-data/datalabeling" "/instruction/test.pdf"

datalabeling/snippets/manage_dataset_test.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,12 @@
1717
import os
1818

1919
import backoff
20-
from google.api_core.exceptions import RetryError
21-
from google.api_core.exceptions import ServerError
20+
from google.api_core.exceptions import RetryError, ServerError
2221
import pytest
2322

2423
import manage_dataset
2524
import testing_lib
2625

27-
2826
PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
2927

3028

datalabeling/snippets/noxfile.py

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@
2222

2323
import nox
2424

25-
2625
# WARNING - WARNING - WARNING - WARNING - WARNING
2726
# WARNING - WARNING - WARNING - WARNING - WARNING
2827
# DO NOT EDIT THIS FILE EVER!
2928
# WARNING - WARNING - WARNING - WARNING - WARNING
3029
# WARNING - WARNING - WARNING - WARNING - WARNING
3130

3231
BLACK_VERSION = "black==22.3.0"
32+
ISORT_VERSION = "isort==5.10.1"
3333

3434
# Copy `noxfile_config.py` to your directory and modify it instead.
3535

@@ -168,12 +168,33 @@ def lint(session: nox.sessions.Session) -> None:
168168

169169
@nox.session
170170
def blacken(session: nox.sessions.Session) -> None:
171+
"""Run black. Format code to uniform standard."""
171172
session.install(BLACK_VERSION)
172173
python_files = [path for path in os.listdir(".") if path.endswith(".py")]
173174

174175
session.run("black", *python_files)
175176

176177

178+
#
179+
# format = isort + black
180+
#
181+
182+
183+
@nox.session
184+
def format(session: nox.sessions.Session) -> None:
185+
"""
186+
Run isort to sort imports. Then run black
187+
to format code to uniform standard.
188+
"""
189+
session.install(BLACK_VERSION, ISORT_VERSION)
190+
python_files = [path for path in os.listdir(".") if path.endswith(".py")]
191+
192+
# Use the --fss option to sort imports using strict alphabetical order.
193+
# See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections
194+
session.run("isort", "--fss", *python_files)
195+
session.run("black", *python_files)
196+
197+
177198
#
178199
# Sample Tests
179200
#

datalabeling/snippets/testing_lib.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,14 @@
1717

1818
import backoff
1919
from google.api_core.client_options import ClientOptions
20-
from google.api_core.exceptions import DeadlineExceeded
21-
from google.api_core.exceptions import FailedPrecondition
20+
from google.api_core.exceptions import DeadlineExceeded, FailedPrecondition
2221
from google.cloud import datalabeling_v1beta1 as datalabeling
2322

2423
import create_annotation_spec_set as annotation_spec_set_sample
2524
import create_instruction as instruction_sample
2625
import import_data as import_sample
2726
import manage_dataset as dataset_sample
2827

29-
3028
RETRY_DEADLINE = 60
3129

3230

0 commit comments

Comments
 (0)