Skip to content

docs(idempotency): fix local_cache_max_items default in IdempotencyConfig docstring - #8731

Merged
leandrodamascena merged 2 commits into
aws-powertools:developfrom
lechakrawarthy:docs/idempotency-cache-default
Nov 15, 2026
Merged

leandrodamascena merged 2 commits into
aws-powertools:developfrom
lechakrawarthy:docs/idempotency-cache-default

Conversation

@lechakrawarthy

@lechakrawarthy lechakrawarthy commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Issue number:

closes #8729

Summary

Changes

The IdempotencyConfig docstring said local_cache_max_items defaults to 1024. The signature (local_cache_max_items: int = 256) and the docs table both use 256, so the docstring now says 256. Docstring-only change, no behaviour change.

Verification

Ran locally on Windows, Python from uv sync --locked --extra all --extra redis --extra datamasking (skipped the valkey extra because valkey-glide does not build on Windows):

uv run pytest tests/unit/idempotency tests/functional/idempotency -q
================ 202 passed, 84 warnings in 338.92s (0:05:38) =================

uv run ruff check aws_lambda_powertools/utilities/idempotency/config.py
All checks passed!

AI disclosure

This modification was implemented with the assistance of an AI-powered coding assistant. I executed the commands provided, and the resulting output is reproduced below exactly as displayed.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@lechakrawarthy
lechakrawarthy requested a review from a team as a code owner October 31, 2026 22:52
@boring-cyborg

boring-cyborg Bot commented Oct 31, 2026

Copy link
Copy Markdown

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@powertools-for-aws-oss-automation powertools-for-aws-oss-automation Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 31, 2026
@lechakrawarthy
lechakrawarthy force-pushed the docs/idempotency-cache-default branch from dedab2d to 9140cab Compare October 31, 2026 23:35
…nfig docstring

The docstring said the default was 1024; the signature and the docs table use 256.
@lechakrawarthy
lechakrawarthy force-pushed the docs/idempotency-cache-default branch from 9140cab to a6d96c5 Compare November 1, 2026 16:04
@leandrodamascena leandrodamascena added this to the 3.41.0 milestone Nov 1, 2026
@leandrodamascena

Copy link
Copy Markdown
Contributor

Thanks for the PR and for filling in the verification section, that helps. Heads up that the review may take a few days: this goes into 3.41.0 and I review every PR against a real service before approving, one at a time. No need to rebase or ping in the meantime, I'll come back here.

@leandrodamascena leandrodamascena left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @lechakrawarthy. Checked the signature and the docs table, both say 256, so the docstring was the odd one out. Approved. This goes out in 3.41.0, no rebase needed, credit in the release notes.

@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.17%. Comparing base (d07a9c2) to head (da9aa12).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8731   +/-   ##
========================================
  Coverage    97.17%   97.17%           
========================================
  Files          323      323           
  Lines        16606    16606           
  Branches      1504     1504           
========================================
  Hits         16137    16137           
  Misses         328      328           
  Partials       141      141           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@leandrodamascena
leandrodamascena merged commit ca74726 into aws-powertools:develop Nov 15, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: IdempotencyConfig docstring says local_cache_max_items defaults to 1024, it is 256

2 participants