Add isort to autoformat and enforce import order and format (#160)

* isort then black

* Add isort endl

* Update comment

* nit

* empty

* empty

Author: phil-scale

.circleci/config.yml

@@ -35,6 +35,10 @@ jobs:
           name: MyPy typing check
           command: |
             poetry run mypy --ignore-missing-imports nucleus
+      - run :
+          name: Isort Import Formatting Check # Only validation, without re-formatting
+          command: |
+            poetry run isort --check-only .
       - run:
           name: Pytest Test Cases
           command: | # Run test suite, uses NUCLEUS_TEST_API_KEY env variable

.isort.cfg

@@ -0,0 +1,4 @@
+[settings]
+profile=black
+# Enforced in .flake8
+line_length=79

.pre-commit-config.yaml

@@ -32,4 +32,10 @@ repos:
       pass_filenames: false
       language: system
 
-
+-   repo: local
+    hooks:
+    - id: system
+      name: isort
+      entry: poetry run isort .
+      pass_filenames: false
+      language: system

conftest.py

@@ -3,7 +3,7 @@
 import pytest
 
 import nucleus
-from tests.helpers import TEST_DATASET_NAME, TEST_DATASET_ITEMS
+from tests.helpers import TEST_DATASET_ITEMS, TEST_DATASET_NAME
 
 assert "NUCLEUS_PYTEST_API_KEY" in os.environ, (
     "You must set the 'NUCLEUS_PYTEST_API_KEY' environment variable to a valid "

nucleus/__init__.py

@@ -36,7 +36,7 @@
 
 import os
 import time
-from typing import Dict, List, Optional, Union, Sequence
+from typing import Dict, List, Optional, Sequence, Union
 
 import pkg_resources
 import pydantic
@@ -45,14 +45,15 @@
 import tqdm.notebook as tqdm_notebook
 
 from nucleus.url_utils import sanitize_string_args
+
 from .annotation import (
     BoxAnnotation,
+    CategoryAnnotation,
     CuboidAnnotation,
+    MultiCategoryAnnotation,
     Point,
     Point3D,
     PolygonAnnotation,
-    CategoryAnnotation,
-    MultiCategoryAnnotation,
     Segment,
     SegmentationAnnotation,
 )
@@ -114,10 +115,10 @@
 )
 from .prediction import (
     BoxPrediction,
+    CategoryPrediction,
     CuboidPrediction,
     PolygonPrediction,
     SegmentationPrediction,
-    CategoryPrediction,
 )
 from .retry_strategy import RetryStrategy
 from .scene import Frame, LidarScene

nucleus/annotation.py

@@ -9,7 +9,6 @@
     ANNOTATIONS_KEY,
     BOX_TYPE,
     CATEGORY_TYPE,
-    MULTICATEGORY_TYPE,
     CUBOID_TYPE,
     DIMENSIONS_KEY,
     GEOMETRY_KEY,
@@ -20,6 +19,7 @@
     MASK_TYPE,
     MASK_URL_KEY,
     METADATA_KEY,
+    MULTICATEGORY_TYPE,
     POLYGON_TYPE,
     POSITION_KEY,
     REFERENCE_ID_KEY,
@@ -28,8 +28,8 @@
     VERTICES_KEY,
     WIDTH_KEY,
     X_KEY,
-    YAW_KEY,
     Y_KEY,
+    YAW_KEY,
     Z_KEY,
 )
 

nucleus/autocurate.py

@@ -5,7 +5,9 @@
 
 
 import datetime
+
 import requests
