Type annotations for boto3.SMS 1.14.21 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-sms
Type annotations for boto3.SMS 1.14.21 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 SMS
service.
python -m pip install boto3-stubs[sms]
How to use
Client annotations
SMSClient
provides annotations for boto3.client("sms")
.
import boto3
from mypy_boto3_sms import SMSClient
from mypy_boto3_sms.paginator import (
GetConnectorsPaginator,
GetReplicationJobsPaginator,
GetReplicationRunsPaginator,
GetServersPaginator,
ListAppsPaginator,
)
from mypy_boto3_sms.type_defs import AppSummaryTypeDef, ...
client: SMSClient = boto3.client("sms")
# 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: SMSClient = session.client("sms")
Paginators annotations
mypy_boto3_sms.paginator
module contains type annotations for all paginators.
client: SMSClient = boto3.client("sms")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_connectors_paginator: GetConnectorsPaginator = client.get_paginator("get_connectors")
get_replication_jobs_paginator: GetReplicationJobsPaginator = client.get_paginator("get_replication_jobs")
get_replication_runs_paginator: GetReplicationRunsPaginator = client.get_paginator("get_replication_runs")
get_servers_paginator: GetServersPaginator = client.get_paginator("get_servers")
list_apps_paginator: ListAppsPaginator = client.get_paginator("list_apps")
Typed dictionations
mypy_boto3_sms.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AppSummaryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_sms
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("sms")
session_client = boto3.Session().client("sms")
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_sms-1.14.21.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e2fb7a2ab004b2bd4cf8fc82a761974868f384e82994a8ab948c8d5dc135a57 |
|
MD5 | c479362e581bd214eb3af597a05cc6a2 |
|
BLAKE2b-256 | 24a86e43d46701e0d16edfc07bb35a7d34dd9aeabe0cb281672327b20f7bb151 |