Fix RangeSlider for same init values #22686 #22926

AnnaMastori · 2022-04-28T13:39:16Z

PR Summary

Change the way that polygon is initilized to cover edge case of same init values. The method axhspan is no longer used and the polygon is created manually. (closes #22686 )

PR Checklist

Tests and Styling

Has pytest style unit tests (and pytest passes).
Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

New features are documented, with examples if plot related.
New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
Documentation is sphinx and numpydoc compliant (the docs should build without error).

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.

ianhi · 2022-04-28T16:30:49Z

Looks like your test failure is real. You can see it by clicking on the details of one of the failing ones:

 =================================== FAILURES ===================================
_________________________ test_range_slider[vertical] __________________________
[gw1] linux -- Python 3.8.12 /opt/hostedtoolcache/Python/3.8.12/x64/bin/python

orientation = 'vertical'

    @pytest.mark.parametrize("orientation", ["horizontal", "vertical"])
    def test_range_slider(orientation):
        if orientation == "vertical":
            idx = [1, 0, 3, 2]
        else:
            idx = [0, 1, 2, 3]
    
        fig, ax = plt.subplots()
    
        slider = widgets.RangeSlider(
            ax=ax, label="", valmin=0.0, valmax=1.0, orientation=orientation,
            valinit=[0.1, 0.34]
        )
        box = slider.poly.get_extents().transformed(ax.transAxes.inverted())
>       assert_allclose(box.get_points().flatten()[idx], [0.1, 0.25, 0.34, 0.75])
E       AssertionError: 
E       Not equal to tolerance rtol=1e-07, atol=0
E       
E       Mismatched elements: 2 / 4 (50%)
E       Max absolute difference: 0.16666667
E       Max relative difference: 0.66666667
E        x: array([0.1     , 0.083333, 0.34    , 0.916667])
E        y: array([0.1 , 0.25, 0.34, 0.75])

lib/matplotlib/tests/test_widgets.py:1133: AssertionError

and indeed it looks wrong when done vertically:

lib/matplotlib/widgets.py

oscargus · 2022-04-29T07:28:04Z

I took the liberty of editing your message, changing issue #22686 to closes #22686. In that way, GitHub will link this PR to the issue and automatically close the issue when merging this PR.

ianhi

Looking good! I have two comments for simplifying the code but the core functionality is here

ianhi · 2022-05-01T15:05:02Z

lib/matplotlib/widgets.py

+            verts[0] = .25, valinit[0]
+            verts[1] = .25, valinit[1]
+            verts[2] = .75, valinit[1]
+            verts[3] = .75, valinit[0]
+            verts[4] = .25, valinit[0]


Since this verts filling code is now used in multiple places (here, and in set_val) maybe we should pull it out into a function.

lib/matplotlib/widgets.py

ianhi

Looking good! I've got a few more comments on ways you can simplify the code a bit more but none of it is critical.

nice work

lib/matplotlib/widgets.py

ianhi · 2022-05-04T01:36:09Z

lib/matplotlib/widgets.py

+            verts = self._fill_verts(verts, valinit)
+            poly = Polygon(verts, **kwargs)
+            poly.set_transform(self.ax.get_yaxis_transform(which="grid"))


with above suggestion you can do:

Suggested change

verts = self._fill_verts(verts, valinit)

poly = Polygon(verts, **kwargs)

poly.set_transform(self.ax.get_yaxis_transform(which="grid"))

poly_transform = self.ax.get_yaxis_transform(which="grid"))

and then create the polygon as below

lib/matplotlib/widgets.py

ianhi · 2022-05-04T01:44:43Z

lib/matplotlib/widgets.py

+    def _fill_verts(self, verts, val):
+        """Fills the *verts* Nx2 shaped numpy array."""


I suppose it's not strictly necessary because this is private - but it could be nice to have a Parameters and Returns section of the docstring so that someone in the future trying to understand has an easier time. Something like:

Suggested change

def _fill_verts(self, verts, val):

"""Fills the *verts* Nx2 shaped numpy array."""

