Skip to content

MNT: move matplotlibrc.template to mpl-data #19602

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

Closed

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Feb 28, 2021

PR Summary

Alternative to #19588, closes #19578

This simply makes lib/matplotlib/mpl-data/matplotlibrc the file under source control and soft-links back to matplotlibrc.template. setup.py now modifies the file in place if the backend needs to be edited.

More detail:

Previously matplotlibrc.template was changed in #15029 to be the canonical place to get the defaults for all the rcParams. However, these were read during __init__.py from lib/matplotlib/mpl-data/matplotlibrc. lib/matplotlib/mpl-data/matplotlibrc doesn't exist in the repo, and only gets created when setup.py is called. We can't read the defaults from matplotlbrc.template because that file probably doesn't exist in most user installs.

Aside from being somewhat rickety, the problem is that developers working from an editable install don't want to always call setup.py as it requires compiling the C extensions, and hence their lib/matplotlib/mpl-data/matplotlibrc can get out of sync with the library.

The solution here is to simply make lib/matplotlib/mpl-data/matplotlibrc the canonical source of the defaults, add it to version control, and softlink it to matplotlib.template. setup.py can change lib/matplotlib/mpl-data/matplotlibrc in-place (I think)

See also:

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@jklymak jklymak mentioned this pull request Feb 28, 2021
7 tasks
@anntzer anntzer mentioned this pull request Feb 28, 2021
7 tasks
@jklymak
Copy link
Member Author

jklymak commented Feb 28, 2021

Closing for #19603

@jklymak jklymak closed this Feb 28, 2021
@jklymak jklymak deleted the mnt-make-matplotlibrc-version-control branch February 28, 2021 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bisect very hard with rcParam changes
1 participant