Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pylint integration updates #643

Merged
merged 16 commits into from
Jan 19, 2024
Merged

Pylint integration updates #643

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
10a2b4f
updated files with docstrings to pass pylint
macohen Dec 19, 2023
9b8b830
updated samples to prepare for enabling missing-docstring linter; wil…
macohen Dec 22, 2023
bc5aac1
removed missing-function-docstring from setup.cfg so the linter doesn…
macohen Dec 22, 2023
78887f6
corrected unnecessary return docstring values
macohen Dec 22, 2023
8752a16
fixing failure in 'black' on reformatting
macohen Dec 22, 2023
435948b
updated utils to pass missing-function-docstring tests
macohen Dec 29, 2023
a2fa5e7
Merge branch 'opensearch-project:main' into main
macohen Dec 29, 2023
f3a0450
updated functions with missing docstrings or pylint ignore instructio…
macohen Dec 31, 2023
dabaa59
Merge branch 'opensearch-project:main' into main
macohen Jan 7, 2024
d26eba5
* ignoring opensearchpy for pylint and then added it back to noxfile.py
macohen Jan 8, 2024
0a2302f
updated CHANGELOG.md entry
macohen Jan 8, 2024
fcc65a3
removed pylint ignore missing-function-docstring
macohen Jan 8, 2024
2265ad3
added pylint.extensions.docparams plugin
macohen Jan 8, 2024
d9c0874
added four lints for opensearchpy/
macohen Jan 17, 2024
ffa80b3
adding await back to client.info() call
macohen Jan 17, 2024
107469c
updated TODOs as requested
macohen Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
adding await back to client.info() call 
Signed-off-by: Mark Cohen <markcoh@amazon.com>
  • Loading branch information
@macohen
macohen committed Jan 17, 2024
commit ffa80b36c23102b94fd99dedfd5e5358a0e3aae3
8 changes: 1 addition & 7 deletions test_opensearchpy/test_async/test_server/test_helpers/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,12 @@ async def client() -> Any:

@fixture(scope="function") # type: ignore
async def opensearch_version(client: Any) -> Any:
"""
yields the version of the OpenSearch cluster
:param client:
:return:
"""
info = client.info()
"""
yields the version of the OpenSearch cluster
:param client: client connection to OpenSearch
:return: yields major version number
"""
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing param description

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also adding a pylint extension to add missing-param-doc (when a parameter is missing from the docstring) and differing-param-doc (when a parameter is different in the function definition and the docstring).

info = client.info()
info = await client.info()
print(info)
yield (int(x) async for x in match_version(info))

Expand Down
Loading