🗝️ Add KeyPresent queries

docs/source/reference/queries.md

@@ -19,7 +19,7 @@ Follow the links in the table below for examples specific to each query.
    tiled.queries.Eq
    tiled.queries.NotEq
    tiled.queries.FullText
-   tiled.queries.KeyExists
+   tiled.queries.KeyPresent
    tiled.queries.In
    tiled.queries.Like
    tiled.queries.NotIn

tiled/_tests/test_queries.py

@@ -20,7 +20,7 @@
     FullText,
     In,
     Key,
-    KeyExists,
+    KeyPresent,
     KeysFilter,
     Like,
     NotEq,
@@ -327,16 +327,16 @@ def test_structure_families(client):
     assert set(client.search(StructureFamilyQuery("array"))) == set(mapping)
 
 
-def test_key_exists(client):
+def test_key_present(client):
     if client.metadata["backend"] == "map":
-        pytest.skip("No 'KeyExists' support on MapAdapter")
+        pytest.skip("No 'KeyPresent' support on MapAdapter")
     # These containers have a "color" key.
-    assert list(client.search(KeyExists("color"))) == [
+    assert list(client.search(KeyPresent("color"))) == [
         "full_text_test_case",
         "full_text_test_case_urple",
     ]
     # These are all the containers that do not have a "number" key.
-    assert list(client.search(KeyExists("number", False))) == [
+    assert list(client.search(KeyPresent("number", False))) == [
         "does_contain_z",
         "does_not_contain_z",
         "full_text_test_case",

tiled/adapters/mapping.py

@@ -28,7 +28,7 @@
     Eq,
     FullText,
     In,
-    KeyExists,
+    KeyPresent,
     KeysFilter,
     NotEq,
     NotIn,
@@ -754,7 +754,7 @@ def notin(query: Any, tree: MapAdapter) -> MapAdapter:
 MapAdapter.register_query(NotIn, notin)
 
 
-def keyexists(query: Any, tree: MapAdapter) -> MapAdapter:
+def keypresent(query: Any, tree: MapAdapter) -> MapAdapter:
     """
 
     Parameters
@@ -773,7 +773,7 @@ def keyexists(query: Any, tree: MapAdapter) -> MapAdapter:
     return tree.new_variation(mapping=matches)
 
 
-MapAdapter.register_query(KeyExists, keyexists)
+MapAdapter.register_query(KeyPresent, keypresent)
 
 
 def specs(query: Any, tree: MapAdapter) -> MapAdapter:

tiled/catalog/adapter.py

@@ -50,7 +50,7 @@
     Eq,
     FullText,
     In,
-    KeyExists,
+    KeyPresent,
     KeysFilter,
     Like,
     NotEq,
@@ -1462,7 +1462,7 @@ def structure_family(query, tree):
 CatalogNodeAdapter.register_query(Contains, contains)
 CatalogNodeAdapter.register_query(In, partial(in_or_not_in, method="in_"))
 CatalogNodeAdapter.register_query(NotIn, partial(in_or_not_in, method="not_in"))
-CatalogNodeAdapter.register_query(KeyExists, has_key)
+CatalogNodeAdapter.register_query(KeyPresent, has_key)
 CatalogNodeAdapter.register_query(KeysFilter, keys_filter)
 CatalogNodeAdapter.register_query(StructureFamilyQuery, structure_family)
 CatalogNodeAdapter.register_query(SpecsQuery, specs)

tiled/queries.py

@@ -374,9 +374,9 @@ def decode(cls, *, key, value):
         return cls(key=key, value=json.loads(value))
 
 
-@register(name="keyexists")
+@register(name="keypresent")
 @dataclass
-class KeyExists:
+class KeyPresent:
     """
     Query to retrieve containers that have a specific key at any level.
 
@@ -391,11 +391,11 @@ class KeyExists:
 
     Search for containers that have the key "color"
 
-    >>> c.search(KeyExists("color"))
+    >>> c.search(KeyPresent("color"))
 
     Search for containers that do not have the key "sample.name"
 
-    >>> c.search(KeyExists("sample.name", exists=False))
+    >>> c.search(KeyPresent("sample.name", exists=False))
     """
 
     key: str