Support InstrumentedField in queries and aggregations

Author: miguelgrinberg

elasticsearch_dsl/utils.py

@@ -311,8 +311,12 @@ def __init__(self, _expand__to_dot: Optional[bool] = None, **params: Any) -> Non
             _expand__to_dot = EXPAND__TO_DOT
         self._params: Dict[str, Any] = {}
         for pname, pvalue in params.items():
+            # expand "__" to dots
             if "__" in pname and _expand__to_dot:
                 pname = pname.replace("__", ".")
+            # convert instrumented fields to string
+            if type(pvalue).__name__ == "InstrumentedField":
+                pvalue = str(pvalue)
             self._setattr(pname, pvalue)
 
     def _repr_params(self) -> str:

tests/_async/test_document.py

@@ -776,7 +776,11 @@ class TypedDoc(AsyncDocument):
     }
 
     s = TypedDoc.search().sort(TypedDoc.st, -TypedDoc.dt, +TypedDoc.ob.st)
-    assert s.to_dict() == {"sort": ["st", {"dt": {"order": "desc"}}, "ob.st"]}
+    s.aggs.bucket("terms_agg", "terms", field=TypedDoc.k1)
+    assert s.to_dict() == {
+        "aggs": {"terms_agg": {"terms": {"field": "k1"}}},
+        "sort": ["st", {"dt": {"order": "desc"}}, "ob.st"],
+    }
 
 
 def test_instrumented_field() -> None:

tests/_sync/test_document.py

@@ -776,7 +776,11 @@ class TypedDoc(Document):
     }
 
     s = TypedDoc.search().sort(TypedDoc.st, -TypedDoc.dt, +TypedDoc.ob.st)
-    assert s.to_dict() == {"sort": ["st", {"dt": {"order": "desc"}}, "ob.st"]}
+    s.aggs.bucket("terms_agg", "terms", field=TypedDoc.k1)
+    assert s.to_dict() == {
+        "aggs": {"terms_agg": {"terms": {"field": "k1"}}},
+        "sort": ["st", {"dt": {"order": "desc"}}, "ob.st"],
+    }
 
 
 def test_instrumented_field() -> None: