Fix for 592 (#594)

* Prepare for next developer iteration, 2.4.1.

Signed-off-by: dblock <[email protected]>

* Fix: sync opensearchpy without iohttp.

Signed-off-by: dblock <[email protected]>

* Use nox to run tests.

Signed-off-by: dblock <[email protected]>

---------

Signed-off-by: dblock <[email protected]>

.github/workflows/test.yml

@@ -31,10 +31,10 @@ jobs:
           PIP_DISABLE_PIP_VERSION_CHECK: 1
       - name: Install Dependencies
         run: |
-          python -m pip install -r dev-requirements.txt
+          python -m pip install nox
       - name: Run Tests
         run: |
-          python setup.py test
+          python -m nox -rs test-${{ matrix.entry.python-version }}
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2
         with:

.github/workflows/unified-release.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        stack_version: ['2.4.0']
+        stack_version: ['2.4.1']
 
     steps:
       - name: Checkout

CHANGELOG.md

@@ -1,6 +1,15 @@
 # CHANGELOG
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
+## [2.4.1]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+- Fix dependency on `aiohttp` ([#594](https://github.com/opensearch-project/opensearch-py/pull/594))
+### Security
+
 ## [2.4.0]
 ### Added
 - Added generating imports and headers to API generator ([#467](https://github.com/opensearch-project/opensearch-py/pull/467))

RELEASING.md

@@ -37,4 +37,4 @@ The release process is standard across repositories in this org and is run by a
 1. The [release-drafter.yml](.github/workflows/release-drafter.yml) will be automatically kicked off and a draft release will be created.
 1. This draft release triggers the [jenkins release workflow](https://build.ci.opensearch.org/job/opensearch-py-release/) as a result of which opensearch-py client is released on [PyPi](https://pypi.org/project/opensearch-py/).
 1. Once the above release workflow is successful, the drafted release on GitHub is published automatically.
-1. Increment "version" in [_version.py](./opensearchpy/_version.py) to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/167).
+1. Add an "Unreleased" section to CHANGELOG, and increment version to the next patch release, e.g. v2.1.1. See [example](https://github.com/opensearch-project/opensearch-py/pull/593).

noxfile.py

@@ -45,6 +45,14 @@
 @nox.session(python=["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"])  # type: ignore
 def test(session: Any) -> None:
     session.install(".")
+    # ensure client can be imported without aiohttp
+    session.run("python", "-c", "import opensearchpy\nprint(opensearchpy.OpenSearch())")
+    # ensure client can be imported with aiohttp
+    session.install(".[async]")
+    session.run(
+        "python", "-c", "import opensearchpy\nprint(opensearchpy.AsyncOpenSearch())"
+    )
+
     session.install("-r", "dev-requirements.txt")
 
     session.run("python", "setup.py", "test")

opensearchpy/__init__.py

@@ -44,12 +44,8 @@
 logger = logging.getLogger("opensearch")
 logger.addHandler(logging.NullHandler())
 
-from ._async.client import AsyncOpenSearch
-from ._async.http_aiohttp import AIOHttpConnection, AsyncConnection
-from ._async.transport import AsyncTransport
 from .client import OpenSearch
 from .connection import (
-    AsyncHttpConnection,
     Connection,
     RequestsHttpConnection,
     Urllib3HttpConnection,
@@ -76,12 +72,7 @@
     UnknownDslObject,
     ValidationException,
 )
-from .helpers import (
-    AWSV4SignerAsyncAuth,
-    AWSV4SignerAuth,
-    RequestsAWSV4SignerAuth,
-    Urllib3AWSV4SignerAuth,
-)
+from .helpers import AWSV4SignerAuth, RequestsAWSV4SignerAuth, Urllib3AWSV4SignerAuth
 from .helpers.aggs import A
 from .helpers.analysis import analyzer, char_filter, normalizer, token_filter, tokenizer
 from .helpers.document import Document, InnerDoc, MetaField
@@ -159,7 +150,6 @@
     "JSONSerializer",
     "Connection",
     "RequestsHttpConnection",
-    "AsyncHttpConnection",
     "Urllib3HttpConnection",
     "ImproperlyConfigured",
     "OpenSearchException",
@@ -178,7 +168,6 @@
     "AWSV4SignerAuth",
     "Urllib3AWSV4SignerAuth",
     "RequestsAWSV4SignerAuth",
-    "AWSV4SignerAsyncAuth",
     "A",
     "AttrDict",
     "AttrList",
@@ -251,10 +240,23 @@
     "normalizer",
     "token_filter",
     "tokenizer",
-    "AIOHttpConnection",
-    "AsyncConnection",
-    "AsyncTransport",
-    "AsyncOpenSearch",
-    "AsyncHttpConnection",
     "__versionstr__",
 ]
+
+try:
+    from ._async.client import AsyncOpenSearch
+    from ._async.http_aiohttp import AIOHttpConnection, AsyncConnection
+    from ._async.transport import AsyncTransport
+    from .connection import AsyncHttpConnection
+    from .helpers import AWSV4SignerAsyncAuth
+
+    __all__ += [
+        "AIOHttpConnection",
+        "AsyncConnection",
+        "AsyncTransport",
+        "AsyncOpenSearch",
+        "AsyncHttpConnection",
+        "AWSV4SignerAsyncAuth",
+    ]
+except (ImportError, SyntaxError):
+    pass

opensearchpy/_version.py

@@ -25,4 +25,4 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-__versionstr__: str = "2.4.0"
+__versionstr__: str = "2.4.1"

opensearchpy/connection/__init__.py

@@ -27,7 +27,6 @@
 
 
 from .base import Connection
-from .http_async import AsyncHttpConnection
 from .http_requests import RequestsHttpConnection
 from .http_urllib3 import Urllib3HttpConnection, create_ssl_context
 
@@ -36,5 +35,13 @@
     "RequestsHttpConnection",
     "Urllib3HttpConnection",
     "create_ssl_context",
-    "AsyncHttpConnection",
 ]
+
+try:
+    from .http_async import AsyncHttpConnection
+
+    __all__ += [
+        "AsyncHttpConnection",
+    ]
+except (ImportError, SyntaxError):
+    pass