Merge pull request #156 from stac-utils/feature/add-optional-dependencies

add request and jsonschema optional dependencies

Author: vincentsarago

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Unreleased
 
 - Cache remote JSON schemas for extensions (#155, @avbentem)
+- add `requests` and `jsonschema` in a **validation** optional dependencies (#156, @vincentsarago)
 
 ## 3.1.0 (2024-05-21)
 

README.md

@@ -12,6 +12,10 @@ For more comprehensive schema validation and robust extension support, use [pyst
 
 ```shell
 python -m pip install stac-pydantic
+
+# or
+
+python -m pip install stac-pydantic["validation"]
 ```
 
 For local development:

pyproject.toml

@@ -20,7 +20,11 @@ keywords=["stac", "pydantic", "validation"]
 authors=[{ name = "Arturo Engineering", email = "engineering@arturo.ai"}]
 license= { text = "MIT" }
 requires-python=">=3.8"
-dependencies = ["click>=8.1.7", "pydantic>=2.4.1", "geojson-pydantic>=1.0.0"]
+dependencies = [
+        "click>=8.1.7",
+        "pydantic>=2.4.1",
+        "geojson-pydantic>=1.0.0",
+]
 dynamic = ["version", "readme"]
 
 [project.scripts]
@@ -31,6 +35,8 @@ homepage = "https://github.com/stac-utils/stac-pydantic"
 repository ="https://github.com/stac-utils/stac-pydantic.git"
 
 [project.optional-dependencies]
+validation = ["jsonschema>=4.19.1", "requests>=2.31.0"]
+
 dev = [
         "pytest>=7.4.2",
         "pytest-cov>=4.1.0",

stac_pydantic/extensions.py

@@ -1,14 +1,20 @@
-import json
 from functools import lru_cache
 from typing import Any, Dict, Union
 
-import jsonschema
-import requests
-
 from stac_pydantic.catalog import Catalog
 from stac_pydantic.collection import Collection
 from stac_pydantic.item import Item
 
+try:
+    import requests
+except ImportError:  # pragma: nocover
+    requests = None  # type: ignore
+
+try:
+    import jsonschema
+except ImportError:  # pragma: nocover
+    jsonschema = None  # type: ignore
+
 
 @lru_cache(maxsize=128)
 def _fetch_and_cache_schema(url: str) -> dict:
@@ -25,12 +31,13 @@ def validate_extensions(
     Fetch the remote JSON schema, if not already cached, and validate the STAC
     object against that schema.
     """
+    assert requests is not None, "requests must be installed to validate extensions"
+    assert jsonschema is not None, "jsonschema must be installed to validate extensions"
+
     if isinstance(stac_obj, dict):
         stac_dict = stac_obj
     else:
-        # can't use `stac_obj.model_dump()` here
-        # b/c jsonschema expects pure string representations, not python types
-        stac_dict = json.loads(stac_obj.model_dump_json())
+        stac_dict = stac_obj.model_dump(mode="json")
 
     try:
         if stac_dict["stac_extensions"]:

stac_pydantic/scripts/cli.py

@@ -5,6 +5,16 @@
 from stac_pydantic.extensions import validate_extensions
 from stac_pydantic.item import Item
 
+try:
+    import requests
+except ImportError:  # pragma: nocover
+    requests = None  # type: ignore
+
+try:
+    import jsonschema
+except ImportError:  # pragma: nocover
+    jsonschema = None  # type: ignore
+
 
 @click.group(short_help="Validate STAC")
 def app() -> None:
@@ -16,14 +26,19 @@ def app() -> None:
 @click.argument("infile")
 def validate_item(infile: str) -> None:
     """Validate stac item"""
+    assert requests is not None, "requests must be installed to validate items"
+    assert jsonschema is not None, "jsonschema must be installed to validate items"
+
     r = requests.get(infile)
     r.raise_for_status()
+
     stac_item = r.json()
     try:
-        item = Item(**stac_item)
+        item = Item.model_validate(stac_item)
         validate_extensions(item, reraise_exception=True)
     except ValidationError as e:
         click.echo(str(e))
         return
+
     click.echo(f"{infile} is valid")
     return