mypy-boto3-backup 1.14.2.0

Type annotations for boto3.Backup 1.14.2 service, generated by mypy-boto3-buider 2.2.0

mypy-boto3-backup

Type annotations for boto3.Backup 1.14.2 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 Backup service.

python -m pip install boto3-stubs[backup]

How to use

Client annotations

BackupClient provides annotations for boto3.client("backup").

import boto3

from mypy_boto3_backup import BackupClient
from mypy_boto3_backup.type_defs import BackupJobTypeDef, ...

client: BackupClient = boto3.client("backup")

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

Typed dictionations

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

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

Dynamic type annotations

mypy_boto3 command generates boto3.client/resource type annotations for mypy_boto3_backup 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("backup")

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