Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix docs for password protected socket access #2378

Merged
merged 2 commits into from
Nov 7, 2022

Conversation

hofrob
Copy link
Contributor

@hofrob hofrob commented Sep 11, 2022

Pull Request check-list

Please make sure to review and check all of these items:

  • Does $ tox pass with this change (including linting)?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?
  • 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-commenter
Copy link

codecov-commenter commented Sep 11, 2022

Codecov Report

Base: 92.04% // Head: 92.03% // Decreases project coverage by -0.00% ⚠️

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%) ⬇️
tests/test_asyncio/test_pubsub.py 99.37% <0.00%> (-0.16%) ⬇️
tests/test_cluster.py 96.96% <0.00%> (ø)
tests/test_asyncio/test_cluster.py 97.42% <0.00%> (+0.13%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@chayim chayim added the maintenance Maintenance (CI, Releases, etc) label Sep 15, 2022
@chayim
Copy link
Contributor

chayim commented Nov 7, 2022

Thanks @hofrob for helping improve the documentation! This is great ❤️

@chayim chayim merged commit ab922db into redis:master Nov 7, 2022
@hofrob hofrob deleted the fix-docs-password-unix-socket branch November 9, 2022 00:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance (CI, Releases, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants