Type annotations for boto3.DirectConnect 1.14.29 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-directconnect
Type annotations for boto3.DirectConnect 1.14.29 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 DirectConnect
service.
python -m pip install boto3-stubs[directconnect]
How to use
Client annotations
DirectConnectClient
provides annotations for boto3.client("directconnect")
.
import boto3
from mypy_boto3_directconnect import DirectConnectClient
from mypy_boto3_directconnect.paginator import (
DescribeDirectConnectGatewayAssociationsPaginator,
DescribeDirectConnectGatewayAttachmentsPaginator,
DescribeDirectConnectGatewaysPaginator,
)
from mypy_boto3_directconnect.type_defs import AssociatedGatewayTypeDef, ...
client: DirectConnectClient = boto3.client("directconnect")
# 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: DirectConnectClient = session.client("directconnect")
Paginators annotations
mypy_boto3_directconnect.paginator
module contains type annotations for all paginators.
client: DirectConnectClient = boto3.client("directconnect")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_direct_connect_gateway_associations_paginator: DescribeDirectConnectGatewayAssociationsPaginator = client.get_paginator("describe_direct_connect_gateway_associations")
describe_direct_connect_gateway_attachments_paginator: DescribeDirectConnectGatewayAttachmentsPaginator = client.get_paginator("describe_direct_connect_gateway_attachments")
describe_direct_connect_gateways_paginator: DescribeDirectConnectGatewaysPaginator = client.get_paginator("describe_direct_connect_gateways")
Typed dictionations
mypy_boto3_directconnect.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AssociatedGatewayTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_directconnect
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("directconnect")
session_client = boto3.Session().client("directconnect")
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-directconnect-1.14.29.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dd6f5121c4bc0d601043605792d5fb85134cda4a8c6b04b27a7c25e7d7586ad |
|
MD5 | ee2d0eaa2981dbbd30f38ceefcbc12e5 |
|
BLAKE2b-256 | 036c957ecfdde3e42676e265844c28cea6d0014f91b8196f18247c868078c5bb |
Hashes for mypy_boto3_directconnect-1.14.29.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01b9d9e82ba751fa0a3a8c1937d1dada9892b9f0a6012003bc84cbd470f38b8d |
|
MD5 | 3206559c7e3d90efc488109cdaa0c88a |
|
BLAKE2b-256 | 6b058569025ce7861c5907b5ffbcc468181b07a31671f32a796ba4a6caeb7de3 |