Type annotations for boto3.SFN 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-stepfunctions
Type annotations for boto3.SFN 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for SFN
service.
python -m pip install boto3-stubs[stepfunctions]
Use boto3
with mypy_boto3_stepfunctions
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_stepfunctions import SFNClient
# Now mypy can check if your code is valid.
client: SFNClient = boto3.client("stepfunctions")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: SFNClient = session.client("stepfunctions")
# Annotated paginators are included as well
import mypy_boto3_stepfunctions.paginator as stepfunctions_paginators
get_execution_history_paginator: stepfunctions_paginators.GetExecutionHistoryPaginator = client.get_paginator("get_execution_history")
list_activities_paginator: stepfunctions_paginators.ListActivitiesPaginator = client.get_paginator("list_activities")
list_executions_paginator: stepfunctions_paginators.ListExecutionsPaginator = client.get_paginator("list_executions")
list_state_machines_paginator: stepfunctions_paginators.ListStateMachinesPaginator = client.get_paginator("list_state_machines")
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 expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("stepfunctions")
session_client = boto3.Session().client("stepfunctions")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-stepfunctions-1.14.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6ce2869113cac5607e001acd2032cccdbad2b7c9fec21e281311e9a81a8d770 |
|
MD5 | 0a4996ce02778217abf1a3b88d27fd65 |
|
BLAKE2b-256 | ed725ecf8b2f3aa65572847c056bc88f0eab2713445d24f00b030afb1d32abd4 |
Hashes for mypy_boto3_stepfunctions-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b4794e685b0894851b034af4312e7b263ad96ba2c2a978473d0b99cedf34024 |
|
MD5 | 1f5730170a792518fed9187d720f72d0 |
|
BLAKE2b-256 | c8c48403b9c0fd15c6279eb472e57e0976b4d13ebe054b2068142cc0d8bbeb47 |