Skip to content

Defer checking of tex install to when it is actually used. #13285

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

Merged
merged 1 commit into from
Jan 28, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jan 25, 2019

The call to checkdep_usetex() in __init__.py doesn't help for people
explicitly passing usetex=True. Moreover, it slows down import time
for those who do have text.usetex set to True in their rcfile by ~20ms
(when timing this, note that checkdep_ghostscript (which checkdep_usetex
calls) has a cache, which should be disabled for timing purposes.

Moreover, checkdep_usetex is overly broad, always requiring dvipng
(which is not required for pdf/ps output) and ghostscript (which is not
required for raster output).

Instead, move the check to texmanager.py, which will provide a more
meaningful error message to end users, speed up import time (20ms is
similar to the import time of pyparsing or urllib.request, for example)
and avoid the inaccuracies above.

xref #13284 (if the OP indeed is missing a tex installation).

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

The call to checkdep_usetex() in `__init__.py` doesn't help for people
explicitly passing usetex=True.  Moreover, it slows down import time
for those who *do* have text.usetex set to True in their rcfile by ~20ms
(when timing this, note that checkdep_ghostscript (which checkdep_usetex
calls) has a cache, which should be disabled for timing purposes.

Moreover, checkdep_usetex is overly broad, always requiring dvipng
(which is not required for pdf/ps output) and ghostscript (which is not
required for raster output).

Instead, move the check to texmanager.py, which will provide a more
meaningful error message to end users, speed up import time (20ms is
similar to the import time of pyparsing or urllib.request, for example)
and avoid the inaccuracies above.
@anntzer anntzer mentioned this pull request Jan 28, 2019
6 tasks
@timhoffm timhoffm merged commit d7c6c5b into matplotlib:master Jan 28, 2019
@anntzer anntzer deleted the texcheck branch January 28, 2019 21:37
@QuLogic QuLogic added this to the v3.1 milestone Jan 28, 2019
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.

4 participants