aws-error-utils icon indicating copy to clipboard operation
aws-error-utils copied to clipboard

Pyright thinks symbols are not exported

Open holocronweaver opened this issue 1 year ago • 1 comments

First off, thanks for this package, it really cuts down on the boto3 error handling boilerplate and makes it more like a proper Python package!

Problem

Pyright complains symbols like errors are not publicly exported, which breaks auto-completion and other IDE features.

So direct imports work: from aws_error_utils.aws_error_utils import errors But not lib-level imports: from aws_error_utils import errors

After a bit of research, it seems Python type checkers expect py.typed libraries to re-export symbols to make them public based on guidance from PEP 484.

Proposal

I opened PR #8 to solve this issue by redundantly re-exporting symbols. Not the most elegant solution, but it seems to be what Python type checkers expect.

holocronweaver avatar Nov 09 '23 00:11 holocronweaver

I'm nearing the end of my time off, and I plan on fully re-engaging with all of my projects, but realistically it means nothing is going to be addressed until early next year.

benkehoe avatar Nov 10 '23 20:11 benkehoe