Use google docstring syntax for examples.

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

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,

azurite/testcontainers/azurite/__init__.py

@@ -25,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::
-
-            >>> 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"
-            ...   )
+        Example:
+
+            .. doctest::
+
+                >>> 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")

clickhouse/testcontainers/clickhouse/__init__.py

@@ -24,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")

compose/testcontainers/compose/__init__.py

@@ -24,43 +24,44 @@ class DockerCompose:
         build: Build images referenced in the configuration file.
         env_file: Path to an env file containing environment variables to pass to docker compose.
 
-    Example
-    -------
-    .. doctest::
-
-        with DockerCompose("/home/project",
-                           compose_file_name=["docker-compose-1.yml", "docker-compose-2.yml"],
-                           pull=True) as compose:
-            host = compose.get_service_host("hub", 4444)
-            port = compose.get_service_port("hub", 4444)
-            driver = webdriver.Remote(
-                command_executor=("http://{}:{}/wd/hub".format(host,port)),
-                desired_capabilities=CHROME,
-            )
-            driver.get("http://automation-remarks.com")
-            stdout, stderr = compose.get_logs()
-            if stderr:
-                print("Errors\\n:{}".format(stderr))
-
-
-    .. code-block:: yaml
-
-        hub:
-        image: selenium/hub
-        ports:
-        - "4444:4444"
-        firefox:
-        image: selenium/node-firefox
-        links:
-            - hub
-        expose:
-            - "5555"
-        chrome:
-        image: selenium/node-chrome
-        links:
-            - hub
-        expose:
-            - "5555"
+    Example:
+
+        This example spins up chrome and firefox containers using docker compose.
+
+        .. doctest::
+
+            compose_filename = ["docker-compose-1.yml", "docker-compose-2.yml"]
+            with DockerCompose("/home/project", compose_file_name=compose_file_name, pull=True) as \
+                    compose:
+                host = compose.get_service_host("hub", 4444)
+                port = compose.get_service_port("hub", 4444)
+                driver = webdriver.Remote(
+                    command_executor=("http://{}:{}/wd/hub".format(host,port)),
+                    desired_capabilities=CHROME,
+                )
+                driver.get("http://automation-remarks.com")
+                stdout, stderr = compose.get_logs()
+                if stderr:
+                    print("Errors\\n:{}".format(stderr))
+
+        .. code-block:: yaml
+
+            hub:
+            image: selenium/hub
+            ports:
+            - "4444:4444"
+            firefox:
+            image: selenium/node-firefox
+            links:
+                - hub
+            expose:
+                - "5555"
+            chrome:
+            image: selenium/node-chrome
+            links:
+                - hub
+            expose:
+                - "5555"
     """
     def __init__(
             self,

elasticsearch/testcontainers/elasticsearch/__init__.py

@@ -58,18 +58,18 @@ class ElasticSearchContainer(DockerContainer):
     """
     ElasticSearch container.
 
-    Example
-    -------
-    .. doctest::
-
-        >>> import json
-        >>> import urllib
-        >>> from testcontainers.elasticsearch import ElasticSearchContainer
-
-        >>> with ElasticSearchContainer(f'elasticsearch:8.3.3') as es:
-        ...    resp = urllib.request.urlopen(es.get_url())
-        ...    json.loads(resp.read().decode())['version']['number']
-        '8.3.3'
+    Example:
+
+        .. doctest::
+
+            >>> import json
+            >>> import urllib
+            >>> from testcontainers.elasticsearch import ElasticSearchContainer
+
+            >>> with ElasticSearchContainer(f'elasticsearch:8.3.3') as es:
+            ...    resp = urllib.request.urlopen(es.get_url())
+            ...    json.loads(resp.read().decode())['version']['number']
+            '8.3.3'
     """
 
     def __init__(self, image="elasticsearch", port_to_expose=9200, **kwargs) -> None:

google/testcontainers/google/pubsub.py

@@ -20,21 +20,21 @@ class PubSubContainer(DockerContainer):
     """
     PubSub container for testing managed message queues.
 
-    Example
-    -------
-    The example will spin up a Google Cloud PubSub emulator that you can use for integration tests.
-    The :code:`pubsub` instance provides convenience methods :code:`get_publisher` and
-    :code:`get_subscriber` to connect to the emulator without having to set the environment variable
-    :code:`PUBSUB_EMULATOR_HOST`.
+    Example:
 
-    .. doctest::
+        The example will spin up a Google Cloud PubSub emulator that you can use for integration
+        tests. The :code:`pubsub` instance provides convenience methods :code:`get_publisher` and
+        :code:`get_subscriber` to connect to the emulator without having to set the environment
+        variable :code:`PUBSUB_EMULATOR_HOST`.
 
