improve --tags docs, add tests, small utils fix

tchughesiv · tchughesiv · commit d9ccdde9ff9b · 2024-06-17T12:29:33.000-05:00
Signed-off-by: Tommy Hughes &lt;tohughes@redhat.com&gt;
diff --git a/docs/reference/feast-cli-commands.md b/docs/reference/feast-cli-commands.md
@@ -66,6 +66,10 @@ List all registered entities
 
 ```text
 feast entities list
+
+Options:
+  --tags TEXT  Filter by tags (e.g. --tags 'key:value' --tags 'key:value,
+               key:value, ...'). Items return when ALL tags match.
 ```
 
 ```text
@@ -79,11 +83,15 @@ List all registered feature views
 
 ```text
 feast feature-views list
+
+Options:
+  --tags TEXT  Filter by tags (e.g. --tags 'key:value' --tags 'key:value,
+               key:value, ...'). Items return when ALL tags match.
 ```
 
 ```text
-NAME                 ENTITIES
-driver_hourly_stats  ['driver_id']
+NAME                 ENTITIES    TYPE
+driver_hourly_stats  {'driver'}  FeatureView
 ```
 
 ## Init
diff --git a/sdk/python/feast/cli.py b/sdk/python/feast/cli.py
@@ -49,7 +49,7 @@
 _logger = logging.getLogger(__name__)
 tagsOption = click.option(
     "--tags",
-    help="Filter by tags (e.g. 'key:value, key:value, ...')",
+    help="Filter by tags (e.g. --tags 'key:value' --tags 'key:value, key:value, ...'). Items return when ALL tags match.",
     default=[""],
     multiple=True,
 )
diff --git a/sdk/python/feast/utils.py b/sdk/python/feast/utils.py
@@ -278,9 +278,7 @@ def tags_list_to_dict(
 
 
 def tags_str_to_dict(tags: str = "") -> dict[str, str]:
-    tags_list = (
-        str(tags).strip().strip("()").replace('"', "").replace("'", "").split(",")
-    )
+    tags_list = tags.strip().strip("()").replace('"', "").replace("'", "").split(",")
     return {
         key.strip(): value.strip()
         for key, value in dict(
diff --git a/sdk/python/tests/integration/registration/test_universal_registry.py b/sdk/python/tests/integration/registration/test_universal_registry.py
@@ -285,7 +285,7 @@ def test_apply_entity_success(test_registry):
     assert len(project_metadata[0].project_uuid) == 36
     assert_project_uuid(project, project_uuid, test_registry)
 
-    entities = test_registry.list_entities(project)
+    entities = test_registry.list_entities(project, tags=entity.tags)
     assert_project_uuid(project, project_uuid, test_registry)
 
     entity = entities[0]
@@ -359,7 +359,7 @@ def test_apply_feature_view_success(test_registry):
     # Register Feature View
     test_registry.apply_feature_view(fv1, project)
 
-    feature_views = test_registry.list_feature_views(project)
+    feature_views = test_registry.list_feature_views(project, tags=fv1.tags)
 
     # List Feature Views
     assert (
@@ -530,7 +530,7 @@ def test_apply_data_source(test_registry):
     test_registry.apply_data_source(batch_source, project, commit=False)
     test_registry.apply_feature_view(fv1, project, commit=True)
 
-    registry_feature_views = test_registry.list_feature_views(project)
+    registry_feature_views = test_registry.list_feature_views(project, tags=fv1.tags)
     registry_data_sources = test_registry.list_data_sources(project)
     assert len(registry_feature_views) == 1
     assert len(registry_data_sources) == 1
@@ -543,7 +543,7 @@ def test_apply_data_source(test_registry):
     batch_source.timestamp_field = "new_ts_col"
     test_registry.apply_data_source(batch_source, project, commit=False)
     test_registry.apply_feature_view(fv1, project, commit=True)
-    registry_feature_views = test_registry.list_feature_views(project)
+    registry_feature_views = test_registry.list_feature_views(project, tags=fv1.tags)
     registry_data_sources = test_registry.list_data_sources(project)
     assert len(registry_feature_views) == 1
     assert len(registry_data_sources) == 1
@@ -656,7 +656,7 @@ def odfv1(feature_df: pd.DataFrame) -> pd.DataFrame:
     )
 
     # Make sure fv1 is untouched
-    feature_views = test_registry.list_feature_views(project)
+    feature_views = test_registry.list_feature_views(project, tags=fv1.tags)
 
     # List Feature Views
     assert (
@@ -722,6 +722,7 @@ def test_registry_cache(test_registry):
         path="file://feast/*",
         timestamp_field="ts_col",
         created_timestamp_column="timestamp",
+        tags={"team": "matchmaking"},
     )
 
     entity = Entity(name="fs1_my_entity_1", join_keys=["test"])
@@ -758,10 +759,10 @@ def test_registry_cache(test_registry):
     test_registry.refresh(project)
     # Now objects exist
     registry_feature_views_cached = test_registry.list_feature_views(
-        project, allow_cache=True
+        project, allow_cache=True, tags=fv1.tags
     )
     registry_data_sources_cached = test_registry.list_data_sources(
-        project, allow_cache=True
+        project, allow_cache=True, tags=batch_source.tags
     )
     assert len(registry_feature_views_cached) == 1
     assert len(registry_data_sources_cached) == 1
@@ -819,15 +820,17 @@ def simple_udf(x: int):
         mode="spark",
         source=stream_source,
         udf=simple_udf,
-        tags={},
+        tags={"team": "matchmaking"},
     )
 
     project = "project"
 
     # Register Feature View
     test_registry.apply_feature_view(sfv, project)
 
-    stream_feature_views = test_registry.list_stream_feature_views(project)
+    stream_feature_views = test_registry.list_stream_feature_views(
+        project, tags=sfv.tags
+    )
 
     # List Feature Views
     assert len(stream_feature_views) == 1
@@ -864,7 +867,7 @@ def test_commit():
     validate_project_uuid(project_uuid, test_registry)
 
     # Retrieving the entity should still succeed
-    entities = test_registry.list_entities(project, allow_cache=True)
+    entities = test_registry.list_entities(project, allow_cache=True, tags=entity.tags)
     entity = entities[0]
     assert (
         len(entities) == 1
@@ -899,7 +902,7 @@ def test_commit():
     registry_with_same_store = Registry("project", registry_config, None)
 
     # Retrieving the entity should now succeed
-    entities = registry_with_same_store.list_entities(project)
+    entities = registry_with_same_store.list_entities(project, tags=entity.tags)
     entity = entities[0]
     assert (
         len(entities) == 1

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@`
`49`	`49`	`_logger = logging.getLogger(__name__)`
`50`	`50`	`tagsOption = click.option(`
`51`	`51`	`"--tags",`
`52`		`- help="Filter by tags (e.g. 'key:value, key:value, ...')",`
	`52`	`+ help="Filter by tags (e.g. --tags 'key:value' --tags 'key:value, key:value, ...'). Items return when ALL tags match.",`
`53`	`53`	`default=[""],`
`54`	`54`	`multiple=True,`
`55`	`55`	`)`