feat: add typing for SF function

Author: Caiofcas

elasticsearch_dsl/function.py

@@ -16,38 +16,40 @@
 #  under the License.
 
 import collections.abc
-from typing import Dict, Optional, ClassVar
+from copy import deepcopy
+from typing import Dict, Optional, ClassVar, Union, MutableMapping, Any
 
 from .utils import DslBase, _JSONSafeTypes
 
 
-# Incomplete annotation to not break query.py tests
-def SF(name_or_sf, **params) -> "ScoreFunction":
+def SF(name_or_sf: Union[str, "ScoreFunction", MutableMapping[str, Any]], **params: Any) -> "ScoreFunction":
     # {"script_score": {"script": "_score"}, "filter": {}}
-    if isinstance(name_or_sf, collections.abc.Mapping):
+    if isinstance(name_or_sf, collections.abc.MutableMapping):
         if params:
             raise ValueError("SF() cannot accept parameters when passing in a dict.")
-        kwargs = {}
-        sf = name_or_sf.copy()
+
+        kwargs: Dict[str, Any] = {}
+        sf = deepcopy(name_or_sf)
         for k in ScoreFunction._param_defs:
             if k in name_or_sf:
                 kwargs[k] = sf.pop(k)
 
         # not sf, so just filter+weight, which used to be boost factor
+        sf_params = params
         if not sf:
             name = "boost_factor"
         # {'FUNCTION': {...}}
         elif len(sf) == 1:
-            name, params = sf.popitem()
+            name, sf_params = sf.popitem()
         else:
             raise ValueError(f"SF() got an unexpected fields in the dictionary: {sf!r}")
 
         # boost factor special case, see elasticsearch #6343
-        if not isinstance(params, collections.abc.Mapping):
-            params = {"value": params}
+        if not isinstance(sf_params, collections.abc.Mapping):
+            sf_params = {"value": sf_params}
 
         # mix known params (from _param_defs) and from inside the function
-        kwargs.update(params)
+        kwargs.update(sf_params)
         return ScoreFunction.get_dsl_class(name)(**kwargs)
 
     # ScriptScore(script="_score", filter=Q())

elasticsearch_dsl/utils.py

@@ -253,6 +253,7 @@ class DslBase(metaclass=DslMeta):
           all values in the `must` attribute into Query objects)
     """
 
+    _type_name: ClassVar[str]
     _param_defs: ClassVar[Dict[str, Dict[str, Union[str, bool]]]] = {}
 
     @classmethod