Type annotations for boto3.Synthetics 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-synthetics
Type annotations for boto3.Synthetics 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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 Synthetics
service.
python -m pip install boto3-stubs[synthetics]
How to use
Client annotations
SyntheticsClient
provides annotations for boto3.client("synthetics")
.
import boto3
from mypy_boto3_synthetics import SyntheticsClient
client: SyntheticsClient = boto3.client("synthetics")
# 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: SyntheticsClient = session.client("synthetics")
Typed dictionations
mypy_boto3_synthetics.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_synthetics.type_defs import CanaryCodeOutputTypeDef, ...
def get_structure() -> CanaryCodeOutputTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_synthetics
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
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("synthetics")
session_client = boto3.Session().client("synthetics")
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-synthetics-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e3fbbbcd3829be2380944dd4a970b4b4c1ff8461c2928b312df1a7a3d483c41 |
|
MD5 | fe3819c8ab8b50e919ba6f0f808dc258 |
|
BLAKE2b-256 | 1a96e680bfc3e5e20e3984378199e388358005c346254c19b7e4f74f8d0a03af |
Hashes for mypy_boto3_synthetics-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06cee2898ed957be1e43ddc0bc1297727e9c102a5a2a68a5c3222a6543d10f50 |
|
MD5 | 6bfcba0a9dd39ea462eeeb215a1c0247 |
|
BLAKE2b-256 | ae3f5ff9f46a10a9c91d0a571186f7fb1873cc1adf785001c1a2235a5e21a3bf |