[BUG] IDE fails with autocompletion when working with opensearchpy.helpers

[aimran-adroll]

What is the bug?

Trying to debug why a standard editor like intellij/pycharm complains about the opensearch implemented functions, more specifically it thinks functions like Bool do not take any arguments!

Nothing major but with many lines of codes, the noise become grating.

How can one reproduce the bug?

Open a up to date intellij and open up the following snippets

def test_foo():
    from elasticsearch_dsl.query import Bool as EBool
    from opensearchpy.helpers.query import Bool as OBool

    # OpenSearch DSL. Notice the error
    OBool(must=[])

    # Elasticsearch DSL. Notice no errors
    EBool(must=[])

What is the expected behavior?

At the least, intellisense should be able to pick up on docs enough to provide intelligent completions etc.

What is your host/environment?

opensearch-py==2.2.0
elasticsearch-dsl==7.4.1

Intellij IDEA 2023.1.3/ OSX 13.4

Do you have any screenshots?

See above

Do you have any additional context?

Add any other context about the problem.

[dblock]

@aimran-adroll propose a fix?

[saimedhi]

I notice the same in pycharm

[dannosaur]

The .pyi files are wildly outdated, hence the intellisense errors. Deleting the .pyi files from your venv (while unorthodox) solves the issue. The proper solution requires a lot more work though - to go through every .pyi file and update them to match the API.

[aimran-adroll]

@dblock Without knowing too much about opensearchpy internals, I am leaning towards @dannosaur's assessment. There isn't much there in those stub files from what I can tell.

[saimedhi]

Contributors, please feel free to address this issue and submit a PR with enhanced pyi files. Multiple PRs are welcome to achieve this. Your contributions are greatly appreciated!

[tannerjones4075]

I would like to work on this issue.

[tannerjones4075]

Could you officially assign me to this issue?

[marcosox]

The proper solution requires a lot more work though - to go through every .pyi file and update them to match the API.

There are tools to do this automatically:

• https://github.com/python/mypy/blob/master/mypy/stubgen.py
• https://github.com/edreamleo/make-stub-files

[saimedhi]

Hello @marcosox, I've used mypy/stubgen for writing pyi files for the existing opensearch-py helpers in this repo, but we're still facing this issue.

[tannerjones4075]

@saimedhi What issues are you facing?
Have you explored https://monkeytype.readthedocs.io/en/latest/index.html
or https://github.com/dropbox/pyannotate

[saimedhi]

Hello @tannerjones4075, I wanted to mention that for #287 , which introduced most of the helpers to opensearch-py, I used mypy/stubgen to create the pyi files.

[dblock]

I believe this should be resolved in #536 and #564, closing. If you see another type problem, open a new issue.