Type annotations for boto3.GlobalAccelerator 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-globalaccelerator
Type annotations for boto3.GlobalAccelerator 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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
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.
from mypy_boto3_globalaccelerator import GlobalAcceleratorClient
from mypy_boto3_globalaccelerator.paginator import (
ListAcceleratorsPaginator,
ListEndpointGroupsPaginator,
ListListenersPaginator,
)
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.
from mypy_boto3_globalaccelerator.type_defs import AcceleratorAttributesTypeDef, ...
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
import boto3
# 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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07b3ad0fbb76198ac07206097aaab8baec8953f0972d3c27b29851ffb78d78ce |
|
MD5 | 25a72502c9840cdf032e5f28a5985993 |
|
BLAKE2b-256 | 4a9e307363551151cd293b8b5d2846708b4bcc6c580423a34f8233aebc4d15ea |
Hashes for mypy_boto3_globalaccelerator-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27b9f05e08dc6e8121af38a6ce837f09522084f21cfe5d782c31ecf8fb762522 |
|
MD5 | 98d5615b736790f0a8f909b91ce94eef |
|
BLAKE2b-256 | 372f413e5cc863914e86f98813aa51a497e674ffafe4ebac62e43fdc5147340c |