Type annotations for boto3.GlobalAccelerator 1.14.5 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-globalaccelerator
Type annotations for boto3.GlobalAccelerator 1.14.5 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 GlobalAccelerator
service.
python -m pip install boto3-stubs[globalaccelerator]
How to use
Client annotations
GlobalAcceleratorClient
provides annotations for boto3.client("globalaccelerator")
.
import boto3
from mypy_boto3_globalaccelerator import GlobalAcceleratorClient
from mypy_boto3_globalaccelerator.paginator import (
ListAcceleratorsPaginator,
ListEndpointGroupsPaginator,
ListListenersPaginator,
)
from mypy_boto3_globalaccelerator.type_defs import AcceleratorAttributesTypeDef, ...
client: GlobalAcceleratorClient = boto3.client("globalaccelerator")
# 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: GlobalAcceleratorClient = session.client("globalaccelerator")
Paginators annotations
mypy_boto3_globalaccelerator.paginator
module contains type annotations for all paginators.
client: GlobalAcceleratorClient = boto3.client("globalaccelerator")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_accelerators_paginator: ListAcceleratorsPaginator = client.get_paginator("list_accelerators")
list_endpoint_groups_paginator: ListEndpointGroupsPaginator = client.get_paginator("list_endpoint_groups")
list_listeners_paginator: ListListenersPaginator = client.get_paginator("list_listeners")
Typed dictionations
mypy_boto3_globalaccelerator.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AcceleratorAttributesTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_globalaccelerator
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("globalaccelerator")
session_client = boto3.Session().client("globalaccelerator")
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-globalaccelerator-1.14.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 014748b414bcbe8a08605f1493b1708726423178cfecf966f3bf0581e0f81876 |
|
MD5 | ea5fa5d16d7aea556883f7c5f5ecaaca |
|
BLAKE2b-256 | e74be931cc19c41f41028e44961b34ef0ff9a7e51b54f7c1c3cafd730ba397ca |
Hashes for mypy_boto3_globalaccelerator-1.14.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0173b1c0f4af748b5f67d80c0148c31cbea7e04228f326eb42d42c808ec155d2 |
|
MD5 | 7aaf8e5ced72159d9b79b02189d80dda |
|
BLAKE2b-256 | 5e5d92daab5eb6d4b1f247ad2dfffcccfd9282e431448452c783f36b4e743a21 |