Static typing: @metrics.log_metrics decorator

[ChrisHills463]

Static type checker used

pyright/pylance

AWS Lambda function runtime

3.11

Powertools for AWS Lambda (Python) version

latest

Static type checker info

# error: Argument missing for parameter "context" (reportGeneralTypeIssues)

Code snippet

@metrics.log_metrics(capture_cold_start_metric=True)   # error: Argument missing for parameter "context" (reportGeneralTypeIssues)
def lambda_handler(event: dict, context: LambdaContext) -> dict:
    return app.resolve(event, context)

Possible Solution

This is a known issue with pyright (see pyright#3265). See also this Discord discussion.

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[rubenfonseca]

Confirmed I'm seeing this too. Added to the backlog. Thank you for opening this @ChrisHills463

[leandrodamascena]

I'm not sure if it's related (I haven't checked), but we recently had a small refactoring on some parts of this code:

https://github.com/aws-powertools/powertools-lambda-python/pull/3460/files#diff-49bfc9264b598c920d5bef978e668726dc09f7a8fc27f4aae974849ecab60ee2

[alanwill]

@rubenfonseca @leandrodamascena any idea when this should be resolved or if there's a workaround? We've recently moved to using powertools throughout our app with many lambda functions and this keeps being a pesky linter error to stare at daily and not able to action. Any guidance would be appreciated.

[leandrodamascena]

Hey everyone! We have a PR #6000 to improve this type annotation. This will probably be release tomorrow in our alpha releases process and I appreciate any type ok feedback.

While we strive to enhance type safety, it's important to note that supporting strict typing is a best-effort approach and not guaranteed in Powertools.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

This is now released under 3.6.0 version!