# mypy-boto3-cloudfront
[![PyPI - mypy-boto3-cloudfront](https://img.shields.io/pypi/v/mypy-boto3-cloudfront.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudfront)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cloudfront.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudfront)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-cloudfront?color=blue)](https://pypistats.org/packages/mypy-boto3-cloudfront)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.CloudFront 1.17.65](https://boto3.amazonaws.com/v1/documentation/api/1.17.65/reference/services/cloudfront.html#CloudFront)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-buider 4.10.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-cloudfront docs](https://github.com/vemel/mypy_boto3_builder/service_docs/mypy_boto3_cloudfront/README.md)
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-cloudfront](#mypy-boto3-cloudfront)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
## How to install
Install `boto3-stubs` for `CloudFront` service.
```bash
python -m pip install boto3-stubs[cloudfront]
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[cloudfront]` in your environment:
`python -m pip install 'boto3-stubs[cloudfront]'`
Both type checking and auto-complete should work for `CloudFront` service. No
explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[cloudfront]` in your environment:
`python -m pip install 'boto3-stubs[cloudfront]'`
Both type checking and auto-complete should work for `CloudFront` service. No
explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
`boto3-stubs` submodules.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[cloudfront]` in your environment:
`python -m pip install 'boto3-stubs[cloudfront]'`
- Run `mypy` as usual
Type checking should work for `CloudFront` service. No explicit type
annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[cloudfront]` in your environment:
`python -m pip install 'boto3-stubs[cloudfront]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CloudFront` service. No explicit type
annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CloudFrontClient` provides annotations for `boto3.client("cloudfront")`.
```python
import boto3
from mypy_boto3_cloudfront import CloudFrontClient
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.
```python
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.paginator import (
ListCloudFrontOriginAccessIdentitiesPaginator,
ListDistributionsPaginator,
ListInvalidationsPaginator,
ListStreamingDistributionsPaginator,
)
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.
```python
from mypy_boto3_cloudfront import CloudFrontClient
from mypy_boto3_cloudfront.waiter import (
DistributionDeployedWaiter,
InvalidationCompletedWaiter,
StreamingDistributionDeployedWaiter,
)
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")
```
### Literals
`mypy_boto3_cloudfront.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_cloudfront.literals import (
CachePolicyCookieBehavior,
CachePolicyHeaderBehavior,
CachePolicyQueryStringBehavior,
CachePolicyType,
CertificateSource,
DistributionDeployedWaiterName,
EventType,
Format,
FunctionRuntime,
FunctionStage,
GeoRestrictionType,
HttpVersion,
ICPRecordalStatus,
InvalidationCompletedWaiterName,
ItemSelection,
ListCloudFrontOriginAccessIdentitiesPaginatorName,
ListDistributionsPaginatorName,
ListInvalidationsPaginatorName,
ListStreamingDistributionsPaginatorName,
Method,
MinimumProtocolVersion,
OriginProtocolPolicy,
OriginRequestPolicyCookieBehavior,
OriginRequestPolicyHeaderBehavior,
OriginRequestPolicyQueryStringBehavior,
OriginRequestPolicyType,
PriceClass,
RealtimeMetricsSubscriptionStatus,
SSLSupportMethod,
SslProtocol,
StreamingDistributionDeployedWaiterName,
ViewerProtocolPolicy,
)
def check_value(value: CachePolicyCookieBehavior) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_cloudfront.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_cloudfront.type_defs import (
ActiveTrustedKeyGroupsTypeDef,
ActiveTrustedSignersTypeDef,
AliasICPRecordalTypeDef,
AliasesTypeDef,
AllowedMethodsTypeDef,
CacheBehaviorTypeDef,
CacheBehaviorsTypeDef,
CachePolicyConfigTypeDef,
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共25个文件
py:9个
pyi:6个
txt:4个
资源分类:Python库 所属语言:Python 资源全名:mypy-boto3-cloudfront-1.17.65.0.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-cloudfront-1.17.65.0.tar.gz (25个子文件)
mypy-boto3-cloudfront-1.17.65.0
PKG-INFO 19KB
mypy_boto3_cloudfront.egg-info
PKG-INFO 19KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 794B
top_level.txt 22B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
README.md 14KB
mypy_boto3_cloudfront
type_defs.py 43KB
py.typed 0B
waiter.py 3KB
type_defs.pyi 42KB
literals.py 4KB
client.py 55KB
__main__.py 741B
waiter.pyi 3KB
__init__.py 2KB
client.pyi 55KB
paginator.pyi 5KB
paginator.py 5KB
version.py 57B
literals.pyi 4KB
__init__.pyi 2KB
共 25 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功