Skip to content

Comments

Add a Sphinx extension to document cached properties of slots classes#1519

Open
clayote wants to merge 4 commits intopython-attrs:mainfrom
clayote:sphinx-attr-getter-ext
Open

Add a Sphinx extension to document cached properties of slots classes#1519
clayote wants to merge 4 commits intopython-attrs:mainfrom
clayote:sphinx-attr-getter-ext

Conversation

@clayote
Copy link

@clayote clayote commented Feb 21, 2026

Summary

This is a small extension for Sphinx, the documentation generator that attrs uses. Where cached properties on slots classes were missing previously (#1325), this extension restores them.

I added a dictionary to slotted class objects, __attrs_cached_properties__, where they keep the cached property objects for Sphinx.

To use the extension, add "attrs.sphinx_cached_property" to extensions in your Sphinx conf.py.

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 pull request to be accepted, but you have been warned.
  • Added tests for changed code.
    Our CI fails if coverage is not 100%.
  • Changes or additions to public APIs are reflected in our type stubs (files ending in .pyi).
    • ...and used in the stub test file typing-examples/baseline.py or, if necessary, typing-examples/mypy.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 signatures of @attr.s() and @attrs.define() 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.
      • If something changed that affects both attrs.define() and attr.s(), you have to add version directives to both.
  • 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.

@clayote clayote force-pushed the sphinx-attr-getter-ext branch 2 times, most recently from 6fce05b to 365bc5c Compare February 21, 2026 18:27
@clayote
Copy link
Author

clayote commented Feb 21, 2026

I wrote a test for this, but it won't run in CI currently, because that test requires Sphinx to be installed. That's why the pre-commit check is failing.

@clayote clayote marked this pull request as ready for review February 21, 2026 18:51
@clayote clayote force-pushed the sphinx-attr-getter-ext branch 3 times, most recently from 2cb97a6 to 4eb690d Compare February 22, 2026 03:03
@clayote clayote force-pushed the sphinx-attr-getter-ext branch from 1daa5c1 to b21e641 Compare February 22, 2026 03:04
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.

1 participant