DOC: document the issues with overlaying new mpl on old mpl #29673
Conversation
|
Can this maybe get added to the FAQ since it's relatively common? |
| of a version of Matplotlib < 3.8 (e.g. via ``pip install --local`` or | ||
| ``python -m venv --system-site-packages ...``) will fail because the old | ||
| `matplotlib.mpl_toolkits` files will be found where as the newer files will be | ||
| found for all other modules. This will result in errors due to the version |
There was a problem hiding this comment.
Is there anything we can do about this? eg somehow clean out the old files on pip install, I guess by overwriting them with empty files?
Or barring that, it would be helpful if we suggested to users what they should do about this. I'm not even sure pip uninstall matplotlib will clean the mpl_toolkits files out.
There was a problem hiding this comment.
The issue is the "overlaying". If the old version of Matplotlib is in the venv (and hence the users has write) then pip takes care of itself, but if you are exposed to a read-only set of files then there is nothing we can do.
Even if there was something to do, it would be pip's job not ours.
There was a problem hiding this comment.
This is still a bit mysterious, and I don't think I am in a low percentile of our user's sophistication in installing python packages, so can we be more clear? Is this primarily happening when the operating system has packaged matplotlib as part of the distribution (or apt-install etc), and then the user's pip-install doesn't replace mpl-toolkits in the distribution's version of Matplotlib? If that is the most common case, can we just say something like that, while leaving open the possibility that the installation got crossed other ways.
There was a problem hiding this comment.
Is this primarily happening when the operating system has packaged matplotlib as part of the distribution (or apt-install etc), and then the user's pip-install doesn't replace mpl-toolkits in the distribution's version of Matplotlib?
Yes, that is the common (and likely only?) case.
Co-authored-by: Jody Klymak <jklymak@gmail.com>
| As a consequence using ``pip`` to install a version of Matplotlib >= 3.8 on top | ||
| of a version of Matplotlib < 3.8 (e.g. via ``pip install --local`` or | ||
| ``python -m venv --system-site-packages ...``) will fail because the old |
There was a problem hiding this comment.
Maybe:
| As a consequence using ``pip`` to install a version of Matplotlib >= 3.8 on top | |
| of a version of Matplotlib < 3.8 (e.g. via ``pip install --local`` or | |
| ``python -m venv --system-site-packages ...``) will fail because the old | |
| As a consequence using ``pip`` to install a version of Matplotlib >= 3.8 on top | |
| of a version of Matplotlib < 3.8 (e.g. installed using a system package manager | |
| like ``apt install ...``, or via ``pip install --local`` or | |
| ``python -m venv --system-site-packages ...``) will fail because the old |
where as -> whereas miss-match -> mismatch Thanks to @Mecanerd for these suggestions Co-authored-by: Mecanerd <joshdonath23@hotmail.com>
…g new mpl on old mpl
…673-on-v3.10.x Backport PR #29673 on branch v3.10.x (DOC: document the issues with overlaying new mpl on old mpl)
closes #26827