Type annotations for boto3.ApiGatewayV2 1.14.48 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-apigatewayv2
Type annotations for boto3.ApiGatewayV2 1.14.48 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ApiGatewayV2
service.
python -m pip install boto3-stubs[apigatewayv2]
How to use
Client annotations
ApiGatewayV2Client
provides annotations for boto3.client("apigatewayv2")
.
import boto3
from mypy_boto3_apigatewayv2 import ApiGatewayV2Client
from mypy_boto3_apigatewayv2.paginator import (
GetApisPaginator,
GetAuthorizersPaginator,
GetDeploymentsPaginator,
GetDomainNamesPaginator,
GetIntegrationResponsesPaginator,
GetIntegrationsPaginator,
GetModelsPaginator,
GetRouteResponsesPaginator,
GetRoutesPaginator,
GetStagesPaginator,
)
from mypy_boto3_apigatewayv2.type_defs import AccessLogSettingsTypeDef, ...
client: ApiGatewayV2Client = boto3.client("apigatewayv2")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ApiGatewayV2Client = session.client("apigatewayv2")
Paginators annotations
mypy_boto3_apigatewayv2.paginator
module contains type annotations for all paginators.
client: ApiGatewayV2Client = boto3.client("apigatewayv2")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_apis_paginator: GetApisPaginator = client.get_paginator("get_apis")
get_authorizers_paginator: GetAuthorizersPaginator = client.get_paginator("get_authorizers")
get_deployments_paginator: GetDeploymentsPaginator = client.get_paginator("get_deployments")
get_domain_names_paginator: GetDomainNamesPaginator = client.get_paginator("get_domain_names")
get_integration_responses_paginator: GetIntegrationResponsesPaginator = client.get_paginator("get_integration_responses")
get_integrations_paginator: GetIntegrationsPaginator = client.get_paginator("get_integrations")
get_models_paginator: GetModelsPaginator = client.get_paginator("get_models")
get_route_responses_paginator: GetRouteResponsesPaginator = client.get_paginator("get_route_responses")
get_routes_paginator: GetRoutesPaginator = client.get_paginator("get_routes")
get_stages_paginator: GetStagesPaginator = client.get_paginator("get_stages")
Typed dictionations
mypy_boto3_apigatewayv2.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccessLogSettingsTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_apigatewayv2
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("apigatewayv2")
session_client = boto3.Session().client("apigatewayv2")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-apigatewayv2-1.14.48.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63ddc9aed806090b5876e668ca863bb1289a27b2eb3b04f98f2e60f9a2eac7a0 |
|
MD5 | ca67dc6054dbadeec315794f1964dc90 |
|
BLAKE2b-256 | 0d622bd7414f665e9fb88506a5c11e2811f2f3eca937490a04f03698c32b215b |
Hashes for mypy_boto3_apigatewayv2-1.14.48.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 078d3a2901c2d5197d586de55065e976863b138c6b7a79dee4f4994a092f7406 |
|
MD5 | 7d9a77184bf32068e59f545976ce3f09 |
|
BLAKE2b-256 | 96fdb04d172b2190b39ace2ba67ea62b428e28142d057ccf8efe6a36e1bf356a |