Type annotations for boto3.SSO 1.14.26 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-sso
Type annotations for boto3.SSO 1.14.26 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 SSO
service.
python -m pip install boto3-stubs[sso]
How to use
Client annotations
SSOClient
provides annotations for boto3.client("sso")
.
import boto3
from mypy_boto3_sso import SSOClient
from mypy_boto3_sso.paginator import ListAccountRolesPaginator, ListAccountsPaginator
from mypy_boto3_sso.type_defs import AccountInfoTypeDef, ...
client: SSOClient = boto3.client("sso")
# 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: SSOClient = session.client("sso")
Paginators annotations
mypy_boto3_sso.paginator
module contains type annotations for all paginators.
client: SSOClient = boto3.client("sso")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_account_roles_paginator: ListAccountRolesPaginator = client.get_paginator("list_account_roles")
list_accounts_paginator: ListAccountsPaginator = client.get_paginator("list_accounts")
Typed dictionations
mypy_boto3_sso.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccountInfoTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_sso
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("sso")
session_client = boto3.Session().client("sso")
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_sso-1.14.26.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dcd58890966608b0610a3727673af2348be6e90a65f0d9d14c302ea9a2da3ed |
|
MD5 | f85a7d93f4089a1ed4c3c30d3cf0c6ff |
|
BLAKE2b-256 | a15994b2928d854ed59e07c580479c2f1ef2b19e831dcc71ef23341cc84c1d01 |