Type annotations for boto3.SFN 1.14.12 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-stepfunctions
Type annotations for boto3.SFN 1.14.12 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 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
# 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.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 052fc7ba0172f3c7c9f1f7c9740f376ced07103e2afbc8fd51b897e0d4d127da |
|
MD5 | 8ff00ec8c6634345653e586497074410 |
|
BLAKE2b-256 | 15013bca106b31eb0eb3125db16249808c29cd6bd261e849082807eee9efe6d2 |
Hashes for mypy_boto3_stepfunctions-1.14.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cd9725ce5428624814bf30bff96f7ea03759c84f4540d45873994502d2e8adb |
|
MD5 | f8d9eb4e0d6a4586855c621b95409c5d |
|
BLAKE2b-256 | ab31df9e65c4fb9409e4f03509182b251b5174cf3d5e5df38b5fce39b8e3d86f |