mypy-boto3-synthetics 1.14.41.0

Type annotations for boto3.Synthetics 1.14.41 service, generated by mypy-boto3-buider 2.2.0

mypy-boto3-synthetics

Type annotations for boto3.Synthetics 1.14.41 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 Synthetics service.

python -m pip install boto3-stubs[synthetics]

How to use

Client annotations

SyntheticsClient provides annotations for boto3.client("synthetics").

import boto3

from mypy_boto3_synthetics import SyntheticsClient
from mypy_boto3_synthetics.type_defs import CanaryCodeOutputTypeDef, ...

client: SyntheticsClient = boto3.client("synthetics")

# 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: SyntheticsClient = session.client("synthetics")

Typed dictionations

mypy_boto3_synthetics.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

def get_structure() -> CanaryCodeOutputTypeDef:
    return {
      ...
    }

Dynamic type annotations

mypy_boto3 command generates boto3.client/resource type annotations for mypy_boto3_synthetics 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 expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
• VSCode 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("synthetics")

session_client = boto3.Session().client("synthetics")