Skip to content

Conversation

eendebakpt
Copy link
Contributor

@eendebakpt eendebakpt commented Aug 29, 2025

Summary

We improve performance of attrs.asdict by:

  • Using a fast check for atomic types (list int, float or str)
  • Using issubclass instead of isinstance for various type checks

Benchmark:

asdict: Mean +- std dev: [main] 4.07 us +- 0.41 us -> [pr] 2.48 us +- 0.21 us: 1.64x faster

Benchmark hidden because not significant (1): instance creation

Geometric mean: 1.28x faster
Test script
import pyperf

setup = """
from attrs import define, asdict

@define
class Simple:
     i : int
     s : str
     l : list

s = Simple(10, 'hi', [3, 1, 4])

"""

runner = pyperf.Runner()
runner.timeit(name="instance creation", stmt="Simple(10, 'hi', [3, 1, 4])", setup=setup)
runner.timeit(name="asdict", stmt="asdict(s)", setup=setup)

Notes:

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%.
  • 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 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.

hynek added a commit that referenced this pull request Aug 30, 2025
In preparation for #1463

Co-authored-by: Pieter Eendebak <883786+eendebakpt@users.noreply.github.com>
hynek added a commit that referenced this pull request Aug 30, 2025
In preparation for #1463

Co-authored-by: Pieter Eendebak <883786+eendebakpt@users.noreply.github.com>
Copy link

codspeed-hq bot commented Aug 30, 2025

CodSpeed Performance Report

Merging #1463 will improve performances by ×2.6

Comparing eendebakpt:asdict_atomic_types (7257b83) with main (5d216e6)

Summary

⚡ 2 improvements
✅ 10 untouched benchmarks

Benchmarks breakdown

Benchmark BASE HEAD Change
test_asdict_atomic 16.3 ms 6.3 ms ×2.6
test_asdict_complicated 13.8 ms 9.5 ms +45.44%

@@ -66,6 +66,20 @@ def test_recurse(self, C, dict_class):
C(C(1, 2), C(3, 4)), dict_factory=dict_class
)

def test_non_atomic_types(self, C):
"""
Test subclasses of atomic types
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't conform with our docstring standard and proves why it's important :)

What exactly is tested here? (c.f. https://hynek.me/articles/document-your-tests/ for more context)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The method name and docstring indeed did not match, I updated the name.

I was trying to test the else branch inside the recursive part of the asdict implementation. The branch covers non-atomic objects minus some container types. I could add some more tests (e.g. fraction.Fraction) if needed.

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.

2 participants