patheffects.SimpleLineShadow calling non-existent get_foreground method from GraphicsContextBase #28814
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. 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.
|
@timhoffm Hi. Just wondering what else needs to get done before this fix can get merged. |
|
Per our merge policy, we need two reviews. So this is waiting for a second core developer to approve. |
|
Are you interested in writing a test? It looks like you have a test script in #28793, and it should be able to be turned into a figure comparison if you compare the path effect with directly plotting a line with the effective settings. |
Sure, that shouldn't be a problem |
|
I marked the test as XFail because the '@check_figures_equal()' decorator only works for identical results. Here are screen captures of the diff. |
|
I don't understand; the point of the test would be to confirm that the shadow is set the way you'd expect it to, and thus have equal figures. |
I see what you mean. I changed it to plot a line with the alpha value instead for transparency. |
| # Create the plots | ||
| ax_ref = fig_ref.add_subplot() | ||
| ax_test = fig_test.add_subplot() | ||
|
|
||
| # Generate Gaussian distribution data | ||
| x = np.linspace(-5, 5, 500) | ||
| y = np.exp(-x**2) |
There was a problem hiding this comment.
Don't think these comments are necessary.
| # Create the plots | |
| ax_ref = fig_ref.add_subplot() | |
| ax_test = fig_test.add_subplot() | |
| # Generate Gaussian distribution data | |
| x = np.linspace(-5, 5, 500) | |
| y = np.exp(-x**2) | |
| ax_ref = fig_ref.add_subplot() | |
| ax_test = fig_test.add_subplot() | |
| x = np.linspace(-5, 5, 500) | |
| y = np.exp(-x**2) |
| # Plot the Gaussian line with the SimpleLineShadow path effect | ||
| line, = ax_test.plot(x, y, linewidth=5) | ||
| line.set_path_effects([path_effects.SimpleLineShadow( | ||
| offset=(0, 0), shadow_color='blue', rho=0.5)]) | ||
|
|
||
| # Plot the Gaussian line simply | ||
| ax_ref.plot(x, y, linewidth=5, color='blue', alpha=0.3) |
There was a problem hiding this comment.
rho is not used since shadow_color is specified. You can also pass this directly to plot:
| # Plot the Gaussian line with the SimpleLineShadow path effect | |
| line, = ax_test.plot(x, y, linewidth=5) | |
| line.set_path_effects([path_effects.SimpleLineShadow( | |
| offset=(0, 0), shadow_color='blue', rho=0.5)]) | |
| # Plot the Gaussian line simply | |
| ax_ref.plot(x, y, linewidth=5, color='blue', alpha=0.3) | |
| ax_test.plot(x, y, linewidth=5, | |
| path_effects=[ | |
| path_effects.SimpleLineShadow(offset=(0, 0), shadow_color='blue')]) | |
| ax_ref.plot(x, y, linewidth=5, color='blue', alpha=0.3) |
| import numpy as np | ||
|
|
||
| from matplotlib.testing.decorators import image_comparison | ||
| from matplotlib.testing.decorators import image_comparison, check_figures_equal | ||
| import matplotlib.pyplot as plt |
There was a problem hiding this comment.
This belongs in the third block, with first-party imports:
| import numpy as np | |
| from matplotlib.testing.decorators import image_comparison | |
| from matplotlib.testing.decorators import image_comparison, check_figures_equal | |
| import matplotlib.pyplot as plt | |
| import numpy as np | |
| import matplotlib.pyplot as plt | |
| from matplotlib.testing.decorators import image_comparison, check_figures_equal |
|
How did this ever work? |
|
Well, there was no test before, so no confirmation that it ever did. |
resolves #28793 : Replaced nonexistent get_foreground() method with get_rgb()
PR checklist