Type annotations for boto3.STS 1.14.51 service, generated by mypy-boto3-buider 2.3.1
Project description
mypy-boto3-sts
Type annotations for boto3.STS 1.14.51 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.3.1.
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 STS
service.
python -m pip install boto3-stubs[sts]
How to use
Client annotations
STSClient
provides annotations for boto3.client("sts")
.
import boto3
from mypy_boto3_sts import STSClient
from mypy_boto3_sts.type_defs import AssumedRoleUserTypeDef, ...
client: STSClient = boto3.client("sts")
# 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: STSClient = session.client("sts")
Typed dictionations
mypy_boto3_sts.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AssumedRoleUserTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_sts
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("sts")
session_client = boto3.Session().client("sts")
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_sts-1.14.51.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cedc934e15c042b505ec5b3bbadd3d76345a1e793bbd1e05ef8c17c35fa6f9da |
|
MD5 | 79bd6135db5810f115a717fefeade88a |
|
BLAKE2b-256 | 7e457a02db50186f1c18fa665aa3a2fa0e626832f8c80db2f8df4146487e74b6 |