Type annotations for boto3.Synthetics 1.14.25 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-synthetics
Type annotations for boto3.Synthetics 1.14.25 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.25.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84386f6350d9584202323841256fbc00171f57c55ae028da31dec14a42bb582f |
|
MD5 | 169007e58f543f9c3e29f1bb33915bcd |
|
BLAKE2b-256 | 72be65a4f224e1e1bf8c919a3bfb2142fd6467ebfc4df920ded4b740dab82eea |
Hashes for mypy_boto3_synthetics-1.14.25.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aaa9f343f8a0e7fba4b89d1c616e3e43b4f91e7df9a00c2ee4e32da7052ee40 |
|
MD5 | 317d2e8b5d3a21cadffb617c67952869 |
|
BLAKE2b-256 | 85abc55ea673f367869d8c2bb246e40793eca2ce028a45039108dde18ccc1534 |