Skip to content

MNT: handle generic descriptors in _setattr_cm #17561

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

Closed
wants to merge 1 commit into from

Conversation

tacaswell
Copy link
Member

PR Summary

If we are monkey-patching methods then we need to be sure that when
we restore the original attribute we need to make sure we don't
stick the method instance in place (which creates a circular
reference).

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant

@tacaswell tacaswell added this to the v3.2.2 milestone Jun 3, 2020
@tacaswell tacaswell requested a review from anntzer June 3, 2020 20:55
@anntzer
Copy link
Contributor

anntzer commented Jun 3, 2020

I don't think that would work right e.g. for properties either.
What was the actual case where you needed this?
I guess the correct solution would be something like checking whether attr in vars(obj) (in which case we grab the value and restore it later) or, if not, whether hasattr(type(obj), attr) (in which case we don't restore it later) (the second check can't be attr in vars(type(obj)) as that would mishandle inheritance).

@jklymak
Copy link
Member

jklymak commented Jun 3, 2020

This closes #17542 ? EDIT: sorry, confused the PRs...

@tacaswell tacaswell force-pushed the fix_method_patching branch from 73855bf to 136fa20 Compare June 4, 2020 02:29
@tacaswell
Copy link
Member Author

I added a test for a property as well, it seems to work.

Noticed this while I was working on #17515 (where I ended up just doing it all "by hand") and this will be relevant for #17560 .

I do see how this is still going to go sideways for class attributes (as we end up with an equal value at the instance level shadowing something is the class hierarchy), but I think that this is still a net improvement.

@tacaswell
Copy link
Member Author

@jklymak To be fair I almost put these commits in #17560 .

anntzer
anntzer previously approved these changes Jun 4, 2020
Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it's already an improvement :)

@tacaswell tacaswell force-pushed the fix_method_patching branch from 136fa20 to 066e6ef Compare June 4, 2020 22:37
@tacaswell
Copy link
Member Author

Added comments with links to both the tests and the implementation. I had tweaked the implementation a bit to give a better path to support un-masking class level attributes but in the process of writing out how it could be implemented I saw how to implement it. If people are unsure, I'm happy to drop the second commit.

@tacaswell tacaswell requested a review from anntzer June 4, 2020 22:52
if attr in obj.__dict__:
return True

if isinstance(getattr(type(obj), attr), property):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps safer would be:

if attr in type(obj).__dict__ and hasattr( type(obj).__dict__[attr], '__set__'):

which covers all descriptors

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think getattr is better here so we see the super classes, but checking __set__ seems better 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

getattr will invoke some descriptors still. Perhaps inspect.getattrstatic?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦 The rabbit hole gets deeper!

@tacaswell
Copy link
Member Author

Well, this started as a special case for methods and turned into the full general case for descriptors and class level attributes...

@tacaswell tacaswell modified the milestones: v3.2.2, v3.3.0 Jun 5, 2020
@tacaswell
Copy link
Member Author

This is also now a bigger change than I think we should backport.

@tacaswell tacaswell force-pushed the fix_method_patching branch from 4bf4115 to 335cd7e Compare June 5, 2020 20:25
@tacaswell tacaswell modified the milestones: v3.3.0, v3.4.0 Jun 9, 2020
@tacaswell
Copy link
Member Author

Pushed to 3.4, can be moved back but I would rather focus on other PRs for 3.3.

@anntzer
Copy link
Contributor

anntzer commented Jun 10, 2020

If you want to get something in for 3.3, can we instead just error out for anything that's not in the instance __dict__ for now (and perhaps special case methods too), and add in features in an as-needed fashion? I'm not sure setattr_cm makes sense for arbitrary properties (or worse, arbitrary descriptors) anyways...

@QuLogic QuLogic modified the milestones: v3.4.0, v3.5.0 Jan 22, 2021
@jklymak jklymak marked this pull request as draft April 23, 2021 17:00
@QuLogic QuLogic modified the milestones: v3.5.0, v3.6.0 Aug 23, 2021
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@tacaswell tacaswell force-pushed the fix_method_patching branch from 335cd7e to 65e6fe4 Compare April 9, 2022 21:49
@tacaswell tacaswell changed the title MNT: don't set method objects back onto the objects MNT: handle generic descriptors in _setattr_cm Apr 9, 2022
@tacaswell tacaswell added status: orphaned PR Good first issue Open a pull request against these issues if there are no active ones! Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues and removed status: needs rebase labels Apr 9, 2022
@tacaswell
Copy link
Member Author

I rebased this, but am going to orphan it.

I think the next step here is to write out a couple more pathological test cases involving custom descriptors.

Labeled as "good first issue" because there is not API design ("it goes back to as it was" is the API) but medium difficulty as it requires and understanding of the Python descriptor protocol (see https://docs.python.org/3/howto/descriptor.html ) which is not basic Python.

@tacaswell tacaswell modified the milestones: v3.6.0, unassigned Apr 9, 2022
@anntzer
Copy link
Contributor

anntzer commented Apr 9, 2022

(I think we should just support instance attributes and a small, explicitly listed subset of descriptors (each of which should be motivated by an actual use case), as writing a general utility seems to be way more complex than it is really worth).

@tacaswell
Copy link
Member Author

Fair, I'm also open to "close this as a bad idea" ;)

@timhoffm
Copy link
Member

timhoffm commented Apr 15, 2022

I agree with @anntzer. Let's do all the things we need but not more (=motivated by an actual use case).

@tacaswell tacaswell removed the Good first issue Open a pull request against these issues if there are no active ones! label Apr 15, 2022
@tacaswell
Copy link
Member Author

Given the feedback, I'm going to close this.

If we end up needing something more sophisticated we will either remember and revive this or implement something more narrowly tailored.

@tacaswell tacaswell closed this Apr 15, 2022
@tacaswell tacaswell deleted the fix_method_patching branch April 15, 2022 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: Medium https://matplotlib.org/devdocs/devel/contribute.html#good-first-issues status: needs tests status: orphaned PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants