Add import guards for new extras (#314)

* Add test for installs without extras

* Change first installation step

* Guard fsspec in seg to poly functions

* Update lock file

* Roll back changes to circleci job

* Bump and changelog

Author: gatli

.circleci/config.yml

@@ -15,14 +15,21 @@ jobs:
     steps:
       - checkout # checkout source code to working directory
       - run:
-          name: Install Environment Dependencies
+          name: Install Basic Environment Dependencies
           command: | # install dependencies
             apt-get update
             apt-get -y install curl libgeos-dev
             pip install --upgrade pip
             pip install poetry
-            poetry install -E metrics
-
+            poetry install
+      - run:
+          name: Test Imports (extras need to be guarded!)
+          command: | # Make sure that importing works without extras installed
+            poetry run python -c 'import nucleus'
+      - run:
+          name: Install Extra Dependencies
+          command: | # install dependencies
+            poetry install -E metrics -E launch
       - run:
           name: Black Formatting Check # Only validation, without re-formatting
           command: |

CHANGELOG.md

@@ -5,7 +5,12 @@ All notable changes to the [Nucleus Python Client](https://github.com/scaleapi/n
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.13.3](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.13.3) - 2022-06-08
+## [0.13.4](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.13.4) - 2022-06-09
+
+### Fixed
+- Guard against extras imports 
+
+## [0.13.3](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.13.3) - 2022-06-09
 
 ### Fixed
 - Make installation of scale-launch optional (again!).

nucleus/metrics/segmentation_metrics.py

@@ -1,10 +1,17 @@
 import abc
 from typing import List, Optional, Union
 
-import fsspec
 import numpy as np
 from PIL import Image
-from s3fs import S3FileSystem
+
+try:
+    import fsspec
+    from s3fs import S3FileSystem
+except ModuleNotFoundError:
+    from ..package_not_installed import PackageNotInstalled
+
+    S3FileSystem = PackageNotInstalled
+    fsspec = PackageNotInstalled
 
 from nucleus.annotation import AnnotationList, SegmentationAnnotation
 from nucleus.metrics.base import MetricResult

nucleus/metrics/segmentation_to_poly_metrics.py

@@ -1,10 +1,8 @@
 import abc
 from typing import List, Optional, Union
 
-import fsspec
 import numpy as np
 from PIL import Image
-from s3fs import S3FileSystem
 
 from nucleus.annotation import AnnotationList
 from nucleus.metrics.base import MetricResult
@@ -15,6 +13,15 @@
 )
 from nucleus.prediction import PredictionList
 
+try:
+    import fsspec
+    from s3fs import S3FileSystem
+except ModuleNotFoundError:
+    from ..package_not_installed import PackageNotInstalled
+
+    S3FileSystem = PackageNotInstalled
+    fsspec = PackageNotInstalled
+
 from .base import Metric, ScalarResult
 from .polygon_metrics import (
     PolygonAveragePrecision,

poetry.lock

@@ -21,7 +21,7 @@ exclude = '''
 
 [tool.poetry]
 name = "scale-nucleus"
-version = "0.13.3"
+version = "0.13.4"
 description = "The official Python client library for Nucleus, the Data Platform for AI"
 license =  "MIT"
 authors = ["Scale AI Nucleus Team <nucleusapi@scaleapi.com>"]