-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Resolving: Add setter/getter methods for all keyword parameters to Figure.__init__ (Issue: #24617) #27531
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Resolving: Add setter/getter methods for all keyword parameters to Figure.__init__ (Issue: #24617) #27531
Conversation
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.
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.
… init for the firgure class
@@ -48,7 +51,7 @@ | |||
import matplotlib.image as mimage | |||
|
|||
from matplotlib.axes import Axes | |||
from matplotlib.gridspec import GridSpec, SubplotParams | |||
from matplotlib.gridspec import GridSpec |
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.
Why did this need to come back?
@@ -1291,6 +1354,65 @@ def subplots_adjust(self, left=None, bottom=None, right=None, top=None, | |||
ax._set_position(ax.get_subplotspec().get_position(self)) | |||
self.stale = True | |||
|
|||
def set_subplotpars(self, subplotparams={}): |
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.
Default values should not be mutable objects like a dictionary. You should set it to None
, and then check that in the function.
def set_subplotpars(self, subplotparams={}): | |
def set_subplotpars(self, subplotparams=None): |
else: | ||
_api.warn_external( | ||
f"'{key}' is not a valid key for set_subplotpars;" | ||
" this key was ignored.") |
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.
As a new function, this should be an error, not a warning.
if kwargs == {}: | ||
self.set_subplotpars(self.get_subplotpars()) |
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.
I don't understand what this is doing?
PR summary
This PR adds aliasing for layout, figsize and adds getter and setter methods for subplotparams.
It resolves #24617. The PR utilized #21549 and #25901.
PR checklist