def _fill_verts(self, verts, val):

"""

Update the *verts* of the *self.poly* slider according to the current value and slider orientation

Parameters

----------------

verts : (5, 2) np.ndarray

The vertices to fill. Note that these will be modified in place

val : (2,) array_like

The new min and max values

Returns

----------

verts : np.ndarray

The original array with updated values

"""

I'm not sure I got the docstring styling 100% correct but this should at least convey the information

ianhi

Looks good! Nice work @AnnaMastori and @NickolasGiannatos

The next step is that two core developers (people with write access) need to review and approve this.

But FWIW it gets the approval from me 👍

QuLogic

Is there some way we can test this?

lib/matplotlib/widgets.py

AnnaMastori · 2022-05-05T11:06:14Z

Is there some way we can test this?

What do you mean by this? Do you want us to create a specific test for the new method ?

lib/matplotlib/widgets.py

ianhi · 2022-05-05T13:45:11Z

Is there some way we can test this?

Yes. Easiest is probably copying this part into a new test for the case of valinit=[0,0]

matplotlib/lib/matplotlib/tests/test_widgets.py

Lines 1119 to 1133 in 2e70254

    
           @pytest.mark.parametrize("orientation", ["horizontal", "vertical"]) 
        
           def test_range_slider(orientation): 
        
               if orientation == "vertical": 
        
                   idx = [1, 0, 3, 2] 
        
               else: 
        
                   idx = [0, 1, 2, 3] 
        
               fig, ax = plt.subplots() 
        
               slider = widgets.RangeSlider( 
        
                   ax=ax, label="", valmin=0.0, valmax=1.0, orientation=orientation, 
        
                   valinit=[0.1, 0.34] 
        
               ) 
        
               box = slider.poly.get_extents().transformed(ax.transAxes.inverted()) 
        
               assert_allclose(box.get_points().flatten()[idx], [0.1, 0.25, 0.34, 0.75])

or just adding a second line of:

     slider = widgets.RangeSlider( 
         ax=ax, label="", valmin=0.0, valmax=1.0, orientation=orientation, 
         valinit=[0, 0] 
     ) 
     box = slider.poly.get_extents().transformed(ax.transAxes.inverted()) 
     assert_allclose(box.get_points().flatten()[idx], [0, 0.25, 0, 0.75])

inside the current test either before or after the current slider creation

NickolasGiannatos · 2022-05-05T19:21:00Z

Is it a good practice to create a test for an edge case scenario or we should enhance the existing one to cover this specific case.

timhoffm

Thanks! This is looking good and working. I've added some suggestions to make the code easier to follow.

lib/matplotlib/widgets.py

timhoffm · 2022-05-06T22:15:12Z

lib/matplotlib/tests/test_widgets.py

+    slider = widgets.RangeSlider(
+        ax=ax, label="", valmin=0.0, valmax=1.0, orientation=orientation,
+        valinit=[0.0, 0.0]
+    )
+    box = slider.poly.get_extents().transformed(ax.transAxes.inverted())
+    assert_allclose(box.get_points().flatten()[idx], [0, 0.25, 0, 0.75])
+
+    # Check initial value is set correctly
+    assert_allclose(slider.val, (0.0, 0.0))


@NickolasGiannatos sorry, I have overlooked your question on whether to include into the existing test or add a new test. In this case I'd go with a dedicated test because

There's little code sharing between the tests (only the idx order, which could be written more compact as `idx = [1, 0, 3, 2] if orientation == 'vertical' else [0, 1, 2, 3]). So there's little gain.

The existing test is already quite long and the new test would add 10 unrelated lines. This makes understanding what's happening in the existing test much harded. If it was just a 2-3 liner like the slider.reset() below, it'd maybe ok to add to the existing test.

timhoffm · 2022-05-08T17:42:37Z

@AnnaMastori @NickolasGiannatos congratulations on your first contribution to Matplolib! 🎉 Thank you for the PR and your patience getting through the review process. We are looking forward to seeing you back!

NickolasGiannatos and others added 3 commits April 28, 2022 15:02

