[ENH]: Add setter/getter methods for all keyword parameters to Figure.init #24617

tacaswell · 2022-12-04T16:39:34Z

Problem

At least 2 of the arguments passed to Figure.__init__ do not have matching get_{kwarg}/set_{kwarg} methods on Figure which makes using fig.set(...) inconsistent with what can be done via Figure(...).

xref #21549 which was motivated by this and includes an implementation of the solution (along with some additional refactoring).

Proposed solution

See #21549 for a majority of the implementation. cherry-picking commits from that branch and dropping the layout management refactoring is a very good start.

use alias mechanism for size_inches -> figsize
add get/set_subplotparams
use alias mechanism from layout -> layout_engine
tests!
whats new entry

Labeling this as good first issue because it is limited scope and easy because there is an existing implementation. There will be a discussion of API consistency so I think familiarity with Matplotlib's explicit API would be very helpful.

The text was updated successfully, but these errors were encountered:

deepgohil · 2022-12-04T17:12:37Z

@tacaswell I would like to take this up. As this will be my first contribution to this repo. if you can guide me it will be very helpful.

tacaswell · 2022-12-04T18:22:02Z

Please see:

https://matplotlib.org/stable/devel/contributing.html#contributing-code (general workflow description)
https://matplotlib.org/stable/devel/gitwash/set_up_fork.html#set-up-fork (setup git checkout)
https://matplotlib.org/stable/devel/development_setup.html (details of how to build Matplotlib from source for local development)

I also strongly suggest you start by cherry-picking the commits from #21549 and use that as a base.

deepgohil · 2022-12-05T09:17:38Z

@tacaswell Will you help on following points

Can you elaborate more on alias mechanism of layout and size_inches figsize

And can you specifically mention for which params we have to implement getter and setters
image

tacaswell · 2022-12-05T14:44:22Z

Can you elaborate more on alias mechanism of layout and size_inches figsize

See

matplotlib/lib/matplotlib/lines.py

Lines 205 to 216 in aa1c538

    
           @_api.define_aliases({ 
        
               "antialiased": ["aa"], 
        
               "color": ["c"], 
        
               "drawstyle": ["ds"], 
        
               "linestyle": ["ls"], 
        
               "linewidth": ["lw"], 
        
               "markeredgecolor": ["mec"], 
        
               "markeredgewidth": ["mew"], 
        
               "markerfacecolor": ["mfc"], 
        
               "markerfacecoloralt": ["mfcalt"], 
        
               "markersize": ["ms"], 
        
           })

for an example.

And can you specifically mention for which params we have to implement getter and setters

I do not know this off the top of my head, part of the work that needs to be done on this issue is to sort out which of the keywords to __init__ are missing matching setter/getter pairs.

Gairick52 · 2023-01-10T13:36:14Z

@tacaswell Hello sir,i want to work on this issue,please assign this to me

tacaswell · 2023-01-10T13:37:58Z

@Gairick52 as noted in other issues, we do not currently assign issues, if you are interested in working on this please do so and open a PR.

vortex73 · 2023-01-13T17:32:06Z

Hi! This is my first contrib and am open to learning any new concepts involved. Could you just elaborate on what you require for the Getters & Setters portion?
Thanks!

NoyHanan · 2023-05-05T08:10:16Z

Hi all, is it still open?

tacaswell · 2023-05-05T20:23:59Z

