Type annotations for boto3.Synthetics 1.14.53 service, generated by mypy-boto3-buider 2.4.0
Project description
mypy-boto3-synthetics
Type annotations for boto3.Synthetics 1.14.53 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.4.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
from mypy_boto3_synthetics.type_defs import CanaryCodeOutputTypeDef, ...
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.
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
# 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.53.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30630ebb5fb06051028d88f36ed3d3671248629bd0f29b4ebf917e338a91f00f |
|
MD5 | 73f7116d9c5af23659a905d09c1756d8 |
|
BLAKE2b-256 | c7751687601eca7141ac020c86956258b2f9c7223638cfaee66749404ef3630d |
Hashes for mypy_boto3_synthetics-1.14.53.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c04d8be6f6b8590b5d3a5750d486def9903d1cc4fe443687fbb68bd6c7c6f98 |
|
MD5 | 2c07f91b543056e6826f8b9ac1c7e06b |
|
BLAKE2b-256 | ab812dbaf4bc9368158b5a6252cba99c43567dd17e5f17b62749e602bb87861a |