mypy-boto3-stepfunctions 1.14.28.0

Type annotations for boto3.SFN 1.14.28 service, generated by mypy-boto3-buider 2.2.0

mypy-boto3-stepfunctions

Type annotations for boto3.SFN 1.14.28 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 SFN service.

python -m pip install boto3-stubs[stepfunctions]

How to use

Client annotations

SFNClient provides annotations for boto3.client("stepfunctions").

import boto3

from mypy_boto3_stepfunctions import SFNClient
from mypy_boto3_stepfunctions.paginator import (
    GetExecutionHistoryPaginator,
    ListActivitiesPaginator,
    ListExecutionsPaginator,
    ListStateMachinesPaginator,
)
from mypy_boto3_stepfunctions.type_defs import ActivityFailedEventDetailsTypeDef, ...

client: SFNClient = boto3.client("stepfunctions")

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

Paginators annotations

mypy_boto3_stepfunctions.paginator module contains type annotations for all paginators.

client: SFNClient = boto3.client("stepfunctions")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_execution_history_paginator: GetExecutionHistoryPaginator = client.get_paginator("get_execution_history")
list_activities_paginator: ListActivitiesPaginator = client.get_paginator("list_activities")
list_executions_paginator: ListExecutionsPaginator = client.get_paginator("list_executions")
list_state_machines_paginator: ListStateMachinesPaginator = client.get_paginator("list_state_machines")

Typed dictionations

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

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

Dynamic type annotations

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

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