testcontainers-python の API リファレンス

testcontainers-python (testcontainers/testcontainers-python) の公開 API 105 件 —— クラス 68、関数 4、メソッド 33。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: testcontainers/testcontainers-python

種別	件数
クラス	68
関数	4
メソッド	33

API 一覧

classsrc.testcontainers.community.arangodb.ArangoDbContainer

ArangoDB container.

classsrc.testcontainers.community.cassandra.CassandraContainer

Cassandra database container.

classsrc.testcontainers.community.clickhouse.ClickHouseContainer

ClickHouse database container.

classsrc.testcontainers.community.cockroachdb.CockroachDBContainer

CockroachDB database container.

classsrc.testcontainers.community.cosmosdb.mongodb.CosmosDBMongoEndpointContainer

CosmosDB MongoDB enpoint Emulator.

classsrc.testcontainers.community.cosmosdb.nosql.CosmosDBNoSQLEndpointContainer

CosmosDB NoSQL enpoint Emulator.

methodsrc.testcontainers.community.cosmosdb.nosql.CosmosDBNoSQLEndpointContainer.url() -> str

The url to the NoSQL endpoint

classsrc.testcontainers.community.cratedb.CrateDBContainer

CrateDB database container.

classsrc.testcontainers.community.db2.Db2Container

IBM Db2 database container.

classsrc.testcontainers.community.elasticsearch.ElasticSearchContainer

ElasticSearch container.

classsrc.testcontainers.community.influxdb.version1.InfluxDb1Container

Docker container for InfluxDB 1.x.

methodsrc.testcontainers.community.influxdb.version1.InfluxDb1Container.start() -> Self

Overridden for better typing reason

classsrc.testcontainers.community.influxdb.version2.InfluxDb2Container

Docker container for InfluxDB 2.x.

methodsrc.testcontainers.community.influxdb.version2.InfluxDb2Container.start() -> Self

Overridden for better typing reason

classsrc.testcontainers.community.k3s.K3SContainer

K3S container.

classsrc.testcontainers.community.kafka.KafkaContainer

Kafka container.

classsrc.testcontainers.community.kafka._redpanda.RedpandaContainer

Redpanda container.

classsrc.testcontainers.community.localstack.LocalStackContainer

Localstack container.

methodsrc.testcontainers.community.localstack.LocalStackContainer.with_services(*services) -> Self

Restrict what services to run.

classsrc.testcontainers.community.mailpit.MailpitContainer

Test container for Mailpit.

classsrc.testcontainers.community.memcached.MemcachedContainer

Test container for Memcached.

classsrc.testcontainers.community.milvus.MilvusContainer

Milvus database container.

classsrc.testcontainers.community.mongodb.MongoDbContainer

Mongo document-based database container.

classsrc.testcontainers.community.mssql.SqlServerContainer

Microsoft SQL Server database container.

classsrc.testcontainers.community.mysql.MySqlContainer

MySql database container.

classsrc.testcontainers.community.nats.NatsContainer

Nats container.

classsrc.testcontainers.community.openfga.OpenFGAContainer

OpenFGAContainer container.

classsrc.testcontainers.community.oracle.OracleDbContainer

Oracle database container.

classsrc.testcontainers.community.postgres.PostgresContainer

Postgres database container.

classsrc.testcontainers.community.qdrant.QdrantContainer

Qdrant vector database container.

classsrc.testcontainers.community.rabbitmq.RabbitMqContainer

Test container for RabbitMQ.

methodsrc.testcontainers.community.rabbitmq.RabbitMqContainer.readiness_probe() -> bool

Test if the RabbitMQ broker is ready.

methodsrc.testcontainers.community.rabbitmq.RabbitMqContainer.start() -> Self

Start the test container.

classsrc.testcontainers.community.redis.AsyncRedisContainer

Redis container.

classsrc.testcontainers.community.redis.RedisContainer

Redis container.

