<a id="mypy-boto3-waf-regional"></a>
# mypy-boto3-waf-regional
[![PyPI - mypy-boto3-waf-regional](https://img.shields.io/pypi/v/mypy-boto3-waf-regional.svg?color=blue)](https://pypi.org/project/mypy-boto3-waf-regional)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-waf-regional.svg?color=blue)](https://pypi.org/project/mypy-boto3-waf-regional)
[![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-waf-regional?color=blue)](https://pypistats.org/packages/mypy-boto3-waf-regional)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.WAFRegional 1.17.100](https://boto3.amazonaws.com/v1/documentation/api/1.17.100/reference/services/waf-regional.html#WAFRegional)
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.18.4](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-waf-regional docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_waf_regional/)
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-waf-regional](#mypy-boto3-waf-regional)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
Install `boto3-stubs` for `WAFRegional` service.
```bash
python -m pip install boto3-stubs[waf-regional]
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### 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[waf-regional]` in your environment:
`python -m pip install 'boto3-stubs[waf-regional]'`
Both type checking and auto-complete should work for `WAFRegional` service. No
explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[waf-regional]` in your environment:
`python -m pip install 'boto3-stubs[waf-regional]'`
Both type checking and auto-complete should work for `WAFRegional` 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.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[waf-regional]` in your environment:
`python -m pip install 'boto3-stubs[waf-regional]'`
- Run `mypy` as usual
Type checking should work for `WAFRegional` service. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[waf-regional]` in your environment:
`python -m pip install 'boto3-stubs[waf-regional]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `WAFRegional` service. No explicit type
annotations required, write your `boto3` code as usual.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`WAFRegionalClient` provides annotations for `boto3.client("waf-regional")`.
```python
import boto3
from mypy_boto3_waf_regional import WAFRegionalClient
client: WAFRegionalClient = boto3.client("waf-regional")
# 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: WAFRegionalClient = session.client("waf-regional")
```
<a id="literals"></a>
### Literals
`mypy_boto3_waf_regional.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_waf_regional.literals import (
ChangeActionType,
ChangeTokenStatusType,
ComparisonOperatorType,
GeoMatchConstraintTypeType,
GeoMatchConstraintValueType,
IPSetDescriptorTypeType,
MatchFieldTypeType,
PositionalConstraintType,
PredicateTypeType,
RateKeyType,
ResourceTypeType,
TextTransformationType,
WafActionTypeType,
WafOverrideActionTypeType,
WafRuleTypeType,
)
def check_value(value: ChangeActionType) -> bool:
...
```
<a id="typed-dictionaries"></a>
### Typed dictionaries
`mypy_boto3_waf_regional.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_waf_regional.type_defs import (
ActivatedRuleTypeDef,
ByteMatchSetSummaryTypeDef,
ByteMatchSetTypeDef,
ByteMatchSetUpdateTypeDef,
ByteMatchTupleTypeDef,
CreateByteMatchSetResponseTypeDef,
CreateGeoMatchSetResponseTypeDef,
CreateIPSetResponseTypeDef,
CreateRateBasedRuleResponseTypeDef,
CreateRegexMatchSetResponseTypeDef,
CreateRegexPatternSetResponseTypeDef,
CreateRuleGroupResponseTypeDef,
CreateRuleResponseTypeDef,
CreateSizeConstraintSetResponseTypeDef,
CreateSqlInjectionMatchSetResponseTypeDef,
CreateWebACLMigrationStackResponseTypeDef,
CreateWebACLResponseTypeDef,
CreateXssMatchSetResponseTypeDef,
DeleteByteMatchSetResponseTypeDef,
DeleteGeoMatchSetResponseTypeDef,
DeleteIPSetResponseTypeDef,
DeleteRateBasedRuleResponseTypeDef,
DeleteRegexMatchSetResponseTypeDef,
DeleteRegexPatternSetResponseTypeDef,
DeleteRuleGroupResponseTypeDef,
DeleteRuleResponseTypeDef,
DeleteSizeConstraintSetResponseTypeDef,
DeleteSqlInjectionMatchSetResponseTypeDef,
DeleteWebACLResponseTypeDef,
DeleteXssMatchSetResponseTypeDef,
ExcludedRuleTypeDef,
FieldToMatchTypeDef,
GeoMatchConstraintTypeDef,
GeoMatchSetSummaryTypeDef,
GeoMatchSetTypeDef,
GeoMatchSetUpdateTypeDef,
GetByteMatchSetResponseTypeDef,
GetChangeTokenResponseTypeDef,
GetChangeTokenStatusResponseTypeDef,
GetGeoMatchSetResponseTypeDef,
GetIPSetResponseTypeDef,
GetLoggingConfigurationResponseTypeDef,
GetPermissionPolicyResponseTypeDef,
GetRateBasedRuleManagedKeysResponseTypeDef,
GetRateBasedRuleResponseTypeDef,
GetRegexMatchSetResponseTypeDef,
GetRegexPatternSetResponseTypeDef,
GetRuleGroupResponseTypeDef,
GetRuleResponseTypeDef,
GetSampledRequestsResponseTypeDef,
GetSizeConstraintSetResponseTypeDef,
GetSqlInjectionMatchSetResponseTypeDef,
GetWebACLForResourceResponseTypeDef,
GetWebACLResponseTypeDef,
GetXssMatchSetResponseTypeDef,
HTTPHeaderTypeDef,
HTTPRequestTypeDef,
IPSetDescriptorTypeDef,
IPSetSummaryTypeDef,
IPSetTypeDef,
IPSetUpdateTypeDef,
ListActivatedRulesInRuleGroupResponseTypeDef,
ListByteMatchSetsResponseTypeDef,
ListGeoMatchSetsResponseTypeDef,
ListIPSetsResponseTypeDef,
ListLoggingConfigurationsResponseTypeDe
PyPI 官网下载 | mypy-boto3-waf-regional-1.17.100.tar.gz
版权申诉
32 浏览量
2022-01-14
05:07:21
上传
评论
收藏 23KB GZ 举报
挣扎的蓝藻
- 粉丝: 12w+
- 资源: 15万+
最新资源
- 散斑结构光测试图像-对应博客:https://mp.csdn.net/mp-blog/creation/editor/13817
- 20220823-1000-ts.dat
- Galaxy10CNN实现星系图像分类项目深度学习环境配置
- DVB-S2:GCS组帧数据.dat
- 基于强化学习Q-Learning方法实现机器人走迷宫源码.zip
- numpy+pandas_basics.ipynb
- 网络安全-Diffie Hellman密钥协商
- 双H桥电机驱动L298N芯片AD集成库ALTIUM库(原理图库+PCB封装库)文件.zip
- 计算机组成原理实验;16位运算器ALU CPU设计
- 毕设绝技 - 4天玩乐完成商城系统完整资料day04
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