Put a custom, nonfunctional @property in place of slotted @cached_property for documentation purposes#1512
Open
clayote wants to merge 51 commits intopython-attrs:mainfrom
Open
Put a custom, nonfunctional @property in place of slotted @cached_property for documentation purposes#1512clayote wants to merge 51 commits intopython-attrs:mainfrom
@property in place of slotted @cached_property for documentation purposes#1512clayote wants to merge 51 commits intopython-attrs:mainfrom
Conversation
This renames the slots previously named the same as the `@cached_property` they were made for. They now have the suffix `_cache`, so that we can name the `@property` the same as the `@cached_property`.
I'm still confused about why this code gets run at all, but at least it acts the same as cached properties now
Better than calling __getattr__ ourselves because of recursion
At least, I think this is correct. When I run the original code in a terminal, without the changes from this branch, that's how it behaves. Is my Python setup messed?
for more information, see https://pre-commit.ci
Author
|
I'm not super committed to this approach; if #1488 bears fruit, this can be closed. |
Merging this PR will degrade performance by 86.32%
Performance Changes
Comparing Footnotes |
for more information, see https://pre-commit.ci
(cherry picked from commit 37dff27)
for more information, see https://pre-commit.ci
# Conflicts: # tests/test_slots.py
for more information, see https://pre-commit.ci
…n Python versions
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
I haven't worked out why those return annotations only *sometimes* come back as `str`.
I guess this will break if the metaclass has `__slots__`? Seems unlikely...
…cached_property_return_annotation`
It seemed to be getting called anyway! May as well! This made it pretty pointless to generate a `__getattr__`, so I've removed `_make_cached_property_getattr`
for more information, see https://pre-commit.ci
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a tiny
@propertyin place of any deleted@cached_propertyin a rewritten class withslots=True. The@propertywon't be called, but still has the same return annotation and docstring as its@cached_property, so thathelp()and Sphinx can read them.This renames the slots previously named the same as the
@cached_propertythey were made for. They now have the suffix_cache, so that we can name the@propertythe same as the@cached_property.Summary
Fixes #1325
Pull Request Check List
mainbranch – use a separate branch!Our CI fails if coverage is not 100%.
.pyi).typing-examples/baseline.pyor, if necessary,typing-examples/mypy.py.attr/__init__.pyi, they've also been re-imported inattrs/__init__.pyi.docs/api.rstby hand.@attr.s()and@attrs.define()have to be added by hand too.versionadded,versionchanged, ordeprecatedIs this still a thing with strictly internal functions?
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.
- n/a If something changed that affects both
attrs.define()andattr.s(), you have to add version directives to both..rstand.mdfiles is written using semantic newlines.changelog.d.