0ddbf8cafa
* updated files with docstrings to pass pylint Signed-off-by: Mark Cohen <markcoh@amazon.com> * updated samples to prepare for enabling missing-docstring linter; will continue to work on this before committing setup.cfg Signed-off-by: Mark Cohen <markcoh@amazon.com> * removed missing-function-docstring from setup.cfg so the linter doesn't fail while work on docstrings continues Signed-off-by: Mark Cohen <markcoh@amazon.com> * corrected unnecessary return docstring values Signed-off-by: Mark Cohen <markcoh@amazon.com> * fixing failure in 'black' on reformatting Signed-off-by: Mark Cohen <markcoh@amazon.com> * updated utils to pass missing-function-docstring tests Signed-off-by: Mark Cohen <markcoh@amazon.com> * updated functions with missing docstrings or pylint ignore instructions; added a utility to automatically add these ignore instructions to most functions that should be self-describing; rolled back some automatically generated code mistakenly changed Signed-off-by: Mark Cohen <markcoh@amazon.com> * * ignoring opensearchpy for pylint and then added it back to noxfile.py * fixed some lints; created a feature flag for newer dynamic pylint so now lints can be fixed first in legacy code and then enabled by multiple people * extracted a method for per-folder linting * updated noxfile.lint_per_folder with type hints * enabled unspecified-encoding in pylint * added disable missing-function-docstring pragma to test_clients.py in test_async and test_server * added more encodings to pass unspecified-encoding pylint tests * updated changelog Signed-off-by: Mark Cohen <markcoh@amazon.com> * updated CHANGELOG.md entry removed the feature flag for pylint lint_per_folder fixed failures from mypy and pylint removed pylint MESSAGE CONTROL config from setup.cfg after relocating to lint_per_folder method Signed-off-by: Mark Cohen <markcoh@amazon.com> * removed pylint ignore missing-function-docstring Signed-off-by: Mark Cohen <markcoh@amazon.com> * added pylint.extensions.docparams plugin updated some docstrings to correct parameters removed pylint from setup.cfg Signed-off-by: Mark Cohen <markcoh@amazon.com> * added four lints for opensearchpy/ Signed-off-by: Mark Cohen <markcoh@amazon.com> * adding await back to client.info() call Signed-off-by: Mark Cohen <markcoh@amazon.com> * updated TODOs as requested renamed test_opensearchpy.test_async.test_server.test_helpers.conftest.setup_ubq_tests to setup_update_by_query_tests added OpenSearch-main/rest-api-spec/src/main/resources/rest-api-spec/test/indices/stats/50_noop_update[0] to skip tests list run_tests.py catches a CalledProcessError when the git repo already exists and the command to add the origin fails in fetch_opensearch_repo() Signed-off-by: Mark Cohen <markcoh@amazon.com> --------- Signed-off-by: Mark Cohen <markcoh@amazon.com>
103 lines
2.6 KiB
Python
Executable File
103 lines
2.6 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# The OpenSearch Contributors require contributions made to
|
|
# this file be licensed under the Apache-2.0 license or a
|
|
# compatible open source license.
|
|
#
|
|
# Modifications Copyright OpenSearch Contributors. See
|
|
# GitHub history for details.
|
|
|
|
|
|
import asyncio
|
|
|
|
from opensearchpy import AsyncOpenSearch
|
|
|
|
|
|
async def main() -> None:
|
|
"""
|
|
an example showing how to create an asynchronous connection
|
|
to OpenSearch, create an index, index a document and
|
|
search to return the document
|
|
"""
|
|
# connect to OpenSearch
|
|
host = "localhost"
|
|
port = 9200
|
|
auth = ("admin", "admin") # For testing only. Don't store credentials in code.
|
|
|
|
client = AsyncOpenSearch(
|
|
hosts=[{"host": host, "port": port}],
|
|
http_auth=auth,
|
|
use_ssl=True,
|
|
verify_certs=False,
|
|
ssl_show_warn=False,
|
|
)
|
|
|
|
try:
|
|
info = await client.info()
|
|
print(
|
|
f"Welcome to {info['version']['distribution']} {info['version']['number']}!"
|
|
)
|
|
|
|
# create an index
|
|
|
|
index_name = "test-index"
|
|
|
|
index_body = {"settings": {"index": {"number_of_shards": 4}}}
|
|
|
|
if not await client.indices.exists(index=index_name):
|
|
await client.indices.create(index_name, body=index_body)
|
|
|
|
# add some documents to the index, asynchronously
|
|
await asyncio.gather(
|
|
*[
|
|
client.index(
|
|
index=index_name,
|
|
body={
|
|
"title": f"Moneyball {i}",
|
|
"director": "Bennett Miller",
|
|
"year": "2011",
|
|
},
|
|
id=i,
|
|
)
|
|
for i in range(10)
|
|
]
|
|
)
|
|
|
|
# refresh the index
|
|
await client.indices.refresh(index=index_name)
|
|
|
|
# search for a document
|
|
user_query = "miller"
|
|
|
|
query = {
|
|
"size": 5,
|
|
"query": {
|
|
"multi_match": {"query": user_query, "fields": ["title^2", "director"]}
|
|
},
|
|
}
|
|
|
|
results = await client.search(body=query, index=index_name)
|
|
|
|
for hit in results["hits"]["hits"]:
|
|
print(hit)
|
|
|
|
# delete the documents
|
|
await asyncio.gather(
|
|
*[client.delete(index=index_name, id=i) for i in range(10)]
|
|
)
|
|
|
|
# delete the index
|
|
await client.indices.delete(index=index_name)
|
|
|
|
finally:
|
|
await client.close()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
loop = asyncio.new_event_loop()
|
|
asyncio.set_event_loop(loop)
|
|
loop.run_until_complete(main())
|
|
loop.close()
|