The Fix
pip install redis==7.1.0
Based on closed redis/redis-py issue #1839 · PR/commit linked
Production note: Most teams hit this during upgrades or environment changes. Roll out with a canary and smoke critical endpoints (health, OpenAPI/docs) before 100%.
@@ -0,0 +1,30 @@
@@ -0,0 +1,30 @@
+Redis Commands
+##############
+
Option A — Upgrade to fixed release\npip install redis==7.1.0\nWhen NOT to use: This fix is not applicable if the documentation structure changes again.\n\n
Why This Fix Works in Production
- Trigger: Is this change intentional and importing from `redis.client` now best-practice? If so, a mention in the release notes would be helpful! If not, it would be…
- Mechanism: Documentation fixes to ensure linking various types of connections and address issue #1839.
- Why the fix works: Documentation fixes to ensure linking various types of connections and address issue #1839. (first fixed release: 7.1.0).
- If left unfixed, the same config can fail only in production (env differences), causing startup failures or partial feature outages.
Why This Breaks in Prod
- Production symptom (often without a traceback): Is this change intentional and importing from `redis.client` now best-practice? If so, a mention in the release notes would be helpful! If not, it would be great to document the shorter alias again 😁
Proof / Evidence
- GitHub issue: #1839
- Fix PR: https://github.com/redis/redis-py/pull/1841
- First fixed release: 7.1.0
- Reproduced locally: No (not executed)
- Last verified: 2026-02-09
- Confidence: 0.85
- Did this fix it?: Yes (upstream fix exists)
- Own content ratio: 0.68
Discussion
High-signal excerpts from the issue thread (symptoms, repros, edge-cases).
“@Zac-HD Perfect, thank you for the pointers. Unfortunately this would be going into master so it would appear in **latest** rather that **stable**. I'll cross-link…”
“@Zac-HD just to make sure is this the project? redis.Redis is definitely the right thing to import, though the files have been in redis.client for…”
“That's right; this docstring ends up on this page of our docs (and here's a failing CI build). Sounds like this is just a Sphinx…”
Failure Signature (Search String)
- Is this change intentional and importing from `redis.client` now best-practice? If so, a mention in the release notes would be helpful! If not, it would be great to document the
- Sounds like this is just a Sphinx config thing then; changing `.. autoclass:: redis.client.Redis` to `.. autoclass:: redis.Redis` might even be sufficient?
Copy-friendly signature
Failure Signature
-----------------
Is this change intentional and importing from `redis.client` now best-practice? If so, a mention in the release notes would be helpful! If not, it would be great to document the shorter alias again 😁
Sounds like this is just a Sphinx config thing then; changing `.. autoclass:: redis.client.Redis` to `.. autoclass:: redis.Redis` might even be sufficient?
Error Message
Signature-only (no traceback captured)
Error Message
-------------
Is this change intentional and importing from `redis.client` now best-practice? If so, a mention in the release notes would be helpful! If not, it would be great to document the shorter alias again 😁
Sounds like this is just a Sphinx config thing then; changing `.. autoclass:: redis.client.Redis` to `.. autoclass:: redis.Redis` might even be sufficient?
What Broke
Documentation build fails due to unresolved links, impacting users relying on accurate documentation.
Fix Options (Details)
Option A — Upgrade to fixed release Safe default (recommended)
pip install redis==7.1.0
Use when you can deploy the upstream fix. It is usually lower-risk than long-lived workarounds.
Fix reference: https://github.com/redis/redis-py/pull/1841
First fixed release: 7.1.0
Last verified: 2026-02-09. Validate in your environment.
When NOT to Use This Fix
- This fix is not applicable if the documentation structure changes again.
Did This Fix Work in Your Case?
Quick signal helps us prioritize which fixes to verify and improve.
Prevention
- Capture the exact failing error string in logs and tests so you can reproduce via a minimal script.
- Pin production dependencies and upgrade only with a reproducible test that hits the failing path.
Version Compatibility Table
| Version | Status |
|---|---|
| 7.1.0 | Fixed |
Related Issues
No related fixes found.
Sources
We don’t republish the full GitHub discussion text. Use the links above for context.