Offsetbox default arguments #24652

Ali-Msk · 2022-12-07T05:48:06Z

PR Summary

Closes #24623

PR Checklist

Documentation and Tests

Has pytest style unit tests (and pytest passes)
Documentation is sphinx and numpydoc compliant (the docs should build without error).
New plotting related features are documented with examples.

Release Notes

New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

…correct location. Added unit test for change.

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

jklymak · 2022-12-07T05:58:50Z

Thanks for the PR! For ease of review, suggest a description of the change and moving the issues from title to the description.

oscargus · 2022-12-07T07:56:28Z

lib/matplotlib/offsetbox.py

@@ -369,12 +369,12 @@ def draw(self, renderer):


 class PackerBase(OffsetBox):
-    def __init__(self, pad=None, sep=None, width=None, height=None,
+    def __init__(self, pad=0., sep=None, width=None, height=None,


I think the same problem holds for sep as well?

Edited: width and height are calculated, but sep must be set.

oscargus · 2022-12-07T07:56:51Z

lib/matplotlib/offsetbox.py

                 align="baseline", mode="fixed", children=None):
        """
        Parameters
        ----------
-        pad : float, optional
+        pad : float, required


It is still optional, just that it has a correct default now.

oscargus · 2022-12-07T07:58:41Z

Can you please how the outcome of the example code in #24620? Ideally as an image test, but if nothing else just paste the result here.

oscargus · 2022-12-07T08:00:47Z

lib/matplotlib/tests/test_offsetbox.py

+    try:
+        pb = PaddedBox(at, patch_attrs={'facecolor': 'r'}, draw_frame=True)
+    except:
+        raise Exception("incorrect default value")


There is no need to do this in a test. The test will fail if there is an exception anyway, so skip the try-except.

You can add a comment like

# smoke test for correct default value though

Skhaki18 · 2022-12-07T08:50:04Z

This was our result when running the code from 24620 with the default padding of 0. Additionally, we can see the result for padding=5 below:

jklymak · 2022-12-07T16:46:49Z

I'm moving this to draft. Feel free to move back when ready for review.

oscargus · 2022-12-08T07:37:42Z

There is an update in #24620 which shows that PaddedBox is indeed working. And it looks like the proposed solution is not fully handling it.

Hence, my suggestion is to drop the location changes and just go with the default argument ones.

Krutarth-P · 2022-12-09T07:33:28Z

There is an update in #24620 which shows that PaddedBox is indeed working. And it looks like the proposed solution is not fully handling it.

Hence, my suggestion is to drop the location changes and just go with the default argument ones.

We have made the changes according to your request to use the default values. Would you know how to resolve the CircleCi errors?

lib/matplotlib/offsetbox.py

oscargus · 2022-12-09T09:22:54Z

The Circle CI issue is a bit weird. It it not related to the contents of your PR anyway. I think I've seen some issue recently where a particular user couldn't run the tests and the best guess was that the GitHub user name was changed. Would that possibly be the case here? Has anyone of you changed GitHub user name after you created your account?

Krutarth-P · 2022-12-10T23:41:02Z

The Circle CI issue is a bit weird. It it not related to the contents of your PR anyway. I think I've seen some issue recently where a particular user couldn't run the tests and the best guess was that the GitHub user name was changed. Would that possibly be the case here? Has anyone of you changed GitHub user name after you created your account?

change of name doesn't seem to be the case here. any other possible reasons for the error?

Krutarth-P · 2022-12-11T05:12:14Z

@oscargus @jklymak the builds are successful. We are ready for a review

oscargus

Just some minor comments. The testing is good to get correct though.

One may consider changing optional to default: 0.0 in the doc strings. (Or add Default: 0.0. to the description, but I think the first is preferred.)

oscargus · 2022-12-12T08:16:55Z

lib/matplotlib/tests/test_offsetbox.py

+    # smoke test for correct default value though
+    fig, ax = plt.subplots()
+    at = AnchoredText("foo",  'upper left')
+    pb = PaddedBox(at, patch_attrs={'facecolor': 'r'}, draw_frame=True)


This test passes on main as well. (As the fact that pad is None is not a problem until later on.)

You need to do:

ax.add_artist(pb) fig.draw_without_rendering()

If you can also add a similar thing for one of the packers that would be great! Can go in the same test/figure. There is a previous test for the packers that you can just copy the relevant code from, but leave the pad and sep arguments out.

lib/matplotlib/tests/test_offsetbox.py

lib/matplotlib/offsetbox.py

Co-authored-by: Oscar Gustafsson <[email protected]>

Skhaki18 · 2022-12-14T04:30:04Z

@oscargus and @rcomer , We have addressed the requested comments and added the necessary tests. We are able to build successfully and are ready for the next step in merging.

oscargus

Thanks!

I guess this is good to go now. The addition of HPacker/VPacker tests is maybe not so clear, but it will work and test what is expected.

An better option is to simply remove the two previous lines where pad and sep are set as they are now redundant.

Whoever merges this: please squash the commits. (I take it that you are using the web-based interface for editing the files?)

lib/matplotlib/tests/test_offsetbox.py

timhoffm · 2022-12-14T16:46:53Z

An better option is to simply remove the two previous lines where pad and sep are set as they are now redundant.
r editing the files?)

I took the liberty to commit this change.

timhoffm · 2022-12-14T16:54:06Z

Thanks @Ali-Msk and congratulations on your first contribution to Matplotlib!

We hope to see you again.

Closes matplotlib#24652 Co-authored-by: Skhaki18 <[email protected]> Co-authored-by: Krutarth Patel <[email protected]> Co-authored-by: Oscar Gustafsson <[email protected]> Co-authored-by: Tim Hoffmann <[email protected]>

Ali-Msk added 2 commits December 7, 2022 00:40

Added support for default value for padding of paddedbox and fixed in…

85e7c89

…correct location. Added unit test for change.

ran flake on the changes for compliance

58dc0d6

github-actions bot reviewed Dec 7, 2022

View reviewed changes

oscargus reviewed Dec 7, 2022

View reviewed changes

Skhaki18 added 2 commits December 7, 2022 03:30

Update offsetbox.py with requested doc change and default sep

895c861

Added requested change for test_paddedbox

5b3397e

jklymak changed the title ~~[#24623][#24620] Offsetbox arguments and incorrect location~~ Offsetbox arguments and incorrect location Dec 7, 2022

jklymak added status: needs tests status: needs clarification Issues that need more information to resolve. labels Dec 7, 2022

jklymak marked this pull request as draft December 7, 2022 16:46

updated to default values

8b8b539

oscargus reviewed Dec 9, 2022

View reviewed changes

lib/matplotlib/offsetbox.py Show resolved Hide resolved

rcomer marked this pull request as ready for review December 11, 2022 08:18

oscargus reviewed Dec 12, 2022

View reviewed changes

Krutarth-P and others added 5 commits December 12, 2022 14:33

Update lib/matplotlib/offsetbox.py

a1ba0cd

Co-authored-by: Oscar Gustafsson <[email protected]>

Update lib/matplotlib/tests/test_offsetbox.py

ca9bc4a

Co-authored-by: Oscar Gustafsson <[email protected]>

Update lib/matplotlib/offsetbox.py

0f1f182

Co-authored-by: Oscar Gustafsson <[email protected]>

updated doc strings

4d1272c

added smoke test for packer

c8c1f87

Krutarth-P and others added 4 commits December 12, 2022 15:01

Update test_offsetbox.py

f09389d

Update test_offsetbox.py

ad9fc5f

Update test_offsetbox.py

8009e09

Update test_offsetbox.py

bfbb4b0

oscargus approved these changes Dec 14, 2022

View reviewed changes

oscargus removed status: needs clarification Issues that need more information to resolve. status: needs tests labels Dec 14, 2022

oscargus changed the title ~~Offsetbox arguments and incorrect location~~ Offsetbox default arguments Dec 14, 2022

timhoffm reviewed Dec 14, 2022

View reviewed changes

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

Update lib/matplotlib/tests/test_offsetbox.py

cd6ecaf

timhoffm approved these changes Dec 14, 2022

View reviewed changes

timhoffm added this to the v3.7.0 milestone Dec 14, 2022

timhoffm added the Maintenance label Dec 14, 2022

timhoffm merged commit 58de4e2 into matplotlib:main Dec 14, 2022

Uh oh!

Offsetbox default arguments #24652

Offsetbox default arguments #24652

Uh oh!

Conversation

Ali-Msk commented Dec 7, 2022 • edited by oscargus Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

jklymak commented Dec 7, 2022

Uh oh!

oscargus Dec 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oscargus Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

oscargus commented Dec 7, 2022

Uh oh!

oscargus Dec 7, 2022

Choose a reason for hiding this comment

Uh oh!

Skhaki18 commented Dec 7, 2022

Uh oh!

jklymak commented Dec 7, 2022

Uh oh!

oscargus commented Dec 8, 2022

Uh oh!

Krutarth-P commented Dec 9, 2022

Uh oh!

Uh oh!

oscargus commented Dec 9, 2022

Uh oh!

Krutarth-P commented Dec 10, 2022

Uh oh!

Krutarth-P commented Dec 11, 2022

Uh oh!

oscargus left a comment

Choose a reason for hiding this comment

Uh oh!

oscargus Dec 12, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Skhaki18 commented Dec 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oscargus left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timhoffm commented Dec 14, 2022

Uh oh!

timhoffm commented Dec 14, 2022

Uh oh!

Uh oh!

Ali-Msk commented Dec 7, 2022 •

edited by oscargus

Loading

oscargus Dec 7, 2022 •

edited

Loading

Skhaki18 commented Dec 14, 2022 •

edited

Loading

oscargus left a comment •

edited

Loading