Fix behaviour of Figure.clear() for SubplotParams #27183

eendebakpt · 2023-10-24T20:38:24Z

PR summary

Update Figure.clear() to reset the properties of Figure.subplotpars.
Add representation method for matplotlib.gridspec.SubplotParams
Add rc_default parameter to the SubplotParams.update

Fixes #11059. This PR is a continuation of #11086 by @fredrik-1

PR checklist

"closes #0000" is in the body of the PR description to link the related issue
new and changed code is tested
[N/A] Plotting related features are demonstrated in an example
New Features and API Changes are noted with a directive and release note
Documentation complies with general and docstring guidelines

eendebakpt · 2023-12-05T23:01:08Z

@jklymak Would you be able to review this pr? Thanks

doc/users/next_whats_new/subplots_adjust.rst

tacaswell · 2023-12-07T17:19:07Z

Why add an additional flag to update rather than extracting the rcparam values and passing them in clear (where we have to add a call to update anyway)?

I am not against the current implementation, but am curious why a more minimal approach would not work?

eendebakpt · 2023-12-07T19:32:02Z

Why add an additional flag to update rather than extracting the rcparam values and passing them in clear (where we have to add a call to update anyway)?

I am not against the current implementation, but am curious why a more minimal approach would not work?

@tacaswell This is a continuation of #11086 and I followed the implementation there.

Looking at the code right now: the new flag is used both in clear() and subplots_adjust(...). If we would only modify the clear(), then I fully agree we could do without the flag. If we do add a parameter to subplots_adjust, then the flag in update avoids a bit of duplicated code in clear and subplots_adjust.

I am fine with leaving the PR as is, or removing the flag in both update and subplots_adjust, or removing the flag in update while generating the new parameters in both clear and subplots_adjust.

eendebakpt · 2024-01-16T21:40:44Z

@tacaswell Gentle ping

Co-authored-by: Kyle Sunden <git@ksunden.space>

lib/matplotlib/gridspec.py

timhoffm · 2025-04-20T01:55:41Z

