Type annotations for boto3.Shield 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-shield
Type annotations for boto3.Shield 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 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
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.
from mypy_boto3_shield import ShieldClient
from mypy_boto3_shield.paginator import (
ListAttacksPaginator,
ListProtectionsPaginator,
)
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.
from mypy_boto3_shield.type_defs import AttackDetailTypeDef, ...
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
import boto3
# 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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94d7833078e0746d1ee345926f094704777fcf8e0f63b6312c7977e40e585b99 |
|
MD5 | 9d83d940a51d1541f3502b6ec02f84b5 |
|
BLAKE2b-256 | f1bf91e9d91e545f41655a7535967b8aa844813365413e3fa5226bb3c3111a1d |
Hashes for mypy_boto3_shield-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46b97d15c2dd8b9a4a61ca8f73cc65025b26eb865eb5be80204f84f532d4d9dd |
|
MD5 | 2a6d8b9cd65c8cfe99eda40327d7590c |
|
BLAKE2b-256 | d5383dff287b168b1437966cbb561218a406efd553d4cfbc6f6144a9bd761fc4 |