Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Resolve configdir so that it's not a symlink when is_dir() is called #28818

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
tacaswell merged 2 commits into from
Sep 16, 2024
Merged

Resolve configdir so that it's not a symlink when is_dir() is called #28818

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
957271f
Resolve configdir to handle potential issues with inaccessible symlinks
hintron Sep 13, 2024
8837d9a
Print warning when mkdir fails instead of silently ignoring the error
hintron Sep 14, 2024
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
17 changes: 10 additions & 7 deletions 17 lib/matplotlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,35 +519,38 @@ def _get_xdg_cache_dir():
def _get_config_or_cache_dir(xdg_base_getter):
configdir = os.environ.get('MPLCONFIGDIR')
if configdir:
configdir = Path(configdir).resolve()
configdir = Path(configdir)
elif sys.platform.startswith(('linux', 'freebsd')):
# Only call _xdg_base_getter here so that MPLCONFIGDIR is tried first,
# as _xdg_base_getter can throw.
configdir = Path(xdg_base_getter(), "matplotlib")
else:
configdir = Path.home() / ".matplotlib"
# Resolve the path to handle potential issues with inaccessible symlinks.
configdir = configdir.resolve()
try:
configdir.mkdir(parents=True, exist_ok=True)
except OSError:
pass
except OSError as exc:
_log.warning("mkdir -p failed for path %s: %s", configdir, exc)
else:
if os.access(str(configdir), os.W_OK) and configdir.is_dir():
return str(configdir)
_log.warning("%s is not a writable directory", configdir)
# If the config or cache directory cannot be created or is not a writable
# directory, create a temporary one.
try:
tmpdir = tempfile.mkdtemp(prefix="matplotlib-")
except OSError as exc:
raise OSError(
f"Matplotlib requires access to a writable cache directory, but the "
f"default path ({configdir}) is not a writable directory, and a temporary "
f"Matplotlib requires access to a writable cache directory, but there "
f"was an issue with the default path ({configdir}), and a temporary "
f"directory could not be created; set the MPLCONFIGDIR environment "
f"variable to a writable directory") from exc
os.environ["MPLCONFIGDIR"] = tmpdir
atexit.register(shutil.rmtree, tmpdir)
_log.warning(
"Matplotlib created a temporary cache directory at %s because the default path "
"(%s) is not a writable directory; it is highly recommended to set the "
"Matplotlib created a temporary cache directory at %s because there was "
"an issue with the default path (%s); it is highly recommended to set the "
"MPLCONFIGDIR environment variable to a writable directory, in particular to "
"speed up the import of Matplotlib and to better support multiprocessing.",
tmpdir, configdir)
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.