Skip to content
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

Define __getattribute__() instead of __getattr__() on slotted classes with cached properties #1291

Closed
wants to merge 2 commits into from

Conversation

dlax
Copy link
Contributor

@dlax dlax commented Jun 3, 2024

Summary

Fix #1288

Method __getattribute__() is documented as the "way to to actually get total control over attribute access" so we change the implementation of slotted classes with cached properties by defining a __getattribute__() method instead of __getattr__() previously.

Just changing that preserves the current behaviour, according to the test suite, but also makes sub-classing work better, e.g. when the subclass is not an attr-class and also defines a custom __getattr__() as evidenced in added test from #1288.

In tests, we replace most custom __getattr__() definitions by equivalent __getattribute__() ones, except in regression tests where __getattr__() is explicitly involved. Also, in test_slots_with_multiple_cached_property_subclasses_works(), we replace the if hasattr(super(), "__getattr__"): by a try:/except AttributeError: as using hasattr(..., "__getattribute__") would be meaningless since __getattribute__() is always defined.

Pull Request Check List

  • Do not open pull requests from your main branch – use a separate branch!
    • There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch.
    • This is not a pre-requisite for your your pull request to be accepted, but you have been warned.
  • Added tests for changed code.
    Our CI fails if coverage is not 100%.
  • New features have been added to our Hypothesis testing strategy.
  • Changes or additions to public APIs are reflected in our type stubs (files ending in .pyi).
    • ...and used in the stub test file tests/typing_example.py.
    • If they've been added to attr/__init__.pyi, they've also been re-imported in attrs/__init__.pyi.
  • Updated documentation for changed code.
    • New functions/classes have to be added to docs/api.rst by hand.
    • Changes to the signature of @attr.s() have to be added by hand too.
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
      The next version is the second number in the current release + 1.
      The first number represents the current year.
      So if the current version on PyPI is 22.2.0, the next version is gonna be 22.3.0.
      If the next version is the first in the new year, it'll be 23.1.0.
  • Documentation in .rst and .md files is written using semantic newlines.
  • Changes (and possible deprecations) have news fragments in changelog.d.
  • Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

Method `__getattribute__()` is documented as the "way to to actually get
total control over attribute access" [1] so we change the implementation
of slotted classes with cached properties by defining a
`__getattribute__()` method instead of `__getattr__()` previously.

[1]: https://docs.python.org/3/reference/datamodel.html#customizing-attribute-access

Just changing that preserves the current behaviour, according to the
test suite, but also makes sub-classing work better, e.g. when the
subclass is not an attr-class and also defines a custom __getattr__() as
evidenced in added test.

In tests, we replace most custom `__getattr__()` definitions by
equivalent `__getattribute__()` ones, except in regression tests where
`__getattr__()` is explicitly involved. Also, in
test_slots_with_multiple_cached_property_subclasses_works(), we replace
the `if hasattr(super(), "__getattr__"):` by a `try:`/`except
AttributeError:` as using `hasattr(..., "__getattribute__")` would be
meaningless since `__getattribute__()` is always defined.

Fix python-attrs#1288
Copy link

codspeed-hq bot commented Jul 13, 2024

CodSpeed Performance Report

Merging #1291 will not alter performance

Comparing dlax:issue-1288 (1d845e3) with main (edcaf04)

Summary

✅ 12 untouched benchmarks

@hynek
Copy link
Member

hynek commented Jul 17, 2024

Closing due to #1288 (comment) – thank you very much for the work though! Sometimes it takes an experiment to find out.

@hynek hynek closed this Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

__getattr__ in child class gets called when mixed with cached_property
2 participants