methodsrc.testcontainers.community.redis.RedisContainer.get_client(**kwargs:object) -> redis.Redis

Get a redis client.

classsrc.testcontainers.community.scylla.ScyllaContainer

Scylla database container.

classsrc.testcontainers.community.selenium.video.SeleniumVideoContainer

Selenium video container.

classsrc.testcontainers.community.sftp.SFTPContainer

Test container for an SFTP server.

classsrc.testcontainers.community.valkey.ValkeyContainer

Valkey container.

methodsrc.testcontainers.community.valkey.ValkeyContainer.get_connection_url() -> str

Get connection URL for Valkey.

methodsrc.testcontainers.community.valkey.ValkeyContainer.get_exposed_port() -> int

Get mapped port.

methodsrc.testcontainers.community.valkey.ValkeyContainer.get_host() -> str

Get container host.

methodsrc.testcontainers.community.valkey.ValkeyContainer.with_image_tag(tag:str) -> Self

Specify Valkey version.

methodsrc.testcontainers.community.valkey.ValkeyContainer.with_password(password:str) -> Self

Configure authentication for Valkey.

classsrc.testcontainers.community.vault.VaultContainer

Vault container.

classsrc.testcontainers.community.weaviate.WeaviateContainer

Weaviate vector database container.

methodsrc.testcontainers.community.weaviate.WeaviateContainer.get_grpc_host() -> str

Get the gRPC host of Weaviate container.

methodsrc.testcontainers.community.weaviate.WeaviateContainer.get_grpc_port() -> int

Get the gRPC port of Weaviate container.

methodsrc.testcontainers.community.weaviate.WeaviateContainer.get_http_host() -> str

Get the HTTP host of Weaviate container.

methodsrc.testcontainers.community.weaviate.WeaviateContainer.get_http_port() -> int

Get the HTTP port of Weaviate container.

classsrc.testcontainers.compose.compose.DockerCompose

Manage docker compose environments.

methodsrc.testcontainers.compose.compose.DockerCompose.start() -> None

Starts the docker compose environment.

methodsrc.testcontainers.compose.compose.DockerCompose.stop(down:bool=True) -> None

Stops the docker compose environment.

methodsrc.testcontainers.compose.compose.DockerCompose.wait_for(url:str) -> Self

Waits for a response from a given URL.

methodsrc.testcontainers.compose.compose.DockerCompose.waiting_for(strategies:dict[str, WaitStrategy]) -> Self

Set wait strategies for specific services.

funcsrc.testcontainers.core.auth.process_docker_auth_config_cred_helpers(auth_config_dict:dict[str, Any]) -> None

Process the credHelpers config.

func

src.testcontainers.core.auth.process_docker_auth_config_encoded(auth_config_dict:dict[str, dict[str, dict[str, Any]]]) -> list[DockerAuthInfo]

Process the auths config.

funcsrc.testcontainers.core.auth.process_docker_auth_config_store(auth_config_dict:dict[str, Any]) -> None

Process the credsStore config.

classsrc.testcontainers.core.container.DockerContainer

Basic container object to spin up Docker instances.

methodsrc.testcontainers.core.container.DockerContainer.get_docker_client() -> DockerClient

:meta private:

methodsrc.testcontainers.core.container.DockerContainer.with_exposed_ports(*ports:Union[str, int]) -> Self

Expose ports from the container without binding them to the host.

methodsrc.testcontainers.core.container.DockerContainer.with_tmpfs_mount(container_path:str, size:Optional[str]=None) -> Self

Mount a tmpfs volume on the container.

classsrc.testcontainers.core.container.Reaper

:meta private:

methodsrc.testcontainers.core.docker_client.DockerClient.bridge_ip(container_id:str) -> str

Get the bridge ip address for a container.

methodsrc.testcontainers.core.docker_client.DockerClient.find_host_network() -> Optional[str]

Try to find the docker host network.

methodsrc.testcontainers.core.docker_client.DockerClient.gateway_ip(container_id:str) -> str

