Type annotations for boto3.CloudFront 1.14.20 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudfront
Type annotations for boto3.CloudFront 1.14.20 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 CloudFront
service.
python -m pip install boto3-stubs[cloudfront]
How to use
Client annotations
CloudFrontClient
provides annotations for boto3.client("cloudfront")
.
import boto3
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.paginator import (
ListCloudFrontOriginAccessIdentitiesPaginator,
ListDistributionsPaginator,
ListInvalidationsPaginator,
ListStreamingDistributionsPaginator,
)
from mypy_boto3_cloudfront.type_defs import ActiveTrustedSignersTypeDef, ...
from mypy_boto3_cloudfront.waiter import (
DistributionDeployedWaiter,
InvalidationCompletedWaiter,
StreamingDistributionDeployedWaiter,
)
client: CloudFrontClient = boto3.client("cloudfront")
# 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: CloudFrontClient = session.client("cloudfront")
Paginators annotations
mypy_boto3_cloudfront.paginator
module contains type annotations for all paginators.
client: CloudFrontClient = boto3.client("cloudfront")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_cloud_front_origin_access_identities_paginator: ListCloudFrontOriginAccessIdentitiesPaginator = client.get_paginator("list_cloud_front_origin_access_identities")
list_distributions_paginator: ListDistributionsPaginator = client.get_paginator("list_distributions")
list_invalidations_paginator: ListInvalidationsPaginator = client.get_paginator("list_invalidations")
list_streaming_distributions_paginator: ListStreamingDistributionsPaginator = client.get_paginator("list_streaming_distributions")
Waiters annotations
mypy_boto3_cloudfront.waiter
module contains type annotations for all waiters.
client: CloudFrontClient = boto3.client("cloudfront")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
distribution_deployed_waiter: DistributionDeployedWaiter = client.get_waiter("distribution_deployed")
invalidation_completed_waiter: InvalidationCompletedWaiter = client.get_waiter("invalidation_completed")
streaming_distribution_deployed_waiter: StreamingDistributionDeployedWaiter = client.get_waiter("streaming_distribution_deployed")
Typed dictionations
mypy_boto3_cloudfront.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ActiveTrustedSignersTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudfront
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("cloudfront")
session_client = boto3.Session().client("cloudfront")
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-cloudfront-1.14.20.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5499f4ad172869f34020440091362a2932c5685983d1558e43c7bd0052ad776d |
|
MD5 | e977f2d6c0f571fdc5f86b621a226d0a |
|
BLAKE2b-256 | d76b70825a760ac9e691e113982ad7db2e9b85fba940023470597e9814b5bf69 |
Hashes for mypy_boto3_cloudfront-1.14.20.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5ff31c096f2a04ac8b366b20561f1e4b1fa375efd8a7cf8997e2f172b91b82c |
|
MD5 | 36f8968c1dc77f05fe3c1784e9805324 |
|
BLAKE2b-256 | 73042295fdda95a53275620a0631a2fe386ea912d26dfcf00e21427276f16b0f |