Change creation of vertical polygon for rangeSlider widget

4ec62cb

Change creation of horizontal polygon for RangeSlider widget

0024a67

Fix spaces

9aa50bf

github-actions bot reviewed Apr 28, 2022

View reviewed changes

ianhi reviewed Apr 28, 2022

View reviewed changes

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

oscargus added the topic: widgets/UI label Apr 29, 2022

Change method that transforms vertical polygon

b667cca

story645 added the status: needs workflow approval For PRs from new contributors, from which GitHub blocks workflows by default. label Apr 29, 2022

ianhi reviewed May 1, 2022

View reviewed changes

NickolasGiannatos and others added 2 commits May 3, 2022 18:00

Refactor RangeSlider __init__ method

4d75927

Create method _fill_verts

88e846a

ianhi reviewed May 4, 2022

View reviewed changes

AnnaMastori and others added 3 commits May 4, 2022 19:10

Refactor init method of RangeSlider

e1c23d5

Change documentation of method _fill_verts

0c59df8

Fix docstring in method _fill_verts

7172144

ianhi approved these changes May 4, 2022

View reviewed changes

tacaswell added this to the v3.6.0 milestone May 4, 2022

QuLogic reviewed May 5, 2022

View reviewed changes

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

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

NickolasGiannatos added 2 commits May 5, 2022 13:46

Fix docstring indentation in _fill_verts method

2fa1304

Refactor method set_val

a830b29

ianhi reviewed May 5, 2022

View reviewed changes

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

Refactor method set_val in RangeSlider

bf1346c

timhoffm reviewed May 5, 2022

View reviewed changes

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

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

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

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

AnnaMastori and others added 2 commits May 6, 2022 18:30

Change method _fill_verts to _update_selection_poly in RangeSlider

3285c5c

Refactor method set_val in RangeSlider

1130948

NickolasGiannatos added 2 commits May 6, 2022 20:43

Add case of same init values in test_range_slider

8774b1b

Fix indentation

306237c

timhoffm reviewed May 6, 2022

View reviewed changes

AnnaMastori added 2 commits May 7, 2022 23:55

Remove test case for same init values from test_range_slider method

382aed2

Add test method test_range_slider_same_init_values

4cc82f1

timhoffm approved these changes May 8, 2022

View reviewed changes

timhoffm merged commit bed2362 into matplotlib:main May 8, 2022

		def _fill_verts(self, verts, val):
		"""Fills the verts Nx2 shaped numpy array."""

-    def _fill_verts(self, verts, val):
-        """Fills the *verts* Nx2 shaped numpy array."""
+    def _fill_verts(self, verts, val):
+        """
+        Update the *verts* of the *self.poly* slider according to the current value and slider orientation
+       Parameters
+       ----------------
+       verts : (5, 2) np.ndarray
+                 The vertices to fill. Note that these will be modified in place
+       val : (2,) array_like
+             The new min and max values
+       Returns
+       ----------
+       verts : np.ndarray
+                The original array with updated values
+        """

Uh oh!

Fix RangeSlider for same init values #22686 #22926

Fix RangeSlider for same init values #22686 #22926

Uh oh!

Conversation

AnnaMastori commented Apr 28, 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!

ianhi commented Apr 28, 2022

Uh oh!

Uh oh!

oscargus commented Apr 29, 2022

Uh oh!

ianhi left a comment

Choose a reason for hiding this comment

Uh oh!

ianhi May 1, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ianhi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ianhi May 4, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ianhi May 4, 2022

Choose a reason for hiding this comment

Uh oh!

ianhi left a comment

Choose a reason for hiding this comment

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AnnaMastori commented May 5, 2022

Uh oh!

Uh oh!

ianhi commented May 5, 2022

Uh oh!

NickolasGiannatos commented May 5, 2022

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timhoffm May 6, 2022

Choose a reason for hiding this comment

Uh oh!

timhoffm commented May 8, 2022

Uh oh!

Uh oh!

AnnaMastori commented Apr 28, 2022 •

edited by oscargus

Loading