mypy-boto3-shield 1.11.3.0

Type annotations for boto3.Shield 1.11.3 service.

mypy-boto3-shield

Type annotations for boto3.Shield 1.11.3 service compatible with mypy, VSCode, PyCharm and other tools.

More information can be found here.

• mypy-boto3-shield
  • How to use
    • Type checking
    • Code auto-complete
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for Shield service.

python -m pip install boto3-stubs[mypy-boto3-shield]

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import shield
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_shield as shield

# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("shield")
client: shield.ShieldClient = boto3.client("shield")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: shield.ShieldClient = session.client("shield")


# Paginators need type annotation on creation
list_attacks_paginator: shield.ListAttacksPaginator = client.get_paginator("list_attacks")
list_protections_paginator: shield.ListProtectionsPaginator = client.get_paginator("list_protections")

How it works

Fully automated builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers a drop-in type annotations for you and makes sure that:

• All available boto3 services are covered.
• Each public class and method of every boto3 service gets valid type annotations extracted from the documentation (blame botocore docs if types are incorrect).
• Type annotations include up-to-date documentation.
• Link to documentation is provided for every method.
• Code is processed by black for readability.