Delay LaTeX feature tests as long as possible #39430
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This does nothing, except waste your time trying to ensure that it is consistent with the "engine" property and that It iS PrOpErLy CapItALizEd.
This delays probing the default engine (which tries to compile some LaTeX code in a temporary directory) when you merely wish to query e.g. the matrix delimiters. A later commit will re-insert the probe at a later point. The doctest for the options dict was updated to print a sorted list of items, so now its output is no longer random.
When we try to find the current LaTeX engine, the preferences dict will now have __options["engine"] == None to indicate that we should fall back to the default engine. In each case we check for None, and invoke default_engine() only if necessary. This allows us to query the options dict without triggering the expensive is_functional() method for the LaTeX features.
user202729
reviewed
Feb 2, 2025
We should not need to test the functionality of various engines before we can e.g. obtain the latex representation of a matrix. We add a doctest to ensure that this is the case. Closes sagemathGH-39351
This function is relatively new and is only used in sage.misc.latex. I don't think there is a compelling need to have it as part of the public API, so let's give it an underscore.
orlitzky
force-pushed
the
lazier-latex-feature-tests-pr
branch
from
8dcf996 to
8ed829c
Compare
|
Force push was to change |
|
Documentation preview for this PR (built with commit 6eed1bc; changes) is ready! 🎉 |
|
The conda CI failure is unrelated |
kwankyu
reviewed
Feb 2, 2025
In case anyone is using this, we avoid removing it (or changing its return type) by surprise, and instead deprecate it. changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # # On branch lazier-latex-feature-tests # Changes to be committed: # modified: src/sage/misc/latex.py #
This function no longer returns the stylized engine name, so its docstring needs an update to reflect that.
kwankyu
reviewed
Feb 3, 2025
(This appeases pycodestyle, and makes the docstring endings more consistent.)
|
I suggest posting the semantic change on the latex preferences in https://github.com/sagemath/sage/wiki/Sage-10.6-Release-Tour |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 4, 2025
sagemathgh-39430: Delay LaTeX feature tests as long as possible We shouldn't need a functional LaTeX engine to turn the matrix `[1]` into `\left(\begin{array}{r}1\end{array}\right)`. We used to try; now we don't. (This avoids compiling a test document in a temporary directory.) There's some other cleanup at the same time, but the basic idea is to avoid putting the result `default_engine()` in the preferences dict when the preferences dict is constructed. Instead, we now leave the "engine" option set to `None` by default. Inside the functions where latex is actually used, we check... 1. Did the user pass `engine=whatever` to this function? 2. If not, is the "engine" option set in the preferences dict? 3. If not, use the default engine. So `foo(engine=bar)` overrides the preferences dict, and the preferences dict overrides `default_engine()`. Closes: * sagemath#39351 URL: sagemath#39430 Reported by: Michael Orlitzky Reviewer(s): Kwankyu Lee, Michael Orlitzky, user202729
|
Thank you both.
I don't think there is a semantic change? You can still set |
I meant this. Some may be confused with " Anyway, that is a mild suggestion. |
Done! |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 9, 2025
sagemathgh-39430: Delay LaTeX feature tests as long as possible We shouldn't need a functional LaTeX engine to turn the matrix `[1]` into `\left(\begin{array}{r}1\end{array}\right)`. We used to try; now we don't. (This avoids compiling a test document in a temporary directory.) There's some other cleanup at the same time, but the basic idea is to avoid putting the result `default_engine()` in the preferences dict when the preferences dict is constructed. Instead, we now leave the "engine" option set to `None` by default. Inside the functions where latex is actually used, we check... 1. Did the user pass `engine=whatever` to this function? 2. If not, is the "engine" option set in the preferences dict? 3. If not, use the default engine. So `foo(engine=bar)` overrides the preferences dict, and the preferences dict overrides `default_engine()`. Closes: * sagemath#39351 URL: sagemath#39430 Reported by: Michael Orlitzky Reviewer(s): Kwankyu Lee, Michael Orlitzky, user202729
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 9, 2025
sagemathgh-39430: Delay LaTeX feature tests as long as possible We shouldn't need a functional LaTeX engine to turn the matrix `[1]` into `\left(\begin{array}{r}1\end{array}\right)`. We used to try; now we don't. (This avoids compiling a test document in a temporary directory.) There's some other cleanup at the same time, but the basic idea is to avoid putting the result `default_engine()` in the preferences dict when the preferences dict is constructed. Instead, we now leave the "engine" option set to `None` by default. Inside the functions where latex is actually used, we check... 1. Did the user pass `engine=whatever` to this function? 2. If not, is the "engine" option set in the preferences dict? 3. If not, use the default engine. So `foo(engine=bar)` overrides the preferences dict, and the preferences dict overrides `default_engine()`. Closes: * sagemath#39351 URL: sagemath#39430 Reported by: Michael Orlitzky Reviewer(s): Kwankyu Lee, Michael Orlitzky, user202729
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We shouldn't need a functional LaTeX engine to turn the matrix
[1]into\left(\begin{array}{r}1\end{array}\right). We used to try; now we don't. (This avoids compiling a test document in a temporary directory.)There's some other cleanup at the same time, but the basic idea is to avoid putting the result
default_engine()in the preferences dict when the preferences dict is constructed. Instead, we now leave the "engine" option set toNoneby default. Inside the functions where latex is actually used, we check...engine=whateverto this function?So
foo(engine=bar)overrides the preferences dict, and the preferences dict overridesdefault_engine().Closes: