redis
fix docs for password protected socket access
Pull Request check-list
Please make sure to review and check all of these items:
- [x] Does
$ toxpass with this change (including linting)? - [x] Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
- [x] ~~Is the new or changed code fully tested?~~
- [X] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
- [x] ~~Is there an example added to the examples folder (if applicable)?~~
- [X] Was the change added to CHANGES file?
NOTE: these things are not required to open a PR and can be done afterwards / while the PR is open.
Description of change
In #2374 @dvora-h answered my confusion regarding connecting to a password protected redis server using a unix socket. This change adapts the documentation of the from_url methods to reflect this.
The password needs to be added as a GET parameter. The user still needs to be handed over as part of the URL auth part.
Codecov Report
Base: 92.04% // Head: 92.03% // Decreases project coverage by -0.00% :warning:
Coverage data is based on head (
2854974) compared to base (16270e4). Patch has no changes to coverable lines.
Additional details and impacted files
@@ Coverage Diff @@
## master #2378 +/- ##
==========================================
- Coverage 92.04% 92.03% -0.01%
==========================================
Files 110 110
Lines 28705 28705
==========================================
- Hits 26421 26420 -1
- Misses 2284 2285 +1
| Impacted Files | Coverage Δ | |
|---|---|---|
| redis/asyncio/client.py | 92.22% <ø> (ø) |
|
| redis/asyncio/connection.py | 86.38% <ø> (ø) |
|
| redis/client.py | 89.06% <ø> (ø) |
|
| redis/cluster.py | 89.85% <ø> (ø) |
|
| redis/connection.py | 86.30% <ø> (ø) |
|
| tests/test_asyncio/test_search.py | 98.26% <0.00%> (-0.35%) |
:arrow_down: |
| tests/test_asyncio/test_pubsub.py | 99.37% <0.00%> (-0.16%) |
:arrow_down: |
| tests/test_cluster.py | 96.96% <0.00%> (ø) |
|
| tests/test_asyncio/test_cluster.py | 97.42% <0.00%> (+0.13%) |
:arrow_up: |
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.
:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.
