Static typing: logger.append_keys produces a [no-untyped-call] mypy error

[FollowTheProcess]

Static type checker used

mypy (project's standard)

AWS Lambda function runtime

3.10

Powertools for AWS Lambda (Python) version

latest

Static type checker info

Output

error: Call to untyped function "append_keys" in typed context  [no-untyped-call]
        logger.append_keys(something="yes please")
        ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Config

# pyproject.toml
[tool.mypy]
files = [ "**/*.py" ]
ignore_missing_imports = true
strict = true
pretty = true
show_error_codes = true
warn_unreachable = true
enable_error_code = [ "ignore-without-code", "redundant-expr", "truthy-bool" ]
plugins = [ "pydantic.mypy" ]

Run

I just run mypy on the command line from within the virtual environment

Code snippet

from __future__ import annotations

from typing import TYPE_CHECKING, Any

from aws_lambda_powertools import Logger

if TYPE_CHECKING:
    from aws_lambda_powertools.utilities.typing import LambdaContext


logger = Logger(utc=True)


def lambda_handler(event: dict[str, Any], context: LambdaContext) -> dict[str, Any]:
    logger.append_keys(something="yes please") # Error here
    return {"hello": "world"}

Possible Solution

It seems that in a few places in powertools where a function or method would return None, the return type annotation is omitted. One such example is append_keys

powertools-lambda-python/aws_lambda_powertools/logging/logger.py

Line 596 in 812b63d

def append_keys(self, **additional_keys):

The solution would be to simply add -> None: as the return type annotation 🙂, preferably in other places where it's missing too.

Happy to do a PR for this, just waiting for triage 👍🏻

[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

[heitorlessa]

Hey @FollowTheProcess please feel free to send a PR 🥹

Thank you for taking the time to fill in such a great static typing issue -- we will definitely use this as a great example to follow ;)

We're at events this week hence small delays in our usual response/triaging.

Thank you!!

[FollowTheProcess]

Great! Done a first pass in #3113, surfaced a few questions though 🙂

[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 2.25.1 version!