This document describes the current stable version of pytest_celery (1.0). For development docs, go here.
pytest_celery.vendors.redis.broker package¶
Submodules¶
pytest_celery.vendors.redis.broker.api module¶
The pytest-celery plugin provides a set of built-in components called Vendors.
This module is part of the Redis Broker vendor.
- class pytest_celery.vendors.redis.broker.api.RedisTestBroker(container: CeleryTestContainer, app: Celery = None)[source]¶
Bases:
CeleryTestBroker
pytest_celery.vendors.redis.broker.defaults module¶
The pytest-celery plugin provides a set of built-in components called Vendors.
This module is part of the Redis Broker vendor.
pytest_celery.vendors.redis.broker.fixtures module¶
The pytest-celery plugin provides a set of built-in components called Vendors.
This module is part of the Redis Broker vendor.
- pytest_celery.vendors.redis.broker.fixtures.celery_redis_broker(default_redis_broker: RedisContainer) RedisTestBroker[source]¶
Creates a RedisTestBroker instance. Responsible for tearing down the node.
- Parameters:
default_redis_broker (RedisContainer) – Instantiated RedisContainer.
- pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_cls() type[RedisContainer][source]¶
Default Redis broker container class. Override to apply custom configuration globally.
See also: Vendor Class.
- Returns:
API for managing the vendor’s container.
- Return type:
- pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_command(default_redis_broker_cls: type[RedisContainer]) list[str][source]¶
Command to run the container.
- Parameters:
default_redis_broker_cls (type[RedisContainer]) – See also: Vendor Class.
- Returns:
Docker CMD instruction.
- Return type:
- pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_env(default_redis_broker_cls: type[RedisContainer]) dict[source]¶
Environment variables for this vendor.
- Parameters:
default_rabbitmq_broker_cls (type[RedisContainer]) – See also: Vendor Class.
- Returns:
Items to pass to the container’s environment.
- Return type:
- pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_image(default_redis_broker_cls: type[RedisContainer]) str[source]¶
Sets the image name for this vendor.
- Parameters:
default_rabbitmq_broker_cls (type[RedisContainer]) – See also: Vendor Class.
- Returns:
Docker image name.
- Return type:
- pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_ports(default_redis_broker_cls: type[RedisContainer]) dict[source]¶
Port bindings for this vendor.
- Parameters:
default_redis_broker_cls (type[RedisContainer]) – See also: Vendor Class.
- Returns:
Port bindings.
- Return type:
Module contents¶
The pytest-celery plugin provides a set of built-in components called Vendors.
This module is part of the Redis Broker vendor.
