Type annotations for boto3.SFN 1.13.26 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-stepfunctions
Type annotations for boto3.SFN 1.13.26 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.13.26.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70a061583c2ed1839d6274a0fc9a2b1db9c7216b7853fa8d84134506d1f9e56c |
|
MD5 | cadae752d0b1fefe988355fe760644d0 |
|
BLAKE2b-256 | 67c97e753c1c74f23a50edaff3bf50e80343f37ac64a24c3a6fc9f6c482718f5 |
Hashes for mypy_boto3_stepfunctions-1.13.26.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 286e83b9df31736f6c798953761e8fffa073a10947b40258f31bc1a32505ebb2 |
|
MD5 | 4b68385f9a0de6461df6ff3a2cb3362f |
|
BLAKE2b-256 | cf89d0c72494708617cb658cf162b1490dcd806b156af0fe99a1ae484f475ef6 |