docs(examples): enforce and fix all mypy errors #1393

heitorlessa · 2022-07-28T09:08:08Z

Issue number: #1389

Summary

Changes

Please provide a summary of what's being changed

This fixes 50 static typing errors, some customer facing others being mostly due to sentinel values not having a proper typing solution yet.

List of all errors fixed

examples/event_handler_graphql/src/scalar_functions.py:12:1: error: Name "_" already defined on line 11  [no-redef]
examples/event_handler_graphql/src/scalar_functions.py:13:1: error: Name "_" already defined on line 11  [no-redef]
examples/event_handler_graphql/src/scalar_functions.py:14:1: error: Name "_" already defined on line 11  [no-redef]
examples/event_handler_graphql/src/scalar_functions.py:15:1: error: Name "_" already defined on line 11  [no-redef]
examples/tracer/src/sdk_escape_hatch.py:14:10: error: Item "None" of "Optional[BaseProvider]" has no attribute "in_subsegment"  [union-attr]
examples/tracer/src/sdk_escape_hatch.py:14:10: error: Need type annotation for "subsegment"  [var-annotated]
examples/tracer/src/sdk_escape_hatch.py:15:9: error: <nothing> has no attribute "put_annotation"  [attr-defined]
examples/tracer/src/sdk_escape_hatch.py:17:9: error: <nothing> has no attribute "put_metadata"  [attr-defined]
examples/tracer/src/patch_modules.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/tracer/src/ignore_endpoints.py:3:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/tracer/src/disable_capture_error.py:3:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/logger/src/logging_exceptions.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/logger/src/append_keys_vs_extra.py:3:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/split_route_prefix_module.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/split_route_module.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/setting_cors.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/raising_http_errors.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/not_found_routes.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/http_methods_multiple.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/http_methods.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/getting_started_rest_api_resolver.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/getting_started_http_api_resolver.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/getting_started_alb_api_resolver.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/fine_grained_responses.py:4:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/exception_handling.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/dynamic_routes.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/debug_mode.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/custom_serializer.py:5:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/compressing_responses.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/assert_http_response_module.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/accessing_request_details_headers.py:1:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_rest/src/accessing_request_details.py:3:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/event_handler_graphql/src/getting_started_graphql_api_resolver.py:3:1: error: Library stubs not installed for "requests" (or incompatible with Python 3.9)  [import]
examples/tracer/src/disable_capture_response_streaming_body.py:4:1: error: Skipping analyzing "botocore.response": module is installed, but missing library stubs or py.typed marker  [import]
examples/logger/src/bring_your_own_json_serializer.py:3:1: error: Cannot find implementation or library stub for module named "orjson"  [import]
examples/logger/src/bring_your_own_formatter_from_scratch.py:38:53: error: Missing positional argument "log_record_order" in call to "CustomFormatter"  [call-arg]
examples/event_handler_rest/src/split_route_prefix_module.py:28:20: error: Incompatible types in assignment (expression has type "Optional[str]", variable has type "str")  [assignment]
examples/event_handler_rest/src/split_route_module.py:28:20: error: Incompatible types in assignment (expression has type "Optional[str]", variable has type "str")  [assignment]
examples/event_handler_rest/src/not_found_routes.py:4:1: error: Module "aws_lambda_powertools.event_handler" has no attribute "Response"  [attr-defined]
examples/event_handler_rest/src/fine_grained_responses.py:7:1: error: Module "aws_lambda_powertools.event_handler" has no attribute "Response"  [attr-defined]
examples/event_handler_rest/src/binary_responses.py:14:25: error: Unsupported left operand type for + ("None")  [operator]
examples/event_handler_graphql/src/graphql_transformer_search_merchant.py:36:18: error: Generator has incompatible item type "Merchant"; expected "List[Merchant]"  [misc]
examples/event_handler_graphql/src/graphql_transformer_search_merchant.py:41:1: error: Missing return statement  [return]
examples/event_handler_graphql/src/graphql_transformer_merchant_info.py:35:1: error: Missing return statement  [return]
examples/event_handler_graphql/src/custom_models.py:26:16: error: Incompatible return value type (got "Optional[str]", expected "str")  [return-value]
examples/event_handler_graphql/src/custom_models.py:30:16: error: Incompatible return value type (got "Optional[str]", expected "str")  [return-value]
examples/event_handler_graphql/src/custom_models.py:36:18: error: AppSyncResolverEventT? has no attribute "country_viewer"  [attr-defined]
examples/event_handler_graphql/src/custom_models.py:42:1: error: Missing return statement  [return]
examples/event_handler_graphql/src/assert_async_graphql_response_module.py:29:26: error: Value of type "Coroutine[Any, Any, Any]" is not indexable  [index]
examples/event_handler_graphql/src/assert_async_graphql_response.py:6:1: error: Module "assert_async_graphql_response_module" has no attribute "Location"  [attr-defined]

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Meet tenets criteria
I have performed a self-review of this change
Changes have been tested
Changes are documented
PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

Migration process documented
Implement warnings (if it can live side by side)

Acknowledgment

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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

View rendered docs/core/event_handler/api_gateway.md

Signed-off-by: heitorlessa <[email protected]>

…ch debt

heitorlessa · 2022-07-28T09:33:39Z

Looking at the best way to provide up-to-date doc while supporting older Python versions.

…ws-lambda-powertools-python into docs/examples-mypy * 'docs/examples-mypy' of https://github.com/heitorlessa/aws-lambda-powertools-python: chore(mypy): use backward compatible List annotation

… change

heitorlessa · 2022-07-28T10:13:11Z