lib/matplotlib/gridspec.py

            The height of the padding between subplots,
            as a fraction of the average Axes height.
        """
        for key in ["left", "bottom", "right", "top", "wspace", "hspace"]:
            setattr(self, key, mpl.rcParams[f"figure.subplot.{key}"])
        self.update(left, bottom, right, top, wspace, hspace)

+    def _repr_pretty_(self, p: Any, cycle: bool) -> None:


Why not simply define __repr__?

__repr__ ends up at many places (logging, inside other repr of containers) and not everybody likes these kind of changes. The _repr_pretty_ is mainly used in interactive environments (spyder, jypyter noteobook, etc.) and visible to humans.

I do not think this change belongs in this PR though, so I removed it. Let me know if you want to to open a separate PR for this.

It's rare that we/users ever access this, so I don't really care. But I think if we do this, we can afford to do __repr__. We don't have precedence for _repr_pretty_ in the code base. Take or leave a separate PR.

lib/matplotlib/gridspec.py

lib/matplotlib/gridspec.pyi

lib/matplotlib/tests/test_figure.py

lib/matplotlib/tests/test_gridspec.py

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

…b into clf_subplots_adjust

timhoffm

Only minor changes left.

lib/matplotlib/tests/test_gridspec.py

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

lib/matplotlib/gridspec.py

doc/users/next_whats_new/subplots_adjust.rst

Co-authored-by: Jody Klymak <jklymak@gmail.com>

jklymak · 2025-04-22T20:02:58Z

You have a stray end of file issue that fails CI.

jklymak

Small suggestion to the what's new (at the very least the line was too long).

If someone merges this, it should be squash-merged.

doc/users/next_whats_new/subplots_adjust.rst

Co-authored-by: Jody Klymak <jklymak@gmail.com>

QuLogic · 2025-04-23T06:22:40Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

ksunden marked this pull request as draft October 24, 2023 20:55

eendebakpt changed the title ~~Draft: Fix behaviour of Figure.clear() for SubplotParams~~ Fix behaviour of Figure.clear() for SubplotParams Oct 25, 2023

eendebakpt marked this pull request as ready for review October 25, 2023 09:27

eendebakpt force-pushed the clf_subplots_adjust branch from f76c23f to adebaa3 Compare November 26, 2023 19:55

ksunden reviewed Dec 6, 2023

View reviewed changes

doc/users/next_whats_new/subplots_adjust.rst Outdated Show resolved Hide resolved

github-actions bot added the status: needs rebase label Dec 20, 2023

github-actions bot added topic: geometry manager LayoutEngine, Constrained layout, Tight layout topic: pyplot API topic: figures and subfigures Documentation: user guide files in galleries/users_explain or doc/users and removed status: needs rebase labels Jan 16, 2024

eendebakpt requested a review from ksunden January 24, 2024 10:36

github-actions bot added the status: needs rebase label Feb 17, 2024

github-actions bot removed Documentation: user guide files in galleries/users_explain or doc/users status: needs rebase labels Feb 27, 2024

eendebakpt and others added 11 commits March 19, 2024 21:21

Fix behaviour of Figure.clear() for SubplotParams

cf6032e

update credits

68386fa

lint

035a9c0

lint

c2c13ff

lint

247833c

lint

e2039f8

run boilerplate.py

1b76817

add tests

51876fc

Update doc/users/next_whats_new/subplots_adjust.rst

1470bf2

Co-authored-by: Kyle Sunden <git@ksunden.space>

update news entry

199cc4a

increase coverage

9772578

eendebakpt added 3 commits April 18, 2025 16:32

update whatsnew

0766ec0

whitespace

50e9b46

whitespace

3690d94

timhoffm reviewed Apr 20, 2025

View reviewed changes

eendebakpt and others added 8 commits April 21, 2025 21:42

Apply suggestions from code review

e119ab0

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

review comments

275825f

Merge branch 'clf_subplots_adjust' of github.com:eendebakpt/matplotli…

b2cf506

…b into clf_subplots_adjust

fix merge conflicts

7665053

remove duplicate test

10d8216

remove redundant test

d3f8db1

ci

6725328

ci

a91275e

timhoffm reviewed Apr 21, 2025

View reviewed changes

lib/matplotlib/tests/test_gridspec.py Outdated Show resolved Hide resolved

lib/matplotlib/tests/test_gridspec.py Outdated Show resolved Hide resolved

eendebakpt and others added 2 commits April 22, 2025 10:42

Update lib/matplotlib/tests/test_gridspec.py

7d3e386

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

Update lib/matplotlib/tests/test_gridspec.py

9d772c4

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

timhoffm approved these changes Apr 22, 2025

View reviewed changes

jklymak reviewed Apr 22, 2025

View reviewed changes

lib/matplotlib/gridspec.py Outdated Show resolved Hide resolved

jklymak reviewed Apr 22, 2025

View reviewed changes

lib/matplotlib/gridspec.py Outdated Show resolved Hide resolved

jklymak reviewed Apr 22, 2025

View reviewed changes

doc/users/next_whats_new/subplots_adjust.rst Outdated Show resolved Hide resolved

eendebakpt and others added 3 commits April 22, 2025 20:22

Update doc/users/next_whats_new/subplots_adjust.rst

98df0da

Co-authored-by: Jody Klymak <jklymak@gmail.com>

Update lib/matplotlib/gridspec.py

fac13d1

Co-authored-by: Jody Klymak <jklymak@gmail.com>

Update lib/matplotlib/gridspec.py

49d1eca

Co-authored-by: Jody Klymak <jklymak@gmail.com>

eendebakpt added 2 commits April 22, 2025 22:42

whitespace

5c9674a

Merge branch 'main' into clf_subplots_adjust

78d699c

jklymak approved these changes Apr 22, 2025

View reviewed changes

doc/users/next_whats_new/subplots_adjust.rst Outdated Show resolved Hide resolved

Update doc/users/next_whats_new/subplots_adjust.rst

5ad2d55

Co-authored-by: Jody Klymak <jklymak@gmail.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

d5c9f7b

for more information, see https://pre-commit.ci

QuLogic merged commit 00d5cb6 into matplotlib:main Apr 23, 2025
39 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix behaviour of Figure.clear() for SubplotParams #27183

Fix behaviour of Figure.clear() for SubplotParams #27183

eendebakpt commented Oct 24, 2023 •

edited

Loading

eendebakpt commented Dec 5, 2023

tacaswell commented Dec 7, 2023

eendebakpt commented Dec 7, 2023

eendebakpt commented Jan 16, 2024

timhoffm Apr 20, 2025

eendebakpt Apr 21, 2025

timhoffm Apr 21, 2025

timhoffm left a comment

jklymak commented Apr 22, 2025

jklymak left a comment

QuLogic commented Apr 23, 2025

Fix behaviour of Figure.clear() for SubplotParams #27183

Fix behaviour of Figure.clear() for SubplotParams #27183

Conversation

eendebakpt commented Oct 24, 2023 • edited Loading

PR summary

PR checklist

eendebakpt commented Dec 5, 2023

tacaswell commented Dec 7, 2023

eendebakpt commented Dec 7, 2023

eendebakpt commented Jan 16, 2024

timhoffm Apr 20, 2025

Choose a reason for hiding this comment

eendebakpt Apr 21, 2025

Choose a reason for hiding this comment

timhoffm Apr 21, 2025

Choose a reason for hiding this comment

timhoffm left a comment

Choose a reason for hiding this comment

jklymak commented Apr 22, 2025

jklymak left a comment

Choose a reason for hiding this comment

QuLogic commented Apr 23, 2025

eendebakpt commented Oct 24, 2023 •

edited

Loading