DOC-1904: Add and update deprecation decorators (#764)

* DOC-1904: Add and update deprecation decorators

Add and update deprecation decorators. The migration guide is being updated here: up42/documentation-hub#1953

* Update utils.py

* Update punctuation for the decorator

* Apply Black

* Update asset, catalog, tasking

* Added deprecation after the Catalog class definition is complete

* Update catalog.py

* Update catalog.py

* Update tasking.py

* Update asset.py

* Update asset.py

* Update asset.py

* simplify asset.py

* Remove Type

* Update test_storage to keep only fixed lists

* Remove deprecation on classes and restore test_storage

* Update catalog.py

* Update catalog.py

* Revert base and webhooks

Author: dustgalactic

up42/asset.py

@@ -182,7 +182,7 @@ def _get_download_url(self, asset_id: str) -> str:
         return self.session.post(url=url).json()["url"]
 
     @property
-    @utils.deprecation("pystac::Asset.file", "3.0.0")
+    @utils.deprecation(None, "3.0.0")
     def file(self) -> utils.ImageFile:
         return utils.ImageFile(url=self._get_download_url(self.asset_id))
 

up42/initialization.py

@@ -31,7 +31,7 @@ def initialize_storage() -> storage.Storage:
     return storage.Storage()
 
 
-@utils.deprecation("Order::get", "3.0.0")
+@utils.deprecation(None, "3.0.0")
 def initialize_order(order_id: str) -> order.Order:
     """
     Returns an Order object (has to exist on UP42).
@@ -43,7 +43,7 @@ def initialize_order(order_id: str) -> order.Order:
     return up42_order
 
 
-@utils.deprecation("Asset::get", "3.0.0")
+@utils.deprecation(None, "3.0.0")
 def initialize_asset(asset_id: str) -> asset.Asset:
     """
     Returns an Asset object (has to exist on UP42).

up42/order.py

@@ -212,7 +212,7 @@ def is_fulfilled(self) -> bool:
         """
         return self.status == "FULFILLED"
 
-    @utils.deprecation(None, "3.0.0")
+    @utils.deprecation("pystac::Client.search", "3.0.0")
     def get_assets(self) -> List[asset.Asset]:
         """
         Gets the Order assets or results.

up42/storage.py

@@ -40,7 +40,7 @@ class Storage:
     workspace_id = base.WorkspaceId()
     pystac_client = base.StacClient()
 
-    @utils.deprecation("Asset::all", "3.0.0")
+    @utils.deprecation("pystac::Client.search", "3.0.0")
     def get_assets(
         self,
         created_after: Optional[Union[str, dt.datetime]] = None,

up42/utils.py

@@ -82,14 +82,13 @@ def deprecation(
     Args:
         replacement_name: Name of the replacement function.
         version: The breaking package version
-        extra_message: Optional message after default deprecation warning.
     """
 
     def actual_decorator(func):
         @functools.wraps(func)
         def wrapper(*args, **kwargs):
-            replace_with = f", use `{replacement_name}` instead" if replacement_name else ""
-            message = f"`{func.__name__}` is deprecated and will be dropped in version {version}{replace_with}."
+            replace_with = f" Use `{replacement_name}` instead." if replacement_name else ""
+            message = f"`{func.__name__}` is deprecated and will be removed in version {version}{replace_with}."
             warnings.warn(message, DeprecationWarning, stacklevel=2)
             return func(*args, **kwargs)