Add option to exclude DSL class field from mapping

Author: miguelgrinberg

elasticsearch/dsl/document_base.py

@@ -418,6 +418,9 @@ def __init__(self, name: str, bases: Tuple[type, ...], attrs: Dict[str, Any]):
                     # the mapped_field() wrapper function was used so we need
                     # to look for the field instance and also record any
                     # dataclass-style defaults
+                    if attr_value.get("exclude"):
+                        # skip this field
+                        continue
                     attr_value = attrs[name].get("_field")
                     default_value = attrs[name].get("default") or attrs[name].get(
                         "default_factory"
@@ -515,6 +518,7 @@ def mapped_field(
     init: bool = True,
     default: Any = None,
     default_factory: Optional[Callable[[], Any]] = None,
+    exclude: bool = False,
     **kwargs: Any,
 ) -> Any:
     """Construct a field using dataclass behaviors
@@ -524,20 +528,23 @@ def mapped_field(
     options.
 
     :param field: The instance of ``Field`` to use for this field. If not provided,
-    an instance that is appropriate for the type given to the field is used.
+        an instance that is appropriate for the type given to the field is used.
     :param init: a value of ``True`` adds this field to the constructor, and a
-    value of ``False`` omits it from it. The default is ``True``.
+        value of ``False`` omits it from it. The default is ``True``.
     :param default: a default value to use for this field when one is not provided
-    explicitly.
+        explicitly.
     :param default_factory: a callable that returns a default value for the field,
-    when one isn't provided explicitly. Only one of ``factory`` and
-    ``default_factory`` can be used.
+        when one isn't provided explicitly. Only one of ``factory`` and
+        ``default_factory`` can be used.
+    :param exclude: Set to ``True`` to exclude this field from the Elasticsearch
+        index.
     """
     return _FieldMetadataDict(
         _field=field,
         init=init,
         default=default,
         default_factory=default_factory,
+        exclude=exclude,
         **kwargs,
     )
 

test_elasticsearch/test_dsl/_async/test_document.py

@@ -678,6 +678,7 @@ class TypedDoc(AsyncDocument):
         )
         i1: ClassVar
         i2: ClassVar[int]
+        i3: str = mapped_field(exclude=True)
 
     class TypedDocAnnotated(AsyncDocument):
         st: Annotated[str, "foo"]
@@ -705,6 +706,7 @@ class TypedDocAnnotated(AsyncDocument):
         else:
             i1: ClassVar
             i2: ClassVar[int]
+        i3: Annotated[str, mapped_field(exclude=True)]
 
     for doc_class in [TypedDoc, TypedDocAnnotated]:
         props = doc_class._doc_type.mapping.to_dict()["properties"]
@@ -741,6 +743,7 @@ class TypedDocAnnotated(AsyncDocument):
 
         doc_class.i1 = "foo"
         doc_class.i2 = 123
+        doc_class.i3 = "bar"
 
         doc = doc_class()
         assert doc.k3 == "foo"
@@ -759,6 +762,7 @@ class TypedDocAnnotated(AsyncDocument):
 
         assert doc_class.i1 == "foo"
         assert doc_class.i2 == 123
+        assert doc_class.i3 == "bar"
 
         doc.st = "s"
         doc.li = [1, 2, 3]

test_elasticsearch/test_dsl/_sync/test_document.py

@@ -678,6 +678,7 @@ class TypedDoc(Document):
         )
         i1: ClassVar
         i2: ClassVar[int]
+        i3: str = mapped_field(exclude=True)
 
     class TypedDocAnnotated(Document):
         st: Annotated[str, "foo"]
@@ -705,6 +706,7 @@ class TypedDocAnnotated(Document):
         else:
             i1: ClassVar
             i2: ClassVar[int]
+        i3: Annotated[str, mapped_field(exclude=True)]
 
     for doc_class in [TypedDoc, TypedDocAnnotated]:
         props = doc_class._doc_type.mapping.to_dict()["properties"]
@@ -741,6 +743,7 @@ class TypedDocAnnotated(Document):
 
         doc_class.i1 = "foo"
         doc_class.i2 = 123
+        doc_class.i3 = "bar"
 
         doc = doc_class()
         assert doc.k3 == "foo"
@@ -759,6 +762,7 @@ class TypedDocAnnotated(Document):
 
         assert doc_class.i1 == "foo"
         assert doc_class.i2 == 123
+        assert doc_class.i3 == "bar"
 
         doc.st = "s"
         doc.li = [1, 2, 3]