It looks like the linked PR (#24696) has been marked as orphaned and needs a rebase. I think taking over that PR is fair game as we have not heard from the original author in a few months.

Lambxx · 2023-11-02T16:22:31Z

I have seen there are a few PR's on this, but none have closed the issue. Am I ok to add a PR?
If so does it require tests to be added?
thanks

tacaswell · 2023-11-02T16:36:01Z

@Lambxx We have not heard from any of the other contributors for 3 weeks, so I think it would be OK if you wanted to pick this up.

This requires tests and a whats new entry.

It looks like #25901 is most of the way there, I suggest cherry-picking those commits and working from there.

Lambxx · 2023-11-02T20:53:17Z

I have added a PR; apologies in advance if anything is broken/missing I am new to this so any feedback would be great. Thanks

…d paramters to Figure.__init__

shalul · 2024-04-01T18:06:53Z

Hi! Is this issue still open? If so I would love to know how to contribute!

QuLogic · 2024-04-01T23:22:58Z

It is, but there also appear to be a couple open PRs as linked above.

timhoffm · 2024-04-02T02:11:04Z

@shalul The issue is open, so not solved yet. But as linked above, it has an associated open pull request, i.e. a solution proposal. Therefore it does not make sense to work on this issue. Please look for another topic if you want to contribute.

As a side question, we often see people who ask in the way you did above coming from a CS course? Is that true for you as well? If so, which course and did they give you instructions on how to find suitable issues, in particular identifying whether an issue has already an associated open pull request and to judge whether that pull request is still active?

tacaswell added New feature Difficulty: Easy https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues Good first issue Open a pull request against these issues if there are no active ones! labels Dec 4, 2022

tacaswell added this to the future releases milestone Dec 4, 2022

tacaswell mentioned this issue Dec 4, 2022

Unifying the Figure getter/setter interface to match its constructor #21549

Closed

7 tasks

garveyz2 mentioned this issue Dec 11, 2022

Addresses issue #24617 adding setters/getters for Figure #24696

Closed

5 tasks

rcomer linked a pull request Jan 13, 2023 that will close this issue

Addresses issue #24617 adding setters/getters for Figure #24696

Closed

5 tasks

ggold7046 mentioned this issue Jan 17, 2023

new contributor requesting guidance pmeier/pmeier#7

Closed

This was referenced May 10, 2023

Adding get/set_subplotparams shaw5lee/matplotlib#1

Merged

Adding get/set_subplotparams #25852

Closed

dutta712 added a commit to dutta712/matplotlib that referenced this issue May 17, 2023

Added setter/getters for Figure for issue matplotlib#24617

fb5a553

dutta712 mentioned this issue May 17, 2023

Getters setters #25901

Open

dutta712 added a commit to dutta712/matplotlib that referenced this issue May 26, 2023

Added setter/getters for Figure for issue matplotlib#24617

6b995ea

Sridevi139 mentioned this issue Sep 8, 2023

Added setter & getter functions for missing kwargs #26722

Open

Arikad0 mentioned this issue Oct 17, 2023

Getter/Setter #27116

Closed

Lambxx linked a pull request Nov 2, 2023 that will close this issue

Fixes : Add setter/getter methods for all keyword parameters to Figure.__init__ #24617 #27257

Open

2 tasks

zaheerhashmi linked a pull request Dec 16, 2023 that will close this issue

Resolving: Add setter/getter methods for all keyword parameters to Figure.__init__ (Issue: #24617) #27531

Draft

5 tasks

jasonavatarang added a commit to jasonavatarang/matplotlib that referenced this issue Feb 8, 2024

adding issue matplotlib#24617 Add setter/getter methods for all kewor…

1a13f04

…d paramters to Figure.__init__

jasonavatarang added a commit to jasonavatarang/matplotlib that referenced this issue Feb 8, 2024

adding issue matplotlib#24617 Add setter/getter methods for all kewor…

6fb9eea

…d paramters to Figure.__init__

AlexisMardas linked a pull request Mar 31, 2024 that will close this issue

Add missing getter/setter methods to keywords of Figure.__init__ as described in #24617 #27997

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENH]: Add setter/getter methods for all keyword parameters to Figure.init #24617

[ENH]: Add setter/getter methods for all keyword parameters to Figure.init #24617

tacaswell commented Dec 4, 2022 •

edited

deepgohil commented Dec 4, 2022

tacaswell commented Dec 4, 2022

deepgohil commented Dec 5, 2022 •

edited

tacaswell commented Dec 5, 2022

Gairick52 commented Jan 10, 2023

tacaswell commented Jan 10, 2023

vortex73 commented Jan 13, 2023

NoyHanan commented May 5, 2023

tacaswell commented May 5, 2023

Lambxx commented Nov 2, 2023

tacaswell commented Nov 2, 2023

Lambxx commented Nov 2, 2023

shalul commented Apr 1, 2024

QuLogic commented Apr 1, 2024

timhoffm commented Apr 2, 2024

[ENH]: Add setter/getter methods for all keyword parameters to Figure.__init__ #24617

[ENH]: Add setter/getter methods for all keyword parameters to Figure.__init__ #24617

Comments

tacaswell commented Dec 4, 2022 • edited

Problem

Proposed solution

deepgohil commented Dec 4, 2022

tacaswell commented Dec 4, 2022

deepgohil commented Dec 5, 2022 • edited

tacaswell commented Dec 5, 2022

Gairick52 commented Jan 10, 2023

tacaswell commented Jan 10, 2023

vortex73 commented Jan 13, 2023

NoyHanan commented May 5, 2023

tacaswell commented May 5, 2023

Lambxx commented Nov 2, 2023

tacaswell commented Nov 2, 2023

Lambxx commented Nov 2, 2023

shalul commented Apr 1, 2024

QuLogic commented Apr 1, 2024

timhoffm commented Apr 2, 2024

[ENH]: Add setter/getter methods for all keyword parameters to Figure.init #24617

[ENH]: Add setter/getter methods for all keyword parameters to Figure.init #24617

tacaswell commented Dec 4, 2022 •

edited

deepgohil commented Dec 5, 2022 •

edited