mypy-boto3-cloudfront 1.13.26.0

Type annotations for boto3.CloudFront 1.13.26 service, generated by mypy-boto3-buider 2.0.2

mypy-boto3-cloudfront

• mypy-boto3-cloudfront
  • How to use
  • Automated type discovery

Type annotations for boto3.CloudFront 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.2.

More information can be found on boto3-stubs page.

• mypy-boto3-cloudfront
  • How to use
    • Type checking
  • How it works

How to use

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for CloudFront service.

python -m pip install boto3-stubs[cloudfront]

# update installed packages index for automated type discovery
python -m mypy_boto3

Use boto3 with mypy_boto3_cloudfront in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3_cloudfront import CloudFrontClient

# Now mypy can check if your code is valid.
client: CloudFrontClient = boto3.client("cloudfront")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CloudFrontClient = session.client("cloudfront")



# Waiters are also supported

import mypy_boto3_cloudfront.waiter as cloudfront_waiters

distribution_deployed_waiter: cloudfront_waiters.DistributionDeployedWaiter = client.get_waiter("distribution_deployed")
invalidation_completed_waiter: cloudfront_waiters.InvalidationCompletedWaiter = client.get_waiter("invalidation_completed")
streaming_distribution_deployed_waiter: cloudfront_waiters.StreamingDistributionDeployedWaiter = client.get_waiter("streaming_distribution_deployed")


# Annotated paginators are included as well

import mypy_boto3_cloudfront.paginator as cloudfront_paginators

list_cloud_front_origin_access_identities_paginator: cloudfront_paginators.ListCloudFrontOriginAccessIdentitiesPaginator = client.get_paginator("list_cloud_front_origin_access_identities")
list_distributions_paginator: cloudfront_paginators.ListDistributionsPaginator = client.get_paginator("list_distributions")
list_invalidations_paginator: cloudfront_paginators.ListInvalidationsPaginator = client.get_paginator("list_invalidations")
list_streaming_distributions_paginator: cloudfront_paginators.ListStreamingDistributionsPaginator = client.get_paginator("list_streaming_distributions")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_cloudfront and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_cloudfront as cloudfront
from mypy_boto3_cloudfront import CloudFrontClient

# with these
from mypy_boto3 import cloudfront
from mypy_boto3.cloudfront import CloudFrontClient