Add support for pgf.documentclass rcParam #30063
+37
−6
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| PGF backend: new rcParam :rc:`pgf.documentclass` | ||
| ------------------------------------------------ | ||
|
|
||
| A new rcParam :rc:`pgf.documentclass` has been added to allow users to override | ||
| the default LaTeX document class (``article``) used by the PGF backend. | ||
| This enables better compatibility when including PGF figures in documents that | ||
| use custom LaTeX classes like ``IEEEtran`` or others, avoiding layout | ||
| issues like incorrect font sizes or spacing mismatches. |
This file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -958,6 +958,7 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True): | |
| # Strip leading comment. | ||
| transform=lambda line: line[1:] if line.startswith("#") else line, | ||
| fail_on_error=True) | ||
| rcParamsDefault["pgf.documentclass"] = "article" | ||
|
There was a problem hiding this comment. The default value should go in https://github.com/matplotlib/matplotlib/blob/main/lib/matplotlib/mpl-data/matplotlibrc |
||
| rcParamsDefault._update_raw(rcsetup._hardcoded_defaults) | ||
| rcParamsDefault._ensure_has_backend() | ||
|
|
||
|
|
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,9 +29,6 @@ | |
| _log = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| # Note: When formatting floating point values, it is important to use the | ||
| # %f/{:f} format rather than %s/{} to avoid triggering scientific notation, | ||
| # which is not recognized by TeX. | ||
|
|
@@ -205,7 +202,7 @@ class LatexManager: | |
| @staticmethod | ||
| def _build_latex_header(): | ||
| latex_header = [ | ||
| rf"\documentclass{{{mpl.rcParams.get('pgf.documentclass', 'article')}}}", | ||
|
There was a problem hiding this comment. You don't need to use |
||
| # Include TeX program name as a comment for cache invalidation. | ||
| # TeX does not allow this to be the first line. | ||
| rf"% !TeX program = {mpl.rcParams['pgf.texsystem']}", | ||
|
|
@@ -831,10 +828,11 @@ def print_pdf(self, fname_or_fh, *, metadata=None, **kwargs): | |
| # print figure to pgf and compile it with latex | ||
| with TemporaryDirectory() as tmpdir: | ||
| tmppath = pathlib.Path(tmpdir) | ||
| docclass = mpl.rcParams.get("pgf.documentclass", "article") | ||
|
|
||
| self.print_pgf(tmppath / "figure.pgf", **kwargs) | ||
| (tmppath / "figure.tex").write_text( | ||
| "\n".join([ | ||
| rf"\documentclass{{{docclass}}}" | ||
| r"\usepackage[pdfinfo={%s}]{hyperref}" % pdfinfo, | ||
| r"\usepackage[papersize={%fin,%fin}, margin=0in]{geometry}" | ||
| % (w, h), | ||
|
|
@@ -931,7 +929,7 @@ def _write_header(self, width_inches, height_inches): | |
| pdfinfo = ','.join( | ||
| _metadata_to_str(k, v) for k, v in self._info_dict.items()) | ||
| latex_header = "\n".join([ | ||
| rf"\documentclass{{{mpl.rcParams.get('pgf.documentclass', 'article')}}}", | ||
|
|
||
| r"\usepackage[pdfinfo={%s}]{hyperref}" % pdfinfo, | ||
| r"\usepackage[papersize={%fin,%fin}, margin=0in]{geometry}" | ||
| % (width_inches, height_inches), | ||
|
|
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -762,6 +762,7 @@ | |
| #pgf.rcfonts: True | ||
| #pgf.preamble: # See text.latex.preamble for documentation | ||
| #pgf.texsystem: xelatex | ||
| #pgf.documentclass: article | ||
|
|
||
| ### docstring params | ||
| #docstring.hardcopy: False # set this when you want to generate hardcopy docstring | ||
|
|
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1336,6 +1336,7 @@ def _convert_validator_spec(key, conv): | |
| "pgf.texsystem": ["xelatex", "lualatex", "pdflatex"], # latex variant used | ||
| "pgf.rcfonts": validate_bool, # use mpl's rc settings for font config | ||
| "pgf.preamble": validate_string, # custom LaTeX preamble | ||
| "pgf.documentclass": validate_string, # LaTeX document class used by PGF backend | ||
|
|
||
| # write raster image data into the svg file | ||
| "svg.image_inline": validate_bool, | ||
|
|
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -400,3 +400,12 @@ def test_document_font_size(): | |
| label=r'\normalsize the document font size is \the\fontdimen6\font' | ||
| ) | ||
| plt.legend() | ||
|
|
||
|
|
||
| @pytest.mark.backend("pgf") | ||
|
There was a problem hiding this comment. This test doesn't create any plots, so it doesn't need a specific backend. |
||
| def test_pgf_documentclass_written(): | ||
| from matplotlib.backends.backend_pgf import LatexManager | ||
|
|
||
| mpl.rcParams["pgf.documentclass"] = "IEEEtran" | ||
| header = LatexManager._build_latex_header() | ||
|
There was a problem hiding this comment. This test only really checks one code path; there should at least be one for outputting |
||
| assert r"\documentclass{IEEEtran}" in header |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra change.