+
 from nucleus.constants import (
     JOB_CREATION_TIME_KEY,
     JOB_LAST_KNOWN_STATUS_KEY,

nucleus/data_transfer_object/dataset_info.py

@@ -1,5 +1,4 @@
-from typing import List, Optional, Dict, Any
-
+from typing import Any, Dict, List, Optional
 
 from nucleus.data_transfer_object.dict_compatible_model import (
     DictCompatibleModel,

nucleus/dataset.py

@@ -6,10 +6,10 @@
 from nucleus.job import AsyncJob
 from nucleus.prediction import (
     BoxPrediction,
+    CategoryPrediction,
     CuboidPrediction,
     PolygonPrediction,
     SegmentationPrediction,
-    CategoryPrediction,
     from_json,
 )
 from nucleus.url_utils import sanitize_string_args
@@ -19,26 +19,27 @@
     format_prediction_response,
     serialize_and_write_to_presigned_url,
 )
+
 from .annotation import (
     Annotation,
-    check_all_mask_paths_remote,
     BoxAnnotation,
-    PolygonAnnotation,
-    CuboidAnnotation,
     CategoryAnnotation,
+    CuboidAnnotation,
     MultiCategoryAnnotation,
+    PolygonAnnotation,
     SegmentationAnnotation,
+    check_all_mask_paths_remote,
 )
 from .constants import (
     ANNOTATIONS_KEY,
     AUTOTAG_SCORE_THRESHOLD,
     DEFAULT_ANNOTATION_UPDATE_MODE,
     EXPORTED_ROWS,
+    KEEP_HISTORY_KEY,
     NAME_KEY,
     REFERENCE_IDS_KEY,
     REQUEST_ID_KEY,
     UPDATE_KEY,
-    KEEP_HISTORY_KEY,
 )
 from .data_transfer_object.dataset_info import DatasetInfo
 from .data_transfer_object.dataset_size import DatasetSize

nucleus/dataset_item.py

@@ -1,31 +1,31 @@
-from collections import Counter
 import json
 import os.path
+from collections import Counter
 from dataclasses import dataclass
-from typing import Optional, Sequence, Dict, Any
 from enum import Enum
+from typing import Any, Dict, Optional, Sequence
 
-from .annotation import is_local_path, Point3D
+from .annotation import Point3D, is_local_path
 from .constants import (
+    CAMERA_PARAMS_KEY,
+    CX_KEY,
+    CY_KEY,
+    FX_KEY,
+    FY_KEY,
+    HEADING_KEY,
     IMAGE_URL_KEY,
     METADATA_KEY,
     ORIGINAL_IMAGE_URL_KEY,
-    UPLOAD_TO_SCALE_KEY,
+    POINTCLOUD_URL_KEY,
+    POSITION_KEY,
     REFERENCE_ID_KEY,
     TYPE_KEY,
+    UPLOAD_TO_SCALE_KEY,
     URL_KEY,
-    CAMERA_PARAMS_KEY,
-    POINTCLOUD_URL_KEY,
+    W_KEY,
     X_KEY,
     Y_KEY,
     Z_KEY,
-    W_KEY,
-    POSITION_KEY,
-    HEADING_KEY,
-    FX_KEY,
-    FY_KEY,
-    CX_KEY,
-    CY_KEY,
 )
 
 

nucleus/dataset_item_uploader.py

@@ -2,25 +2,25 @@
 import json
 import os
 import time
-from typing import List, Any, TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, List
 
 import aiohttp
 import nest_asyncio
 
 from .constants import (
     DATASET_ID_KEY,
-    UPDATE_KEY,
-    ITEMS_KEY,
-    IMAGE_URL_KEY,
-    IMAGE_KEY,
     DEFAULT_NETWORK_TIMEOUT_SEC,
+    IMAGE_KEY,
+    IMAGE_URL_KEY,
+    ITEMS_KEY,
+    UPDATE_KEY,
 )
-from .payload_constructor import construct_append_payload
-from .retry_strategy import RetryStrategy
 from .dataset_item import DatasetItem
-from .upload_response import UploadResponse
 from .errors import NotFoundError
 from .logger import logger
+from .payload_constructor import construct_append_payload
+from .retry_strategy import RetryStrategy
+from .upload_response import UploadResponse
 
 if TYPE_CHECKING:
     from . import NucleusClient

nucleus/job.py

@@ -1,7 +1,9 @@
-from dataclasses import dataclass
 import time
+from dataclasses import dataclass
 from typing import Dict, List
+
 import requests
+
 from nucleus.constants import (
     JOB_CREATION_TIME_KEY,
     JOB_ID_KEY,

nucleus/model.py

@@ -1,17 +1,14 @@
-from typing import List, Optional, Dict, Union
+from typing import Dict, List, Optional, Union
+
+from .constants import METADATA_KEY, NAME_KEY, REFERENCE_ID_KEY
 from .dataset import Dataset
+from .model_run import ModelRun
 from .prediction import (
     BoxPrediction,
     CuboidPrediction,
     PolygonPrediction,
     SegmentationPrediction,
 )
-from .model_run import ModelRun
-from .constants import (
-    NAME_KEY,
-    REFERENCE_ID_KEY,
-    METADATA_KEY,
-)
 
 
 class Model:

nucleus/payload_constructor.py

@@ -1,37 +1,38 @@
-from typing import List, Optional, Dict, Union
-from .dataset_item import DatasetItem
-from .scene import LidarScene
+from typing import Dict, List, Optional, Union
+
 from .annotation import (
     BoxAnnotation,
-    CuboidAnnotation,
-    PolygonAnnotation,
     CategoryAnnotation,
+    CuboidAnnotation,
     MultiCategoryAnnotation,
+    PolygonAnnotation,
     SegmentationAnnotation,
 )
-from .prediction import (
-    BoxPrediction,
-    CuboidPrediction,
-    PolygonPrediction,
-    SegmentationPrediction,
-    CategoryPrediction,
-)
 from .constants import (
+    ANNOTATION_METADATA_SCHEMA_KEY,
     ANNOTATION_UPDATE_KEY,
-    NAME_KEY,
-    METADATA_KEY,
-    REFERENCE_ID_KEY,
     ANNOTATIONS_KEY,
     ITEMS_KEY,
-    SCENES_KEY,
-    UPDATE_KEY,
+    LABELS_KEY,
+    METADATA_KEY,
     MODEL_ID_KEY,
-    ANNOTATION_METADATA_SCHEMA_KEY,
+    NAME_KEY,
+    REFERENCE_ID_KEY,
+    SCENES_KEY,
     SEGMENTATIONS_KEY,
     TAXONOMY_NAME_KEY,
     TYPE_KEY,
-    LABELS_KEY,
+    UPDATE_KEY,
 )
+from .dataset_item import DatasetItem
+from .prediction import (
+    BoxPrediction,
+    CategoryPrediction,
+    CuboidPrediction,
+    PolygonPrediction,
+    SegmentationPrediction,
+)
+from .scene import LidarScene
 
 
 def construct_append_payload(

nucleus/prediction.py

@@ -3,40 +3,41 @@
 as annotation types, but come with additional, optional data that can be attached
 such as confidence or probability distributions.
 """
-from typing import Dict, Optional, List
+from typing import Dict, List, Optional
+
 from .annotation import (
     BoxAnnotation,
     CategoryAnnotation,
+    CuboidAnnotation,
     Point,
+    Point3D,
     PolygonAnnotation,
     Segment,
     SegmentationAnnotation,
-    CuboidAnnotation,
-    Point3D,
 )
 from .constants import (
     ANNOTATION_ID_KEY,
+    ANNOTATIONS_KEY,
     BOX_TYPE,
-    CUBOID_TYPE,
-    POLYGON_TYPE,
     CATEGORY_TYPE,
-    REFERENCE_ID_KEY,
-    METADATA_KEY,
+    CLASS_PDF_KEY,
+    CONFIDENCE_KEY,
+    CUBOID_TYPE,
+    DIMENSIONS_KEY,
     GEOMETRY_KEY,
+    HEIGHT_KEY,
     LABEL_KEY,
+    MASK_URL_KEY,
+    METADATA_KEY,
+    POLYGON_TYPE,
+    POSITION_KEY,
+    REFERENCE_ID_KEY,
     TAXONOMY_NAME_KEY,
     TYPE_KEY,
+    VERTICES_KEY,
+    WIDTH_KEY,
     X_KEY,
     Y_KEY,
-    WIDTH_KEY,
-    HEIGHT_KEY,
-    CLASS_PDF_KEY,
-    CONFIDENCE_KEY,
-    VERTICES_KEY,
-    ANNOTATIONS_KEY,
-    MASK_URL_KEY,
-    POSITION_KEY,
-    DIMENSIONS_KEY,
     YAW_KEY,
 )