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>
125 lines
4.3 KiB
Python
125 lines
4.3 KiB
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.
|
|
#
|
|
# Licensed to Elasticsearch B.V. under one or more contributor
|
|
# license agreements. See the NOTICE file distributed with
|
|
# this work for additional information regarding copyright
|
|
# ownership. Elasticsearch B.V. licenses this file to you under
|
|
# the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
|
|
import re
|
|
from os.path import abspath, dirname, join
|
|
|
|
from setuptools import find_packages, setup
|
|
|
|
PACKAGE_NAME = "opensearch-py"
|
|
PACKAGE_VERSION = ""
|
|
BASE_DIR = abspath(dirname(__file__))
|
|
|
|
with open(
|
|
join(BASE_DIR, PACKAGE_NAME.replace("-", ""), "_version.py"), encoding="utf-8"
|
|
) as f:
|
|
data = f.read()
|
|
m = re.search(r"^__versionstr__: str\s+=\s+[\"\']([^\"\']+)[\"\']", data, re.M)
|
|
if m:
|
|
PACKAGE_VERSION = m.group(1)
|
|
else:
|
|
raise Exception(f"Invalid version: {data}")
|
|
|
|
with open(join(BASE_DIR, "README.md"), encoding="utf-8") as f:
|
|
long_description = f.read().strip()
|
|
|
|
MODULE_DIR = PACKAGE_NAME.replace("-", "")
|
|
packages = [
|
|
package
|
|
for package in find_packages(where=".", exclude=("test_opensearchpy*",))
|
|
if package == MODULE_DIR or package.startswith(MODULE_DIR + ".")
|
|
]
|
|
install_requires = [
|
|
"urllib3>=1.26.18, <2",
|
|
"requests>=2.4.0, <3.0.0",
|
|
"six",
|
|
"python-dateutil",
|
|
"certifi>=2022.12.07",
|
|
]
|
|
tests_require = [
|
|
"requests>=2.0.0, <3.0.0",
|
|
"coverage<8.0.0",
|
|
"mock",
|
|
"pyyaml",
|
|
"pytest>=3.0.0",
|
|
"pytest-cov",
|
|
"pytz",
|
|
"botocore",
|
|
"pytest-mock<4.0.0",
|
|
]
|
|
|
|
async_require = ["aiohttp>=3,<4"]
|
|
|
|
docs_require = ["sphinx", "sphinx_rtd_theme", "myst_parser", "sphinx_copybutton"]
|
|
generate_require = ["black", "jinja2"]
|
|
|
|
setup(
|
|
name=PACKAGE_NAME,
|
|
description="Python client for OpenSearch",
|
|
license="Apache-2.0",
|
|
url="https://github.com/opensearch-project/opensearch-py",
|
|
long_description=long_description,
|
|
long_description_content_type="text/markdown",
|
|
version=PACKAGE_VERSION,
|
|
author="Aleksei Atavin, Denis Zalevskiy, Rushi Agrawal, Shephali Mittal",
|
|
author_email="axeo@aiven.io, dez@aiven.io, rushi.agr@gmail.com, shephalm@amazon.com",
|
|
maintainer="Aleksei Atavin, Denis Zalevskiy, Rushi Agrawal, Shephali Mittal",
|
|
maintainer_email="axeo@aiven.io, dez@aiven.io, rushi.agr@gmail.com, shephalm@amazon.com",
|
|
project_urls={
|
|
"Documentation": "https://opensearch.org/docs/clients/python",
|
|
"Source Code": "https://github.com/opensearch-project/opensearch-py",
|
|
"Issue Tracker": "https://github.com/opensearch-project/opensearch-py/issues",
|
|
},
|
|
packages=packages,
|
|
package_data={"opensearchpy": ["py.typed"]},
|
|
include_package_data=True,
|
|
zip_safe=False,
|
|
classifiers=[
|
|
"Development Status :: 5 - Production/Stable",
|
|
"License :: OSI Approved :: Apache Software License",
|
|
"Intended Audience :: Developers",
|
|
"Operating System :: OS Independent",
|
|
"Programming Language :: Python",
|
|
"Programming Language :: Python :: 3.6",
|
|
"Programming Language :: Python :: 3.7",
|
|
"Programming Language :: Python :: 3.8",
|
|
"Programming Language :: Python :: 3.9",
|
|
"Programming Language :: Python :: Implementation :: CPython",
|
|
"Programming Language :: Python :: Implementation :: PyPy",
|
|
],
|
|
python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4",
|
|
install_requires=install_requires,
|
|
test_suite="test_opensearchpy.run_tests.run_all",
|
|
tests_require=tests_require,
|
|
extras_require={
|
|
"develop": tests_require + docs_require + generate_require,
|
|
"docs": docs_require + async_require,
|
|
"async": async_require,
|
|
"kerberos": ["requests_kerberos"],
|
|
},
|
|
)
|