DOC: clarify unsupported caching sessions - #2846
Open
ikejourney wants to merge 1 commit into
Open
Conversation
Collaborator
|
Is this redundant after #2910 ? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2486.
Summary
Clarify that caching sessions such as
requests_cache.CachedSessionare unsupported.The current code already rejects sessions with a
.cacheattribute. This updates the exception text and the advanced caching docs to explain why those sessions are not supported with yfinance'scurl_cffisession handling, and points users toward yfinance's built-in persistent cache configuration instead.This also adds a small regression test for the caching-session rejection path.
Tests
python3 -m py_compile yfinance/data.py tests/test_http.pygit diff --checkCould not run the target unittest locally because this environment is missing repository dependencies (
requests/pandas).