Get the gateway ip address for a container.

methodsrc.testcontainers.core.docker_client.DockerClient.get_connection_mode() -> ConnectionMode

Determine the connection mode.

methodsrc.testcontainers.core.docker_client.DockerClient.get_container(container_id:str) -> dict[str, Any]

Get the container with a given identifier.

methodsrc.testcontainers.core.docker_client.DockerClient.host() -> str

Get the hostname or ip address of the docker host.

methodsrc.testcontainers.core.docker_client.DockerClient.network_name(container_id:str) -> str

Get the name of the network this container runs on

methodsrc.testcontainers.core.docker_client.DockerClient.start(container:Container) -> None

Start a previously created container.

classsrc.testcontainers.core.image.DockerImage

Basic image object to build Docker images.

methodsrc.testcontainers.core.image.DockerImage.remove(force:bool=True, noprune:bool=False) -> None

Remove the image.

classsrc.testcontainers.core.inspect.ContainerAddress

IP address information.

classsrc.testcontainers.core.inspect.ContainerBindOptions

Bind mount options.

classsrc.testcontainers.core.inspect.ContainerBlkioDeviceRate

Block IO device rate configuration.

classsrc.testcontainers.core.inspect.ContainerBlkioWeightDevice

Block IO weight device configuration.

classsrc.testcontainers.core.inspect.ContainerConfig

Container configuration.

classsrc.testcontainers.core.inspect.ContainerDeviceMapping

Device mapping configuration.

classsrc.testcontainers.core.inspect.ContainerDeviceRequest

Device request configuration.

classsrc.testcontainers.core.inspect.ContainerGraphDriver

Graph driver information.

classsrc.testcontainers.core.inspect.ContainerHealth

Container health check information.

classsrc.testcontainers.core.inspect.ContainerHealthcheck

Container healthcheck configuration.

classsrc.testcontainers.core.inspect.ContainerHostConfig

Host configuration for container.

classsrc.testcontainers.core.inspect.ContainerIPAMConfig

IPAM configuration for network.

classsrc.testcontainers.core.inspect.ContainerImageManifestDescriptor

Image manifest descriptor.

classsrc.testcontainers.core.inspect.ContainerImageOptions

Image mount options.

classsrc.testcontainers.core.inspect.ContainerLog

Container health check log entry.

classsrc.testcontainers.core.inspect.ContainerLogConfig

Logging configuration.

classsrc.testcontainers.core.inspect.ContainerMount

Mount information.

classsrc.testcontainers.core.inspect.ContainerMountPoint

Mount point configuration.

classsrc.testcontainers.core.inspect.ContainerNetworkEndpoint

Network endpoint information.

classsrc.testcontainers.core.inspect.ContainerNetworkSettings

Network settings for container.

classsrc.testcontainers.core.inspect.ContainerPlatform

Platform information for image manifest.

classsrc.testcontainers.core.inspect.ContainerPortBinding

Port binding configuration.

classsrc.testcontainers.core.inspect.ContainerRestartPolicy

Restart policy configuration.

classsrc.testcontainers.core.inspect.ContainerState

Container state information.

classsrc.testcontainers.core.inspect.ContainerTmpfsOptions

Tmpfs mount options.

classsrc.testcontainers.core.inspect.ContainerUlimit

Ulimit configuration.

classsrc.testcontainers.core.inspect.ContainerVolumeDriverConfig

Volume driver configuration.

classsrc.testcontainers.core.inspect.ContainerVolumeOptions

Volume mount options.

funcsrc.testcontainers.core.utils.inside_container() -> bool

Returns true if we are running inside a container.

classsrc.testcontainers.core.waiting_utils.WaitStrategy

Base class for all wait strategies.

methodsrc.testcontainers.core.waiting_utils.WaitStrategy.wait_until_ready(container:WaitStrategyTarget) -> None

Wait until the container is ready.

この情報について

掲載しているシグネチャは testcontainers/testcontainers-python の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る