Add CodSpeed performance benchmarking#86
Merged
Conversation
Contributor
Author
Congrats! CodSpeed is installed 🎉
You will start to see performance impacts in the reports once the benchmarks are run from your default branch.
|
nstarman
approved these changes
Jul 22, 2026
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
This PR sets up continuous performance measurement with CodSpeed for
dataclassish.It adds a benchmark suite covering the public multiple-dispatch API and wires up a GitHub Actions workflow so performance is measured automatically on every push to
mainand on pull requests.Changes
benchmarks/test_benchmarks.py: Apytest-codspeedbenchmark suite exercising the public API across the object typesdataclassishsupports:replace,asdict,field_itemsreplace,fields,asdict,astuple,get_field,field_keys,field_values,field_itemsconverters.dataclass/fieldwithOptionalandUnless).github/workflows/codspeed.yml: A CodSpeed workflow running insimulationmode. It authenticates via OpenID Connect (id-token: write), installs dependencies withuv, and runs the benchmarks withCodSpeedHQ/action. Actions are pinned by commit hash with version comments to match the existing workflow conventions.pyproject.toml/uv.lock: Addedpytest-codspeedto thetestdependency group.README.md: Added the CodSpeed badge.Notes
benchmarks/directory so they are not picked up by the regularpytesttest run (testpathsremains unchanged). The workflow invokes them explicitly with-p no:sybilto avoid collecting doctest/README fixtures.codspeed run --mode instrumentationand all 12 benchmarks were collected, executed, and uploaded successfully.Next steps
main.