Feature/sign inplace (#42)

* Added signing inplace

* Added sign_inplace

Author: Tom Augspurger

CHANGELOG.md

@@ -5,6 +5,7 @@
 * `sign` now supports signing URLs that have already been signed.
 * `sign` now supports signing raw JSON objects, in addition to `pystac` objects.
 * `sign` now supports signing `Collection` objects.
+* Added a `sign_inplace` method for signing by directly mutating objects, rather than copying.
 
 # 0.4.6
 
@@ -69,4 +70,4 @@
 [gh-25]: https://github.com/microsoft/planetary-computer-sdk-for-python/issues/25
 [gh-30]: https://github.com/microsoft/planetary-computer-sdk-for-python/pull/30
 [xarray-assets]: https://github.com/stac-extensions/xarray-assets
-[kerchunk]: https://fsspec.github.io/kerchunk/
+[kerchunk]: https://fsspec.github.io/kerchunk/

planetary_computer/__init__.py

@@ -3,6 +3,7 @@
 
 from planetary_computer.sas import (
     sign,
+    sign_inplace,
     sign_url,
     sign_item,
     sign_assets,

planetary_computer/sas.py

@@ -86,6 +86,15 @@ def sign(obj: Any, copy: bool = True) -> Any:
     )
 
 
+def sign_inplace(obj: Any) -> Any:
+    """
+    Sign the object in place.
+
+    See :func:`planetary_computer.sign` for more.
+    """
+    return sign(obj, copy=False)
+
+
 @sign.register(str)
 def sign_string(url: str, copy: bool = True) -> str:
     """Sign a URL or VRT-like string containing URLs with a Shared Access (SAS) Token

tests/test_signing.py

@@ -316,6 +316,12 @@ def test_sign_collection_dict(self) -> None:
             result["assets"]["zarr-abfs"]["xarray:open_kwargs"]["storage_options"],
         )
 
+    def test_sign_inplace(self) -> None:
+        item = get_sample_item()
+        result = pc.sign_inplace(item)
+        self.assertIs(result, item)
+        self.assertSigned(result.assets["image"].href)
+
 
 class TestUtils(unittest.TestCase):
     def test_parse_adlfs_url(self) -> None: