Fix #1325: Put cached properties in class __dict__ (not the nonexistent instance __dict__) for slotted classes#1516
Closed
clayote wants to merge 9 commits into
Closed
Conversation
8f37ad1 to
4545f0b
Compare
I have not worked out how to make the annotation really show up in generated Sphinx output. At least the docstring is there.
4ecfa51 to
8bfb9f1
Compare
for more information, see https://pre-commit.ci
They still don't say they're `property`s
for more information, see https://pre-commit.ci
The property objects do nothing, because they're not accessible from the instance -- slotted instances have no __dict__, but their *class object* does have __dict__, and that's the __dict__ that Sphinx looks at to find class members to document.
@cached_propertys
Author
|
Well, the dictionary |
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.
Summary
I couldn't get Sphinx to generate docstrings for
@cached_propertys on attrs' defaultslots=Trueclasses. Trying to replace the generated__getattr__didn't perform so well...but,__slots__can be a dictionary, and that dictionary can have docstrings in it. This PR makes attrs generate__slots__as a dictionary, with docstrings copied from the decorated@cached_propertyfunctions.I still wanted Sphinx to document these like normal
@cached_property, so I looked into Sphinx's code, and it turns out that it looks specifically at the class's__dict__to find members to document. So I put thecached_propertyobjects back into that__dict__after class instantiation, and it worked! Thosecached_propertyobjects are never called, but they look just like usual from Sphinx's point of view.That makes the
__slots__dictionary somewhat redundant, but I'd rather keep it, since it meanshelp()works on those instance attributes.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, ordeprecateddirectives.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.
attrs.define()andattr.s(), you have to add version directives to both..rstand.mdfiles is written using semantic newlines.changelog.d.