Do not install Celery by default, use extra [celery] instead (#172)

* Set optional = true for celery package and limit "< v6.x.x"

* Added -E "celery" to tox environments

* Added -E "celery" to .readthedocs.yaml

* Added "#egg=pytest-celery[celery]" to the examples requirements.txt (expected to fail until changes are merged to main)

* Hotfix/Cleanup in src/pytest_celery/vendors/worker/Dockerfile

* Updated poetry.lock

.readthedocs.yaml

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

examples/django/requirements.txt

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

examples/myworker/requirements.txt

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

examples/rabbitmq_management/requirements.txt

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

examples/range/requirements.txt

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

pyproject.toml

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

src/pytest_celery/vendors/worker/Dockerfile

@@ -22,7 +22,7 @@ ENV PYTHONDONTWRITEBYTECODE=1
 # Install Python dependencies
 RUN pip install --no-cache-dir --upgrade \
     pip \
-    celery[redis,memcache,pymemcache]${WORKER_VERSION:+==$WORKER_VERSION} \
+    celery[redis,pymemcache]${WORKER_VERSION:+==$WORKER_VERSION} \
     psutil
 
 # The workdir must be /app

tox.ini

@@ -24,7 +24,7 @@ setenv =
     PYTHONUNBUFFERED = 1
     PYTHONDONTWRITEBYTECODE = 1
 commands_pre =
-    poetry install --with dev,test
+    poetry install -E "celery" --with dev,test
 commands =
     unit: poetry run pytest tests/unit/ --maxfail=3 {posargs}
     integration: poetry run pytest tests/integration/ --exitfirst --dist=loadscope {posargs}
@@ -70,7 +70,7 @@ commands =
 [testenv:mypy]
 description = Run mypy using {basepython}
 commands_pre =
-    poetry install --only dev
+    poetry install -E "celery" --only dev
     poetry run mypy --install-types --non-interactive
 commands =
     poetry run mypy --config-file pyproject.toml
@@ -79,7 +79,7 @@ commands =
 description = Run code+doc lint using {basepython}
 allowlist_externals = poetry, make
 commands_pre =
-    poetry install --with dev,docs
+    poetry install -E "celery" --with dev,docs
 commands =
     poetry run pre-commit {posargs:run --all-files --show-diff-on-failure}
     make -C ./docs apicheck
@@ -90,7 +90,7 @@ commands =
 description = Clean up build and test artifacts using {basepython}
 allowlist_externals = poetry, pytest, bash, find, make
 commands_pre =
-    poetry install --only dev
+    poetry install -E "celery" --only dev
 commands =
     poetry run cleanpy .
     make -C ./docs clean
@@ -103,22 +103,22 @@ commands =
 description = Build docs using {basepython}
 allowlist_externals = poetry, make
 commands_pre =
-    poetry install --with docs
+    poetry install -E "celery" --with docs
 commands =
     make -C ./docs html
 
 [testenv:docs-livehtml]
 description = Build docs using {basepython} and serve in http://0.0.0.0:7010
 allowlist_externals = poetry, make
 commands_pre =
-    poetry install --with docs
+    poetry install -E "celery" --with docs
 commands =
     make -C ./docs livehtml
 
 [testenv:docs-apidoc]
 description = Regenerate API Reference doc section using {basepython}
 allowlist_externals = poetry, make
 commands_pre =
-    poetry install --with docs
+    poetry install -E "celery" --with docs
 commands =
     make -C ./docs apidoc