Skip to content

Remind developers about http_cache's unstable format #821

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 15, 2025
Merged

Remind developers about http_cache's unstable format #821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions msal/application.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,10 +495,13 @@ def __init__(

If your app is a command-line app (CLI),
you would want to persist your http_cache across different CLI runs.
The persisted file's format may change due to, but not limited to,
`unstable protocol <https://docs.python.org/3/library/pickle.html#data-stream-format>`_,
so your implementation shall tolerate unexpected loading errors.
The following recipe shows a way to do so::

# Just add the following lines at the beginning of your CLI script
import sys, atexit, pickle
import sys, atexit, pickle, logging
http_cache_filename = sys.argv[0] + ".http_cache"
try:
with open(http_cache_filename, "rb") as f:
Expand All @@ -509,6 +512,9 @@ def __init__(
AttributeError, # Cache created by a different version of MSAL
):
persisted_http_cache = {} # Recover by starting afresh
except: # Unexpected exceptions
logging.exception("You may want to debug this")
persisted_http_cache = {} # Recover by starting afresh
atexit.register(lambda: pickle.dump(
# When exit, flush it back to the file.
# It may occasionally overwrite another process's concurrent write,
Expand Down Expand Up @@ -2012,12 +2018,12 @@ def __init__(
This parameter defaults to None, which means MSAL will not utilize a broker.

New in MSAL Python 1.31.0.

:param boolean enable_broker_on_linux:
This setting is only effective if your app is running on Linux, including WSL.
This parameter defaults to None, which means MSAL will not utilize a broker.

New in MSAL Python 1.33.0.
New in MSAL Python 1.33.0.

:param boolean enable_broker_on_wsl:
This setting is only effective if your app is running on WSL.
Expand Down
6 changes: 6 additions & 0 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ commands =
pip list
{posargs:pytest --color=yes}

[testenv:docs]
deps =
-r docs/requirements.txt
commands =
sphinx-build docs docs/_build

[testenv:azcli]
deps =
azure-cli
Expand Down