Related PR #1395 required to merge first otherwise we can't resolve dependencies to proceed with backwards compatible TypedDict

…tools-python into docs/examples-mypy * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: chore(ci): drop 3.6 from workflows (aws-powertools#1395) chore(maintainers): add Ruben as a maintainer (aws-powertools#1392)

codecov-commenter · 2022-07-28T11:15:48Z

Codecov Report

Merging #1393 (0fd0820) into develop (279ba24) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop    #1393   +/-   ##
========================================
  Coverage    99.88%   99.88%           
========================================
  Files          119      119           
  Lines         5429     5429           
  Branches       620      620           
========================================
  Hits          5423     5423           
  Misses           2        2           
  Partials         4        4

Impacted Files	Coverage Δ
aws_lambda_powertools/event_handler/appsync.py	`100.00% <ø> (ø)`
aws_lambda_powertools/event_handler/__init__.py	`100.00% <100.00%> (ø)`
aws_lambda_powertools/tracing/base.py	`100.00% <100.00%> (ø)`
aws_lambda_powertools/tracing/tracer.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a0ddd46...0fd0820. Read the comment docs.

This reverts commit d3d196e.

…tools-python into develop * 'develop' of https://github.com/awslabs/aws-lambda-powertools-python: feat(idempotency): handle lambda timeout scenarios for INPROGRESS records (#1387) chore(deps): bump jsii from 1.57.0 to 1.63.1 (#1390) chore(deps): bump constructs from 10.1.1 to 10.1.59 (#1396) chore(deps-dev): bump flake8-isort from 4.1.1 to 4.1.2.post0 (#1384) docs(examples): enforce and fix all mypy errors (#1393) chore(ci): drop 3.6 from workflows (#1395)

heitorlessa added 16 commits July 28, 2022 09:10

chore(mypy): fix redef _

53ad2ed

fix(tracer): correct ctx manager and default provider type

ab10966

chore(mypy): add requests type def as dev dep

c55a9c1

chore(mypy): ignore lack of botocore types

3ba9e8a

Signed-off-by: heitorlessa <[email protected]>

chore(mypy): ignore lack of orjson types

f905451

chore(example): fix constructor default

6c24df6

chore(mypy): ignore sentinel value assignment; needs issue

23b5179

docs(examples): fix incorrect type response and Response class

91ead7f

chore(mypy): fix potential none operator

15b6351

chore(mypy): fix return type on graphql merchant

ff5ec56

chore(mypy): fix missing return

6718279

chore(mypy): ignore sentinel type, missing return

3ae1575

chore(mypy): ignore present attr defined in custom model; note for te…

fe713c3

…ch debt

chore(mypy): fix import and type annotation on async graphql

306bfd3

chore(mypy): fix coroutine response not being ready to subscribe

f1d1ff3

chore(ci): ensure mypy runs on examples

a9e7ca5

heitorlessa requested a review from a team as a code owner July 28, 2022 09:08

heitorlessa requested review from rubenfonseca and removed request for a team July 28, 2022 09:08

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 28, 2022

boring-cyborg bot added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation event_handlers internal Maintenance changes typing Static typing definition related issues (mypy, pyright, etc.) tracer labels Jul 28, 2022

heitorlessa changed the title ~~chore(mypy): fix redef _~~ docs(examples): enforce and fix all mypy errors Jul 28, 2022

heitorlessa added 2 commits July 28, 2022 11:16

chore(mypy): address leftovers

3135117

chore(mypy): use backward compatible List annotation

bb583f4

heitorlessa added 5 commits July 28, 2022 11:41

chore(mypy): use backward compatible List annotation

cf29df7

Merge branch 'docs/examples-mypy' of https://github.com/heitorlessa/a…

d0ede58

…ws-lambda-powertools-python into docs/examples-mypy * 'docs/examples-mypy' of https://github.com/heitorlessa/aws-lambda-powertools-python: chore(mypy): use backward compatible List annotation

chore(mypy): add typing_extensions, 3.6 3.7 compatible changes

cb791a4

docs(examples): fix highlighting due to backwards compatible typedict…

1cbf580

… change

chore: leftover from rebase

5004034

heitorlessa mentioned this pull request Jul 28, 2022

chore(ci): drop 3.6 from workflows #1395

Merged

7 tasks

rubenfonseca approved these changes Jul 28, 2022

View reviewed changes

heitorlessa added 2 commits July 28, 2022 13:42

chore(mypy): add leftover assignment ignore

d3d196e

Revert "chore(mypy): add leftover assignment ignore"

4a98d0e

This reverts commit d3d196e.

heitorlessa merged commit 723effc into aws-powertools:develop Jul 28, 2022

heitorlessa deleted the docs/examples-mypy branch July 28, 2022 11:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(examples): enforce and fix all mypy errors #1393

docs(examples): enforce and fix all mypy errors #1393

heitorlessa commented Jul 28, 2022 •

edited by markdownify bot

Loading

heitorlessa commented Jul 28, 2022

heitorlessa commented Jul 28, 2022

codecov-commenter commented Jul 28, 2022

docs(examples): enforce and fix all mypy errors #1393

docs(examples): enforce and fix all mypy errors #1393

Conversation

heitorlessa commented Jul 28, 2022 • edited by markdownify bot Loading

Summary

Changes

User experience

Checklist

Acknowledgment

heitorlessa commented Jul 28, 2022

heitorlessa commented Jul 28, 2022

codecov-commenter commented Jul 28, 2022

Codecov Report

heitorlessa commented Jul 28, 2022 •

edited by markdownify bot

Loading