Type annotations for boto3.ApiGatewayV2 1.14.3 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-apigatewayv2
Type annotations for boto3.ApiGatewayV2 1.14.3 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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5ef31d1ce8786bb58a4e6854934a844ca331e5ec986745144440a38a20e1557 |
|
MD5 | 2742fe0bf506a499354f9198a64a3cbb |
|
BLAKE2b-256 | 80298cb4799b6677bab21e42b25b71ba0ff904490e0227dab511293a5b9e5822 |
Hashes for mypy_boto3_apigatewayv2-1.14.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df6c02dd0ae8d5f00a21a8f0f3a28003c763d708573274197d9bd729506cd8d2 |
|
MD5 | 63c1afc4db5a39d6e3354479240ced3e |
|
BLAKE2b-256 | 72a1b06b1a2a65cf46ae6340b472002501fd60e596630aeb077cfe32472ccf3b |