This document is for pytest_celery's development version, which can be significantly different from previous releases. Get the stable docs here: 1.1.

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)

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

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]

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:

type[RedisContainer]

pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_command(default_redis_broker_cls: type[RedisContainer]) → list[str]

Command to run the container.

Parameters:

default_redis_broker_cls (type[RedisContainer]) – See also: Vendor Class.

Returns:

Docker CMD instruction.

Return type:

list[str]

pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_env(default_redis_broker_cls: type[RedisContainer]) → dict

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:

dict

pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_image(default_redis_broker_cls: type[RedisContainer]) → str

Sets the image name for this vendor.

Parameters:

default_rabbitmq_broker_cls (type[RedisContainer]) – See also: Vendor Class.

Returns:

Docker image name.

Return type:

str

pytest_celery.vendors.redis.broker.fixtures.default_redis_broker_ports(default_redis_broker_cls: type[RedisContainer]) → dict

Port bindings for this vendor.

Parameters:

default_redis_broker_cls (type[RedisContainer]) – See also: Vendor Class.

Returns:

Port bindings.

Return type:

dict

Module contents

The pytest-celery plugin provides a set of built-in components called Vendors.

This module is part of the Redis Broker vendor.