Merge pull request #295 from tillahoffmann/types

Add type annotations and improve documentation.

Author: tillahoffmann

arangodb/testcontainers/arangodb/__init__.py

@@ -12,26 +12,26 @@ class ArangoDbContainer(DbContainer):
     """
     ArangoDB container.
 
-    Example
-    -------
-    The example will spin up a ArangoDB container.
-    You may use the :code:`get_connection_url()` method which returns a arangoclient-compatible url
-    in format :code:`scheme://host:port`. As of now, only a single host is supported (over HTTP).
+    Example:
 
-    .. doctest::
+        This example spins up an ArangoDB container. You may use the :code:`get_connection_url()`
+        method which returns a arangoclient-compatible url in format :code:`scheme://host:port`. As
+        of now, only a single host is supported (over HTTP).
 
-        >>> from testcontainers.arangodb import ArangoDbContainer
-        >>> from arango import ArangoClient
+        .. doctest::
 
-        >>> with ArangoDbContainer("arangodb:3.9.1") as arango:
-        ...    client = ArangoClient(hosts=arango.get_connection_url())
-        ...
-        ...    # Connect
-        ...    sys_db = client.db(username="root", password="passwd")
-        ...
-        ...    # Create a new database named "test".
-        ...    sys_db.create_database("test")
-        True
+            >>> from testcontainers.arangodb import ArangoDbContainer
+            >>> from arango import ArangoClient
+
+            >>> with ArangoDbContainer("arangodb:3.9.1") as arango:
+            ...    client = ArangoClient(hosts=arango.get_connection_url())
+            ...
+            ...    # Connect
+            ...    sys_db = client.db(username="root", password="passwd")
+            ...
+            ...    # Create a new database named "test".
+            ...    sys_db.create_database("test")
+            True
     """
 
     def __init__(self,
@@ -40,7 +40,7 @@ def __init__(self,
                  arango_root_password: str = "passwd",
                  arango_no_auth: typing.Optional[bool] = None,
                  arango_random_root_password: typing.Optional[bool] = None,
-                 **kwargs):
+                 **kwargs) -> None:
         """
         Args:
             image: Actual docker image/tag to pull.
@@ -69,23 +69,16 @@ def __init__(self,
             else arango_random_root_password
         ))
 
-    def _configure(self):
+    def _configure(self) -> None:
         self.with_env("ARANGO_ROOT_PASSWORD", self.arango_root_password)
         if self.arango_no_auth:
             self.with_env("ARANGO_NO_AUTH", "1")
         if self.arango_random_root_password:
             self.with_env("ARANGO_RANDOM_ROOT_PASSWORD", "1")
 
-    def get_connection_url(self):
-        # for now, single host over HTTP
-        scheme = "http"
+    def get_connection_url(self) -> str:
         port = self.get_exposed_port(self.port_to_expose)
-        url = f"{scheme}://{self.get_container_host_ip()}:{port}"
-
-        return url
+        return f"http://{self.get_container_host_ip()}:{port}"
 
-    def _connect(self):
-        wait_for_logs(
-            self,
-            predicate="is ready for business",
-            timeout=MAX_TRIES)
+    def _connect(self) -> None:
+        wait_for_logs(self, predicate="is ready for business", timeout=MAX_TRIES)

azurite/testcontainers/azurite/__init__.py

@@ -12,6 +12,7 @@
 #    under the License.
 import os
 import socket
+from typing import Iterable, Optional
 
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_container_is_ready
@@ -24,19 +25,19 @@ class AzuriteContainer(DockerContainer):
         :code:`get_connection_string` can be used to create a client for Blob service, Queue service
         and Table service.
 
-        Example
-        -------
-        .. doctest::
+        Example:
 
-            >>> from testcontainers.azurite import AzuriteContainer
-            >>> from azure.storage.blob import BlobServiceClient
+            .. doctest::
 
-            >>> with AzuriteContainer() as azurite_container:
-            ...   connection_string = azurite_container.get_connection_string()
-            ...   client = BlobServiceClient.from_connection_string(
-            ...        connection_string,
-            ...        api_version="2019-12-12"
-            ...   )
+                >>> from testcontainers.azurite import AzuriteContainer
+                >>> from azure.storage.blob import BlobServiceClient
+
+                >>> with AzuriteContainer() as azurite_container:
+                ...   connection_string = azurite_container.get_connection_string()
+                ...   client = BlobServiceClient.from_connection_string(
+                ...        connection_string,
+                ...        api_version="2019-12-12"
+                ...   )
         """
 
     _AZURITE_ACCOUNT_NAME = os.environ.get("AZURITE_ACCOUNT_NAME", "devstoreaccount1")
@@ -48,21 +49,14 @@ class AzuriteContainer(DockerContainer):
     _QUEUE_SERVICE_PORT = 10_001
     _TABLE_SERVICE_PORT = 10_002
 
