Add a description field the Feature Service class and proto (#1771)

achals · web-flow · commit 8ef205378166 · 2021-08-09T15:11:58.000-07:00
* Add a description field the Feature Service class and proto

Signed-off-by: Achal Shah &lt;achals@gmail.com&gt;

* proto3

Signed-off-by: Achal Shah &lt;achals@gmail.com&gt;

* tests

Signed-off-by: Achal Shah &lt;achals@gmail.com&gt;

* make format

Signed-off-by: Achal Shah &lt;achals@gmail.com&gt;
diff --git a/protos/feast/core/FeatureService.proto b/protos/feast/core/FeatureService.proto
@@ -29,6 +29,9 @@ message FeatureServiceSpec {
 
   // User defined metadata
   map<string,string> tags = 4;
+
+  // Description of the feature service.
+  string description = 5;
 }
 
 
diff --git a/sdk/python/feast/feature_service.py b/sdk/python/feast/feature_service.py
@@ -31,6 +31,7 @@ class FeatureService:
     name: str
     features: List[FeatureViewProjection]
     tags: Dict[str, str]
+    description: Optional[str] = None
     created_timestamp: Optional[datetime] = None
     last_updated_timestamp: Optional[datetime] = None
 
@@ -39,6 +40,7 @@ def __init__(
         name: str,
         features: List[Union[FeatureTable, FeatureView, FeatureViewProjection]],
         tags: Optional[Dict[str, str]] = None,
+        description: Optional[str] = None,
     ):
         """
         Creates a FeatureService object.
@@ -56,6 +58,7 @@ def __init__(
             else:
                 raise ValueError(f"Unexpected type: {type(feature)}")
         self.tags = tags or {}
+        self.description = description
         self.created_timestamp = None
         self.last_updated_timestamp = None
 
@@ -97,6 +100,11 @@ def from_proto(feature_service_proto: FeatureServiceProto):
                 for fp in feature_service_proto.spec.features
             ],
             tags=dict(feature_service_proto.spec.tags),
+            description=(
+                feature_service_proto.spec.description
+                if feature_service_proto.spec.description != ""
+                else None
+            ),
         )
 
         if feature_service_proto.meta.HasField("created_timestamp"):
@@ -137,6 +145,8 @@ def to_proto(self) -> FeatureServiceProto:
 
         if self.tags:
             spec.tags.update(self.tags)
+        if self.description:
+            spec.description = self.description
 
         feature_service_proto = FeatureServiceProto(spec=spec, meta=meta)
         return feature_service_proto
diff --git a/sdk/python/tests/unit/test_feature_service.py b/sdk/python/tests/unit/test_feature_service.py
@@ -0,0 +1,14 @@
+from feast import FeatureService
+
+
+def test_feature_service_with_description():
+    feature_service = FeatureService(
+        name="my-feature-service", features=[], description="a clear description"
+    )
+    assert feature_service.to_proto().spec.description == "a clear description"
+
+
+def test_feature_service_without_description():
+    feature_service = FeatureService(name="my-feature-service", features=[])
+    #
+    assert feature_service.to_proto().spec.description == ""

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@ message FeatureServiceSpec {`
`29`	`29`
`30`	`30`	`// User defined metadata`
`31`	`31`	`map<string,string> tags = 4;`
	`32`	`+`
	`33`	`+ // Description of the feature service.`
	`34`	`+ string description = 5;`
`32`	`35`	`}`
`33`	`36`
`34`	`37`