Fixed deprecation - "field [exclude] used, expected [excludes] instead"

Author: ArtemBernatskyy

docs/search_dsl.rst

@@ -462,7 +462,7 @@ If you need to limit the fields being returned by elasticsearch, use the
   # don't return any fields, just the metadata
   s = s.source(False)
   # explicitly include/exclude fields
-  s = s.source(include=["title"], exclude=["user.*"])
+  s = s.source(includes=["title"], excludes=["user.*"])
   # reset the field selection
   s = s.source(None)
 

elasticsearch_dsl/search.py

@@ -478,19 +478,19 @@ def source(self, fields=None, **kwargs):
         :arg fields: wildcard string, array of wildcards, or dictionary of includes and excludes
 
         If ``fields`` is None, the entire document will be returned for
-        each hit.  If fields is a dictionary with keys of 'include' and/or
-        'exclude' the fields will be either included or excluded appropriately.
+        each hit.  If fields is a dictionary with keys of 'includes' and/or
+        'excludes' the fields will be either included or excluded appropriately.
 
         Calling this multiple times with the same named parameter will override the
         previous values with the new ones.
 
         Example::
 
             s = Search()
-            s = s.source(include=['obj1.*'], exclude=["*.description"])
+            s = s.source(includes=['obj1.*'], excludes=["*.description"])
 
             s = Search()
-            s = s.source(include=['obj1.*']).source(exclude=["*.description"])
+            s = s.source(includes=['obj1.*']).source(excludes=["*.description"])
 
         """
         s = self._clone()

test_elasticsearch_dsl/test_search.py

@@ -421,32 +421,32 @@ def test_source():
 
     assert {
         '_source': {
-            'include': ['foo.bar.*'],
-            'exclude': ['foo.one']
+            'includes': ['foo.bar.*'],
+            'excludes': ['foo.one']
         }
-    } == search.Search().source(include=['foo.bar.*'], exclude=['foo.one']).to_dict()
+    } == search.Search().source(includes=['foo.bar.*'], excludes=['foo.one']).to_dict()
 
     assert {
         '_source': False
     } == search.Search().source(False).to_dict()
 
     assert {
         '_source': ['f1', 'f2']
-    } == search.Search().source(include=['foo.bar.*'], exclude=['foo.one']).source(['f1', 'f2']).to_dict()
+    } == search.Search().source(includes=['foo.bar.*'], excludes=['foo.one']).source(['f1', 'f2']).to_dict()
 
 def test_source_on_clone():
     assert {
         '_source': {
-            'include': ['foo.bar.*'],
-            'exclude': ['foo.one']
+            'includes': ['foo.bar.*'],
+            'excludes': ['foo.one']
         },
         'query': {
             'bool': {
                 'filter': [{'term': {'title': 'python'}}],
             }
         }
-    } == search.Search().source(include=['foo.bar.*']).\
-        source(exclude=['foo.one']).\
+    } == search.Search().source(includes=['foo.bar.*']).\
+        source(excludes=['foo.one']).\
         filter('term', title='python').to_dict()\
 
     assert {'_source': False,
@@ -459,8 +459,8 @@ def test_source_on_clone():
 
 def test_source_on_clear():
     assert {
-    } == search.Search().source(include=['foo.bar.*']).\
-        source(include=None, exclude=None).to_dict()
+    } == search.Search().source(includes=['foo.bar.*']).\
+        source(includes=None, excludes=None).to_dict()
 
 def test_suggest_accepts_global_text():
     s = search.Search.from_dict({