Cannot use FunctionScoreContainer?

[philbudne]

While trying to upgrade a project to version 8.17, existing code:

from elasticsearch_dsl import Search
from elasticsearch_dsl.function import RandomScore
from elasticsearch_dsl.query import FunctionScore

s = Search().query(
    FunctionScore(
        functions=[
            RandomScore()
        ]
    )
)

print(s.to_dict())

outputs:

{'query': {'function_score': {'functions': [{'random_score': {}}]}}}

But mypy complains:

test.py:9: error: Argument "functions" to "FunctionScore" has incompatible type "list[RandomScore]"; expected "Sequence[FunctionScoreContainer] | Sequence[dict[str, Any]] | DefaultType"  [arg-type]

mypy is happy with:

from elasticsearch_dsl import Search
from elasticsearch_dsl.function import RandomScore
from elasticsearch_dsl.query import FunctionScore
from elasticsearch_dsl.types import FunctionScoreContainer

s2 = Search().query(
    FunctionScore(
        functions=[
            FunctionScoreContainer(
                random_score=RandomScore()
            )
        ]
    )
)
print(s2.to_dict())

which fails at runtime with:

TypeError: unhashable type: 'FunctionScoreContainer'

[miguelgrinberg]

Thanks for raising this. The way FunctionScore is handled in this package is not exactly matching the Elasticsearch specification, so there are some customizations that need to be added. Unfortunately this extends to the typing, which I missed.

The correct code is your first option. The second option could be made to work, but it feels too verbose. I suggest you add a type ignore for now until I correct the type of the functions argument, which should be something like Sequence[ScoreFunction].

[philbudne]

@miguelgrinberg Thanks for the quick response!