Static typing: Errors when importing top-level modules such as Logger

[kmkhr]

Static type checker used

pyright/pylance

AWS Lambda function runtime

3.9

AWS Lambda Powertools for Python version

latest

Static type checker info

"Logger" is not exported from module "aws_lambda_powertools"
Import from "aws_lambda_powertools.logging" instead Pylance reportPrivateImportUsage

Code snippet

from aws_lambda_powertools import Logger

Possible Solution

The following changes need to be made to aws_lambda_powertools/__init__.py.

# re-export it as Logger
from .logging import Logger as Logger # noqa: F401

or

from .logging import Logger # noqa: F401
# include it in __all__
__all__ = ["Logger"]

reference:

• https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-no-implicit-reexport
• https://github.com/python/typing/blob/master/docs/source/libraries.rst#how-much-of-my-library-needs-types

[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 AWS Lambda Powertools Discord: Invite link

[heitorlessa]

Closing as we're wrap to launch V2

[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.