celery cannot be an optional dependency but celery extra's can

Author: woutdenolf

.readthedocs.yaml

@@ -17,7 +17,7 @@ build:
       # Tell poetry to not use a virtual environment
       - poetry config virtualenvs.create false
     post_install:
-      - poetry install -E "celery" --with docs
+      - poetry install -E "full" --with docs
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:

docs/includes/installation.txt

@@ -11,11 +11,12 @@ To install using :command:`pip`:
 
     $ pip install -U pytest-celery
 
-To include the latest celery package, install with the ``celery`` extra:
+To include optional celery dependencies for redis and memcached support,
+install with the ``full`` extra:
 
 .. code-block:: console
 
-    $ pip install -U "pytest-celery[celery]"
+    $ pip install -U "pytest-celery[full]"
 
 With git
 ~~~~~~~~

examples/django/requirements.txt

@@ -1,5 +1,5 @@
 sqlalchemy>=1.2.18
 django>=2.2.1
 pytest-django>=4.7.0
-pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
+pytest-celery[full]@git+https://github.com/celery/pytest-celery.git
 pytest-xdist>=3.5.0

examples/myworker/requirements.txt

@@ -1,3 +1,3 @@
 pytest>=7.4.4
-pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
+pytest-celery[full]@git+https://github.com/celery/pytest-celery.git
 pytest-xdist>=3.5.0

examples/rabbitmq_management/requirements.txt

@@ -1,3 +1,3 @@
 pytest>=7.4.4
-pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
+pytest-celery[full]@git+https://github.com/celery/pytest-celery.git
 pytest-xdist>=3.5.0

examples/range/requirements.txt

@@ -1,4 +1,4 @@
 pytest>=7.4.4
-pytest-celery[celery]@git+https://github.com/celery/pytest-celery.git
+pytest-celery[full]@git+https://github.com/celery/pytest-celery.git
 pytest-xdist>=3.5.0
 pytest-subtests>=0.11.0

poetry.lock

@@ -73,18 +73,18 @@ replace = ':Version: {new_version}'
 
 [tool.poetry.dependencies]
 python = ">= 3.8,<4.0"
-celery = { version = "<6.0.0", extras = [
-    "redis",
-    "pymemcache",
-], optional = true }
+celery = [
+    { version = "<6.0.0" },
+    { version = "<6.0.0", extras = ["redis", "pymemcache"], markers = "extra == 'full'" }
+]
 retry = "^0.9.2"
 pytest-docker-tools = "^3.1.3"
 docker = "^7.0.0"
 psutil = "^5.9.7"
 setuptools = "^69.1.0"
 
 [tool.poetry.extras]
-celery = ["celery"]
+full = []
 
 [tool.poetry.group.dev]
 

pyproject.toml

@@ -24,17 +24,27 @@
 from pytest_celery.fixtures.broker import *
 from pytest_celery.fixtures.setup import *
 from pytest_celery.fixtures.worker import *
-from pytest_celery.vendors.memcached.api import *
-from pytest_celery.vendors.memcached.container import *
-from pytest_celery.vendors.memcached.fixtures import *
+from pytest_celery.vendors import MissingCeleryDependency
 from pytest_celery.vendors.rabbitmq.api import *
 from pytest_celery.vendors.rabbitmq.container import *
 from pytest_celery.vendors.rabbitmq.fixtures import *
-from pytest_celery.vendors.redis.backend.api import *
-from pytest_celery.vendors.redis.backend.fixtures import *
-from pytest_celery.vendors.redis.broker.api import *
-from pytest_celery.vendors.redis.broker.fixtures import *
-from pytest_celery.vendors.redis.container import *
+
+try:
+    from pytest_celery.vendors.memcached.api import *
+    from pytest_celery.vendors.memcached.container import *
+    from pytest_celery.vendors.memcached.fixtures import *
+except MissingCeleryDependency:
+    pass
+
+try:
+    from pytest_celery.vendors.redis.backend.api import *
+    from pytest_celery.vendors.redis.backend.fixtures import *
+    from pytest_celery.vendors.redis.broker.api import *
+    from pytest_celery.vendors.redis.broker.fixtures import *
+    from pytest_celery.vendors.redis.container import *
+except MissingCeleryDependency:
+    pass
+
 from pytest_celery.vendors.worker.container import *
 from pytest_celery.vendors.worker.fixtures import *
 

src/pytest_celery/__init__.py

@@ -4,18 +4,35 @@
 
 from pytest_docker_tools import network
 
-from pytest_celery.vendors.memcached.defaults import CELERY_MEMCACHED_BACKEND
-from pytest_celery.vendors.memcached.defaults import *
+from pytest_celery.vendors import MissingCeleryDependency
 from pytest_celery.vendors.rabbitmq.defaults import CELERY_RABBITMQ_BROKER
 from pytest_celery.vendors.rabbitmq.defaults import *
-from pytest_celery.vendors.redis.backend.defaults import CELERY_REDIS_BACKEND
-from pytest_celery.vendors.redis.backend.defaults import *
-from pytest_celery.vendors.redis.broker.defaults import CELERY_REDIS_BROKER
-from pytest_celery.vendors.redis.broker.defaults import *
-from pytest_celery.vendors.redis.defaults import *
 from pytest_celery.vendors.worker.defaults import CELERY_SETUP_WORKER
 from pytest_celery.vendors.worker.defaults import *
 
+try:
+    import pytest_celery.vendors.memcached
+except MissingCeleryDependency:
+    _CELERY_MEMCACHED_BACKEND = None
+else:
+    from pytest_celery.vendors.memcached.defaults import CELERY_MEMCACHED_BACKEND as _CELERY_MEMCACHED_BACKEND
+    from pytest_celery.vendors.memcached.defaults import *
+
+    _CELERY_MEMCACHED_BACKEND = None  # Beta support at the moment, to be used manually
+
+try:
+    import pytest_celery.vendors.redis
+except MissingCeleryDependency:
+    _CELERY_REDIS_BACKEND = None
+    _CELERY_REDIS_BROKER = None
+else:
+    from pytest_celery.vendors.redis.backend.defaults import CELERY_REDIS_BACKEND as _CELERY_REDIS_BACKEND
+    from pytest_celery.vendors.redis.backend.defaults import *
+    from pytest_celery.vendors.redis.broker.defaults import CELERY_REDIS_BROKER as _CELERY_REDIS_BROKER
+    from pytest_celery.vendors.redis.broker.defaults import *
+    from pytest_celery.vendors.redis.defaults import *
+
+
 ####################################################################################
 # Automatic components
 ####################################################################################
@@ -29,14 +46,8 @@
 # Tests that do not rely on default parametrization will not be affected.
 
 ALL_CELERY_WORKERS = (CELERY_SETUP_WORKER,)
-ALL_CELERY_BACKENDS = (
-    CELERY_REDIS_BACKEND,
-    # CELERY_MEMCACHED_BACKEND,  # Beta support at the moment, to be used manually
-)
-ALL_CELERY_BROKERS = (
-    CELERY_REDIS_BROKER,
-    CELERY_RABBITMQ_BROKER,
-)
+ALL_CELERY_BACKENDS = (backend for backend in [_CELERY_REDIS_BACKEND, _CELERY_MEMCACHED_BACKEND] if backend is not None)
+ALL_CELERY_BROKERS = (broker for broker in [CELERY_RABBITMQ_BROKER, _CELERY_REDIS_BROKER] if broker is not None)
 
 ####################################################################################
 # Fixtures