Type annotations for boto3.Synthetics 1.14.14 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-synthetics
Type annotations for boto3.Synthetics 1.14.14 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 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.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad71ce889680c5304d68904e0e44638577b60ee1e12251d97f6fdad5dba0f08c |
|
MD5 | 09cc50581297d5978c5db022473fe70f |
|
BLAKE2b-256 | 6f19142a47d9fc02a113b9b2d9a4e57a3a5ece71e5e783b0a53aa82c731f1b9a |
Hashes for mypy_boto3_synthetics-1.14.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 164638cb728e2d770cd195812953c9d8f6308c2dd124a0d8a2113d9095dcfbbc |
|
MD5 | f8ced80fa483619966294d90158f30a6 |
|
BLAKE2b-256 | ad8ac1ff1847b056074fb18b443a05c7b1e38023299cbf6961556bfcc6ba33d0 |