testcontainers_on_whales#

Subpackages#

Submodules#

Package Contents#

Classes#

Container

An abstract base class for context managers.
class testcontainers_on_whales.Container(image, command=None, env=None, client_call=None)[source]#

Bases: contextlib.AbstractContextManager

An abstract base class for context managers.

Parameters:
property client_call: list[str]#
Return type:

list[str]

property client: python_on_whales.DockerClient#
Return type:

python_on_whales.DockerClient

property container: python_on_whales.Container#
Return type:

python_on_whales.Container

property is_running: bool#
Return type:

bool

property is_ready: bool#
Return type:

bool

property logs: str#
Return type:

str

__enter__()[source]#

Return self upon entering the runtime context.

Return type:

TContainer

__exit__(exception_type, exception_value, traceback)[source]#

Raise any exception triggered within the runtime context.

Return type:

None

__del__()[source]#
Return type:

None

start()[source]#
Return type:

None

stop()[source]#
Return type:

None

remove()[source]#
Return type:

None

readiness_probe()[source]#
Return type:

bool

get_container_ip()[source]#
Return type:

str

get_container_port(port)[source]#
Parameters:

port (int | str) –

Return type:

int

wait_exited(timeout=None, interval=1)[source]#
Parameters:
Return type:

float

wait_ready(timeout=None, interval=1)[source]#
Parameters:
Return type:

float

wait_logs_match(pattern, timeout=None, interval=1)[source]#
Parameters:

  • pattern (str) –

  • timeout (float | None) –

  • interval (float) –

Return type:

float