feat: switch to ruff

Some lint and typing fixes to make ruff and mypy.

Author: gadomski

.github/workflows/continuous-integration.yml

@@ -40,4 +40,4 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           file: ./coverage.xml
-          fail_ci_if_error: false
+          fail_ci_if_error: false

.gitignore

@@ -158,4 +158,3 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
-

.pre-commit-config.yaml

@@ -2,29 +2,31 @@
 # Please run `pre-commit run --all-files` when adding or changing entries.
 
 repos:
-  - repo: https://github.com/psf/black
-    rev: 23.7.0
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
     hooks:
-      - id: black
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.5
+    rev: v2.2.6
     hooks:
       - id: codespell
         args: [--ignore-words=.codespellignore]
         types_or: [jupyter, markdown, python, shell]
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
     hooks:
-      - id: isort
-        args: ["--profile", "black"]
+      - id: black
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.0
+    rev: v1.6.0
     hooks:
       - id: mypy
         additional_dependencies:
           - pytest
           - types-setuptools == 65.7.0.3
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.292
+    hooks:
+      - id: ruff

LICENSE

@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -22,10 +22,10 @@ class MyTask(Task):
 
     def process(self, **kwargs: Any) -> List[Dict[str, Any]]:
         item = self.items[0]
-        
+
         # download a datafile
         item = self.download_item_assets(item, assets=['data'])
-        
+
         # operate on the local file to create a new asset
         item = self.upload_item_assets_to_s3(item)
 

pyproject.toml

@@ -2,6 +2,7 @@
 name = "stactask"
 version = "0.1.1"
 authors = [{ name = "Matthew Hanson", email = "[email protected]" }]
+maintainers = [{ name = "Pete Gadomski", email = "[email protected]" }]
 description = "Class interface for running custom algorithms and workflows on STAC Items"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -32,12 +33,11 @@ dependencies = [
 dev = [
     "black~=23.9.1",
     "codespell~=2.2.5",
-    "flake8~=6.1.0",
-    "isort~=5.12.0",
     "mypy~=1.5.0",
     "pre-commit~=3.4.0",
-    "pytest~=7.4.0",
     "pytest-cov~=4.1.0",
+    "pytest~=7.4.0",
+    "ruff==0.0.292",
     "types-setuptools~=68.2.0",
 ]
 
@@ -52,3 +52,6 @@ strict = true
 [[tool.mypy.overrides]]
 module = ["boto3utils", "jsonpath_ng.ext", "fsspec"]
 ignore_missing_imports = true
+
+[tool.ruff]
+select = ["F", "E", "W", "I", "ERA", "RUF"]

scripts/test

@@ -29,4 +29,4 @@ if [ "${BASH_SOURCE[0]}" = "${0}" ]; then
         pytest --cov=stactask tests
         coverage xml
     fi
-fi
+fi

stactask/asset_io.py

@@ -118,7 +118,7 @@ def upload_item_assets_to_s3(
     if public_assets is None:
         public_assets = []
     # determine which assets should be public
-    elif type(public_assets) is str:
+    elif isinstance(public_assets, str):
         if public_assets == "ALL":
             public_assets = list(_item["assets"].keys())
         else:

stactask/task.py

@@ -95,7 +95,11 @@ def __del__(self) -> None:
 
     @property
     def process_definition(self) -> Dict[str, Any]:
-        return self._payload.get("process", {})
+        process = self._payload.get("process", {})
+        if isinstance(process, dict):
+            return process
+        else:
+            raise ValueError(f"process is not a dict: {type(process)}")
 
     @property
     def parameters(self) -> Dict[str, Any]:
@@ -111,19 +115,37 @@ def parameters(self) -> Dict[str, Any]:
                 return {}
             else:
                 task_config: Dict[str, Any] = task_config_list[0]
-                return task_config.get("parameters", {})
+                parameters = task_config.get("parameters", {})
+                if isinstance(parameters, dict):
+                    return parameters
+                else:
+                    raise ValueError(f"parameters is not a dict: {type(parameters)}")
         elif isinstance(task_configs, Dict):
-            return task_configs.get(self.name, {})
+            config = task_configs.get(self.name, {})
+            if isinstance(config, dict):
+                return config
+            else:
+                raise ValueError(
+                    f"task config for {self.name} is not a dict: {type(config)}"
+                )
         else:
             raise ValueError(f"unexpected value for 'tasks': {task_configs}")
 
     @property
     def upload_options(self) -> Dict[str, Any]:
-        return self.process_definition.get("upload_options", {})
+        upload_options = self.process_definition.get("upload_options", {})
+        if isinstance(upload_options, dict):
+            return upload_options
+        else:
+            raise ValueError(f"upload_options is not a dict: {type(upload_options)}")
 
     @property
     def items_as_dicts(self) -> List[Dict[str, Any]]:
-        return self._payload.get("features", [])
+        features = self._payload.get("features", [])
+        if isinstance(features, list):
+            return features
+        else:
+            raise ValueError(f"features is not a list: {type(features)}")
 
     @property
     def items(self) -> ItemCollection:
@@ -251,9 +273,7 @@ def process(self, **kwargs: Any) -> List[Dict[str, Any]]:
             [type]: [description]
         """
         # download assets of interest, this will update self.items
-        # self.download_assets(['key1', 'key2'])
         # do some stuff
-        # self.upload_assets(['key1', 'key2'])
         pass
 
     def post_process_item(self, item: Dict[str, Any]) -> Dict[str, Any]:

tests/fixtures/sentinel2-l2a-j2k-payload.json

@@ -1595,4 +1595,4 @@
             "collection": "sentinel-2-l2a"
         }
     ]
-}
+}

tests/test_task.py

@@ -10,9 +10,6 @@
 
 from .tasks import DerivedItemTask, FailValidateTask, NothingTask
 
-# import vcr
-
-
 testpath = Path(__file__).parent
 cassettepath = testpath / "fixtures" / "cassettes"
 
@@ -115,16 +112,16 @@ def test_derived_item(derived_item_task: Task) -> None:
     items = derived_item_task.process(**derived_item_task.parameters)
     links = [lk for lk in items[0]["links"] if lk["rel"] == "derived_from"]
     assert len(links) == 1
-    self_link = [lk for lk in items[0]["links"] if lk["rel"] == "self"][0]
+    self_link = next(lk for lk in items[0]["links"] if lk["rel"] == "self")
     assert links[0]["href"] == self_link["href"]
 
 
 def test_task_handler(items: Dict[str, Any]) -> None:
-    self_link = [lk for lk in items["features"][0]["links"] if lk["rel"] == "self"][0]
+    self_link = next(lk for lk in items["features"][0]["links"] if lk["rel"] == "self")
     output_items = DerivedItemTask.handler(items)
-    derived_link = [
+    derived_link = next(
         lk for lk in output_items["features"][0]["links"] if lk["rel"] == "derived_from"
-    ][0]
+    )
     assert derived_link["href"] == self_link["href"]
     assert (
         "derived-item-task"

tests/test_task_download.py

@@ -80,6 +80,4 @@ def test_download_large_asset(tmp_path: Path, item_collection: Dict[str, Any]) -
     ).to_dict()
     filename = Path(item["assets"]["red"]["href"])
     assert filename.is_file() is True
-    # t._save_workdir = False
     del t
-    # assert (filename.is_file() is False)