[7.16] Using reserved keywords within the scan helper results in errors

[sethmlarson]

We should be handling the from parameter and renaming the value to from_

[rumbarum]

Hello!

I tried

query = {
  "query": ...,
  "from": ...,
  "size": ...,
  "_source": ...
}
es.search(index="index", **query)

and got an Error

TypeError: search() got an unexpected keyword argument 'from'

Is there any reason changing kwargs "from" to "from_", breaking consistency?

[sethmlarson]

from is a reserved keyword in Python which is why we alias it to from_. However the library should handle this so users can use either one.

[fabiopedrosa]

Yeah, seeing the same issue. It was updated here, but not on elasticsearch-dsl which we use to build the queries.

[jgb]

Yeah, seeing the same issue. It was updated here, but not on elasticsearch-dsl which we use to build the queries.

I think the bug still exists in elasticsearch as well.

[jgb]

@sethmlarson hi will there be a release of the v7.17 branch which includes this bugfix? I'm pinned on v7.14.2 because of this bug, and not ready yet to go to v8. Thanks!

[sethmlarson]

@jgb I am planning on backporting the fix into the 7.17 branch will will receive a release in a few weeks. Can focus more on bug fixes now that the 8.0 release is out :)

[sethmlarson]

The fix has landed in 7.17, you could try installing from the branch and testing locally:

$ python -m pip install https://github.com/elastic/elasticsearch-py/archive/7.17.zip

[jgb]

@sethmlarson thanks, I can confirm this does solve my problem! Looking forward to the new release.