Type annotations for boto3.SFN 1.13.25 service, generated by mypy-boto3-buider 2.0.2
Project description
mypy-boto3-stepfunctions
Type annotations for boto3.SFN 1.13.25 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.2.
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]
# update installed packages index for automated type discovery
python -m mypy_boto3
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")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_stepfunctions
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
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 carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_stepfunctions as stepfunctions
from mypy_boto3_stepfunctions import SFNClient
# with these
from mypy_boto3 import stepfunctions
from mypy_boto3.stepfunctions import SFNClient
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.25.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1eae172da8ac2b5c806e10654cc8c2b4d05edac19178e08fa265b69876cf3732 |
|
MD5 | 22bd811daeb30c318722c6441d07a385 |
|
BLAKE2b-256 | 58936ac09dc671ec3366555cd8e8135d57c02a004743a799079eb78313163548 |
Hashes for mypy_boto3_stepfunctions-1.13.25.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05e277993341f597c1d2499578ccbc39e9ac9ebae4f006605ec98d7836da928d |
|
MD5 | 0b7c32ad41c9bc256b5b94856cb876a8 |
|
BLAKE2b-256 | f1f478e0323bdab3a35a7176b545d02cb74c734ea2cb820fd0d4eb70f476a76c |