Add type annotations for opensearch.

Author: tillahoffmann

opensearch/testcontainers/opensearch/__init__.py

@@ -28,21 +28,13 @@ class OpenSearchContainer(DockerContainer):
         ...   search_result = client.search(index="test", body={"query": {"match_all": {}}})
     """
 
-    def __init__(
-        self,
-        image="opensearchproject/opensearch:2.4.0",
-        port_to_expose=9200,
-        security_enabled=False,
-        **kwargs,
-    ):
+    def __init__(self, image: str = "opensearchproject/opensearch:2.4.0",
+                 port_to_expose: int = 9200, security_enabled: bool = False, **kwargs) -> None:
         """
         Args:
-            image (str, optional): The Docker image to use for the container.
-                                   Defaults to "opensearchproject/opensearch:2.4.0".
-            port_to_expose (int, optional): The port to expose on the container.
-                                            Defaults to 9200.
-            security_enabled (bool, optional): `False` disables the security plugin in OpenSearch.
-                                                Defaults to False.
+            image: Docker image to use for the container.
+            port_to_expose: Port to expose on the container.
+            security_enabled: :code:`False` disables the security plugin in OpenSearch.
         """
         super(OpenSearchContainer, self).__init__(image, **kwargs)
         self.port_to_expose = port_to_expose
@@ -54,7 +46,7 @@ def __init__(
         if security_enabled:
             self.with_env("plugins.security.allow_default_init_securityindex", "true")
 
-    def get_config(self):
+    def get_config(self) -> dict:
         """This method returns the configuration of the OpenSearch container,
         including the host, port, user, and password.
 
@@ -91,13 +83,13 @@ def get_client(self, verify_certs: bool = False, **kwargs) -> OpenSearch:
         )
 
     @wait_container_is_ready(ConnectionError, TransportError)
-    def _healthcheck(self):
+    def _healthcheck(self) -> None:
         """This is an internal method used to check if the OpenSearch container
         is healthy and ready to receive requests."""
         client: OpenSearchContainer = self.get_client()
         client.cluster.health(wait_for_status="green")
 
-    def start(self):
+    def start(self) -> "OpenSearchContainer":
         """This method starts the OpenSearch container and runs the healthcheck
         to verify that the container is ready to use."""
         super().start()