-    def __init__(
-            self,
-            image="mcr.microsoft.com/azure-storage/azurite:latest",
-            ports_to_expose=None,
-            **kwargs
-    ):
+    def __init__(self, image: str = "mcr.microsoft.com/azure-storage/azurite:latest",
+                 ports_to_expose: Optional[Iterable[int]] = None, **kwargs) -> None:
         """ Constructs an AzuriteContainer.
 
-        Parameters
-        ----------
-        image: str
-            Expects an image with tag.
-        ports_to_expose: List[int]
-            Expects a list with port numbers to expose.
-        kwargs
+        Args:
+            image: Expects an image with tag.
+            ports_to_expose: List with port numbers to expose.
+            **kwargs: Keyword arguments passed to super class.
         """
         super().__init__(image=image, **kwargs)
 
@@ -80,7 +74,7 @@ def __init__(
         self.with_env("AZURITE_ACCOUNTS",
                       f"{self._AZURITE_ACCOUNT_NAME}:{self._AZURITE_ACCOUNT_KEY}")
 
-    def get_connection_string(self):
+    def get_connection_string(self) -> str:
         host_ip = self.get_container_host_ip()
         connection_string = f"DefaultEndpointsProtocol=http;" \
                             f"AccountName={self._AZURITE_ACCOUNT_NAME};" \
@@ -103,13 +97,13 @@ def get_connection_string(self):
 
         return connection_string
 
-    def start(self):
+    def start(self) -> 'AzuriteContainer':
         super().start()
         self._connect()
         return self
 
     @wait_container_is_ready(OSError)
-    def _connect(self):
+    def _connect(self) -> None:
         with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
             s.connect((self.get_container_host_ip(),
                        int(self.get_exposed_port(next(iter(self.ports))))))

clickhouse/testcontainers/clickhouse/__init__.py

@@ -11,6 +11,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 import os
+from typing import Optional
 
 import clickhouse_driver
 from clickhouse_driver.errors import Error
@@ -23,20 +24,20 @@ class ClickHouseContainer(DbContainer):
     """
     ClickHouse database container.
 
-    Example
-    -------
-    The example spins up a ClickHouse database and connects to it
-    using the :code:`clickhouse-driver`.
+    Example:
 
-    .. doctest::
+        The example spins up a ClickHouse database and connects to it using the
+        :code:`clickhouse-driver`.
 
-        >>> import clickhouse_driver
-        >>> from testcontainers.clickhouse import ClickHouseContainer
+        .. doctest::
 
-        >>> with ClickHouseContainer("clickhouse/clickhouse-server:21.8") as clickhouse:
-        ...     client = clickhouse_driver.Client.from_url(clickhouse.get_connection_url())
-        ...     client.execute("select 'working'")
-        [('working',)]
+            >>> import clickhouse_driver
+            >>> from testcontainers.clickhouse import ClickHouseContainer
+
+            >>> with ClickHouseContainer("clickhouse/clickhouse-server:21.8") as clickhouse:
+            ...     client = clickhouse_driver.Client.from_url(clickhouse.get_connection_url())
+            ...     client.execute("select 'working'")
+            [('working',)]
     """
 
     CLICKHOUSE_USER = os.environ.get("CLICKHOUSE_USER", "test")
@@ -45,12 +46,12 @@ class ClickHouseContainer(DbContainer):
 
     def __init__(
             self,
-            image="clickhouse/clickhouse-server:latest",
-            port=9000,
-            user=None,
-            password=None,
-            dbname=None
-    ):
+            image: str = "clickhouse/clickhouse-server:latest",
+            port: int = 9000,
+            user: Optional[str] = None,
+            password: Optional[str] = None,
+            dbname: Optional[str] = None
+    ) -> None:
         super().__init__(image=image)
 
         self.CLICKHOUSE_USER = user or self.CLICKHOUSE_USER
@@ -60,16 +61,16 @@ def __init__(
         self.with_exposed_ports(self.port_to_expose)
 
     @wait_container_is_ready(Error, EOFError)
-    def _connect(self):
+    def _connect(self) -> None:
         with clickhouse_driver.Client.from_url(self.get_connection_url()) as client:
             client.execute("SELECT version()")
 
-    def _configure(self):
+    def _configure(self) -> None:
         self.with_env("CLICKHOUSE_USER", self.CLICKHOUSE_USER)
         self.with_env("CLICKHOUSE_PASSWORD", self.CLICKHOUSE_PASSWORD)
         self.with_env("CLICKHOUSE_DB", self.CLICKHOUSE_DB)
 
-    def get_connection_url(self, host=None):
+    def get_connection_url(self, host: Optional[str] = None) -> str:
         return self._create_connection_url(
             dialect="clickhouse",
             username=self.CLICKHOUSE_USER,