This document describes the current stable version of pytest_celery (1.0). For development docs, go here.

pytest_celery.vendors.redis.backend package

Submodules

pytest_celery.vendors.redis.backend.api module

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

This module is part of the Redis Backend vendor.

class pytest_celery.vendors.redis.backend.api.RedisTestBackend(container: CeleryTestContainer, app: Celery = None)

Bases: CeleryTestBackend

teardown() → None

Teardown the node.

pytest_celery.vendors.redis.backend.defaults module

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

This module is part of the Redis Backend vendor.

pytest_celery.vendors.redis.backend.fixtures module

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

This module is part of the Redis Backend vendor.

pytest_celery.vendors.redis.backend.fixtures.celery_redis_backend(default_redis_backend: RedisContainer) → RedisTestBackend

Creates a RedisTestBackend instance. Responsible for tearing down the node.

Parameters:

default_redis_backend (RedisContainer) – Instantiated RedisContainer.

pytest_celery.vendors.redis.backend.fixtures.default_redis_backend_cls() → type[RedisContainer]

Default Redis backend 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.backend.fixtures.default_redis_backend_command(default_redis_backend_cls: type[RedisContainer]) → list[str]

Command to run the container.

Parameters:

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

Returns:

Docker CMD instruction.

Return type:

list[str]

pytest_celery.vendors.redis.backend.fixtures.default_redis_backend_env(default_redis_backend_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.backend.fixtures.default_redis_backend_image(default_redis_backend_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.backend.fixtures.default_redis_backend_ports(default_redis_backend_cls: type[RedisContainer]) → dict

Port bindings for this vendor.

Parameters:

default_redis_backend_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 Backend vendor.