Type annotations for boto3.Shield 1.14.3 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-shield
Type annotations for boto3.Shield 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 Shield
service.
python -m pip install boto3-stubs[shield]
How to use
Client annotations
ShieldClient
provides annotations for boto3.client("shield")
.
import boto3
from mypy_boto3_shield import ShieldClient
from mypy_boto3_shield.paginator import ListAttacksPaginator, ListProtectionsPaginator
from mypy_boto3_shield.type_defs import AttackDetailTypeDef, ...
client: ShieldClient = boto3.client("shield")
# 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: ShieldClient = session.client("shield")
Paginators annotations
mypy_boto3_shield.paginator
module contains type annotations for all paginators.
client: ShieldClient = boto3.client("shield")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_attacks_paginator: ListAttacksPaginator = client.get_paginator("list_attacks")
list_protections_paginator: ListProtectionsPaginator = client.get_paginator("list_protections")
Typed dictionations
mypy_boto3_shield.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AttackDetailTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_shield
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("shield")
session_client = boto3.Session().client("shield")
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-shield-1.14.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d51ca80b1ce99e6a83fc310b8810839fc69a8afe144aafc4345d4838f0a10e5f |
|
MD5 | 580ad93fc20804069afe51da0294222f |
|
BLAKE2b-256 | 2922c5d5684a18c5860c4c3b9a1ddb050a92b33fb8d605cc7e19a5558fa7123d |
Hashes for mypy_boto3_shield-1.14.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ec222a9e3a736a2c5fa59a45c8c5454d1b814357c4343acb7c0a5d9b0c0715f |
|
MD5 | 91bf051db7ba3c724e33b44bb97f7587 |
|
BLAKE2b-256 | 0dee4b299db08e74707e0ec0a7c081bf31acd61cf333e34955826755d02b7e08 |