-        def test_docker_run_pubsub():
-            config = PubSubContainer('google/cloud-sdk:emulators')
-            with config as pubsub:
-                publisher = pubsub.get_publisher()
-                topic_path = publisher.topic_path(pubsub.project, "my-topic")
-                topic = publisher.create_topic(topic_path)
+        .. doctest::
+
+            def test_docker_run_pubsub():
+                config = PubSubContainer('google/cloud-sdk:emulators')
+                with config as pubsub:
+                    publisher = pubsub.get_publisher()
+                    topic_path = publisher.topic_path(pubsub.project, "my-topic")
+                    topic = publisher.create_topic(topic_path)
     """
     def __init__(self, image: str = "google/cloud-sdk:emulators", project: str = "test-project",
                  port: int = 8432, **kwargs) -> None:

kafka/testcontainers/kafka/__init__.py

@@ -14,14 +14,14 @@ class KafkaContainer(DockerContainer):
     """
     Kafka container.
 
-    Example
-    -------
-    .. doctest::
+    Example:
 
-        >>> from testcontainers.kafka import KafkaContainer
+        .. doctest::
 
-        >>> with KafkaContainer() as kafka:
-        ...    connection = kafka.get_bootstrap_server()
+            >>> from testcontainers.kafka import KafkaContainer
+
+            >>> with KafkaContainer() as kafka:
+            ...    connection = kafka.get_bootstrap_server()
     """
     KAFKA_PORT = 9093
     TC_START_SCRIPT = '/tc-start.sh'

keycloak/testcontainers/keycloak/__init__.py

@@ -23,14 +23,14 @@ class KeycloakContainer(DockerContainer):
     """
     Keycloak container.
 
-    Example
-    -------
-    .. doctest::
+    Example:
 
-        >>> from testcontainers.keycloak import KeycloakContainer
+        .. doctest::
 
-        >>> with KeycloakContainer() as kc:
-        ...    keycloak = kc.get_client()
+            >>> from testcontainers.keycloak import KeycloakContainer
+
+            >>> with KeycloakContainer() as kc:
+            ...    keycloak = kc.get_client()
     """
     KEYCLOAK_USER = os.environ.get("KEYCLOAK_USER", "test")
     KEYCLOAK_PASSWORD = os.environ.get("KEYCLOAK_PASSWORD", "test")

localstack/testcontainers/localstack/__init__.py

@@ -18,23 +18,23 @@ class LocalStackContainer(DockerContainer):
     """
     Localstack container.
 
-    Example
-    -------
-    .. doctest::
+    Example:
 
-        >>> from testcontainers.localstack import LocalStackContainer
+        .. doctest::
 
-        >>> with LocalStackContainer(image="localstack/localstack:0.11.4") as localstack:
-        ...     localstack.with_services("dynamodb", "lambda")
-        ...     dynamo_endpoint = localstack.get_url()
-        <testcontainers.localstack.LocalStackContainer object at 0x...>
+            >>> from testcontainers.localstack import LocalStackContainer
 
-    The endpoint can be used to create a client with the boto3 library:
-    .. doctest::
+            >>> with LocalStackContainer(image="localstack/localstack:0.11.4") as localstack:
+            ...     localstack.with_services("dynamodb", "lambda")
+            ...     dynamo_endpoint = localstack.get_url()
+            <testcontainers.localstack.LocalStackContainer object at 0x...>
 
-        dynamo_client = boto3.client("dynamodb", endpoint_url=dynamo_endpoint)
-        scan_result = dynamo_client.scan(TableName='foo')
-        # Do something with the scan result
+        The endpoint can be used to create a client with the boto3 library:
+        .. doctest::
+
+            dynamo_client = boto3.client("dynamodb", endpoint_url=dynamo_endpoint)
+            scan_result = dynamo_client.scan(TableName='foo')
+            # Do something with the scan result
     """
     def __init__(self, image: str = 'localstack/localstack:0.11.4', edge_port: int = 4566,
                  **kwargs) -> None:

minio/testcontainers/minio/__init__.py

@@ -14,24 +14,24 @@ class MinioContainer(DockerContainer):
     The method :code:`get_config` can be used to retrieve the endpoint, access key
     and secret key of the container.
 
-    Example
-    -------
-    .. doctest::
+    Example:
 
-        >>> import io
-        >>> from testcontainers.minio import MinioContainer
+        .. doctest::
 
-        >>> with MinioContainer() as minio:
-        ...   client = minio.get_client()
-        ...   client.make_bucket("test")
-        ...   test_content = b"Hello World"
-        ...   write_result = client.put_object(
-        ...       "test",
-        ...       "testfile.txt",
-        ...       io.BytesIO(test_content),
-        ...       length=len(test_content),
-        ...   )
-        ...   retrieved_content = client.get_object("test", "testfile.txt").data
+            >>> import io
+            >>> from testcontainers.minio import MinioContainer
+
+            >>> with MinioContainer() as minio:
+            ...   client = minio.get_client()
+            ...   client.make_bucket("test")
+            ...   test_content = b"Hello World"
+            ...   write_result = client.put_object(
+            ...       "test",
+            ...       "testfile.txt",
+            ...       io.BytesIO(test_content),
+            ...       length=len(test_content),
+            ...   )
+            ...   retrieved_content = client.get_object("test", "testfile.txt").data
     """
 
     def __init__(self, image: str = "minio/minio:RELEASE.2022-12-02T19-19-22Z",