Skip to content

Commit 5d04bfb

Browse files
committed
Add type annotations for rabbitmq.
1 parent 557bc44 commit 5d04bfb

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

rabbitmq/testcontainers/rabbitmq/__init__.py

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,15 @@ class RabbitMqContainer(DockerContainer):
2727
RABBITMQ_DEFAULT_USER = os.environ.get("RABBITMQ_DEFAULT_USER", "guest")
2828
RABBITMQ_DEFAULT_PASS = os.environ.get("RABBITMQ_DEFAULT_PASS", "guest")
2929

30-
def __init__(
31-
self,
32-
image: str = "rabbitmq:latest",
33-
port: Optional[int] = None,
34-
username: Optional[str] = None,
35-
password: Optional[str] = None,
36-
**kwargs,
37-
) -> None:
30+
def __init__(self, image: str = "rabbitmq:latest", port: Optional[int] = None,
31+
username: Optional[str] = None, password: Optional[str] = None, **kwargs) -> None:
3832
"""Initialize the RabbitMQ test container.
3933
4034
Args:
41-
image (str, optional):
42-
The docker image from docker hub. Defaults to "rabbitmq:latest".
43-
port (int, optional):
44-
The port to reach the AMQP API. Defaults to 5672.
45-
username (str, optional):
46-
Overwrite the default username which is "guest".
47-
password (str, optional):
48-
Overwrite the default username which is "guest".
35+
image: Docker image from docker hub. Defaults to "rabbitmq:latest".
36+
port: Port to reach the AMQP API. Defaults to 5672.
37+
username: RabbitMQ username.
38+
password: RabbitMQ password.
4939
"""
5040
super(RabbitMqContainer, self).__init__(image=image, **kwargs)
5141
self.RABBITMQ_NODE_PORT = port or int(self.RABBITMQ_NODE_PORT)
@@ -81,7 +71,7 @@ def get_connection_params(self) -> pika.ConnectionParameters:
8171
credentials=credentials,
8272
)
8373

84-
def start(self):
74+
def start(self) -> "RabbitMqContainer":
8575
"""Start the test container."""
8676
super().start()
8777
self.readiness_probe()

0 commit comments

Comments
 (0)