mypy-boto3-stepfunctions 1.12.45.0

Type annotations for boto3.SFN 1.12.45 service, generated by mypy-boto3-buider 1.0.7

mypy-boto3-stepfunctions

Type annotations for boto3.SFN 1.12.45 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 1.0.7.

More information can be found on boto3-stubs page.

• mypy-boto3-stepfunctions
  • How to use
    • Type checking
  • How it works

How to use

Type checking

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

Install boto3-stubs for SFN service.

python -m pip install boto3-stubs[stepfunctions]

# update installed packages index
mypy_boto3

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

import boto3

from mypy_boto3 import stepfunctions
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_stepfunctions as stepfunctions

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

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


# Paginators need type annotation on creation
get_execution_history_paginator: stepfunctions.GetExecutionHistoryPaginator = client.get_paginator("get_execution_history")
list_activities_paginator: stepfunctions.ListActivitiesPaginator = client.get_paginator("list_activities")
list_executions_paginator: stepfunctions.ListExecutionsPaginator = client.get_paginator("list_executions")
list_state_machines_paginator: stepfunctions.ListStateMachinesPaginator = client.get_paginator("list_state_machines")

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.