Rename Link.properties to Link.extra_fields

Author: duckontheweb

pystac/extensions/label.py

@@ -619,15 +619,15 @@ def add_source(
             assets : Optional list of assets that determine what
                 assets in the source item this label item data applies to.
         """
-        properties = None
+        extra_fields = None
         if assets is not None:
-            properties = {"label:assets": assets}
+            extra_fields = {"label:assets": assets}
         link = pystac.Link(
             "source",
             source_item,
             title=title,
             media_type=pystac.MediaType.JSON,
-            properties=properties,
+            extra_fields=extra_fields,
         )
         self.obj.add_link(link)
 

pystac/link.py

@@ -43,7 +43,7 @@ class Link:
         media_type : Optional description of the media type. Registered Media Types
             are preferred. See :class:`~pystac.MediaType` for common media types.
         title : Optional title for this link.
-        properties : Optional, additional properties for this link. This is used
+        extra_fields : Optional, additional fields for this link. This is used
             by extensions as a way to serialize and deserialize properties on link
             object JSON.
     """
@@ -64,8 +64,8 @@ class Link:
     title: Optional[str]
     """Optional title for this link."""
 
-    properties: Optional[Dict[str, Any]]
-    """Optional, additional properties for this link. This is used by extensions as a
+    extra_fields: Dict[str, Any]
+    """Optional, additional fields for this link. This is used by extensions as a
     way to serialize and deserialize properties on link object JSON."""
 
     owner: Optional["STACObject_Type"]
@@ -79,13 +79,13 @@ def __init__(
         target: Union[str, "STACObject_Type"],
         media_type: Optional[str] = None,
         title: Optional[str] = None,
-        properties: Optional[Dict[str, Any]] = None,
+        extra_fields: Optional[Dict[str, Any]] = None,
     ) -> None:
         self.rel = rel
         self.target = target
         self.media_type = media_type
         self.title = title
-        self.properties = properties
+        self.extra_fields = extra_fields or {}
         self.owner = None
 
     def set_owner(self, owner: Optional["STACObject_Type"]) -> "Link":
@@ -260,9 +260,8 @@ def to_dict(self) -> Dict[str, Any]:
         if self.title is not None:
             d["title"] = self.title
 
-        if self.properties:
-            for k, v in self.properties.items():
-                d[k] = v
+        for k, v in self.extra_fields.items():
+            d[k] = v
 
         return d
 
@@ -299,16 +298,16 @@ def from_dict(d: Dict[str, Any]) -> "Link":
         media_type = d.pop("type", None)
         title = d.pop("title", None)
 
-        properties = None
+        extra_fields = None
         if any(d):
-            properties = d
+            extra_fields = d
 
         return Link(
             rel=rel,
             target=href,
             media_type=media_type,
             title=title,
-            properties=properties,
+            extra_fields=extra_fields,
         )
 
     @staticmethod

tests/test_link.py

@@ -58,7 +58,7 @@ def test_relative(self) -> None:
         rel = "my rel"
         target = "../elsewhere"
         mime_type = "example/stac_thing"
-        link = pystac.Link(rel, target, mime_type, "a title", properties={"a": "b"})
+        link = pystac.Link(rel, target, mime_type, "a title", extra_fields={"a": "b"})
         expected_dict = {
             "rel": rel,
             "href": target,