Python库 | mypy-boto3-waf-1.20.35.post1.tar.gz

<a id="mypy-boto3-waf"></a> # mypy-boto3-waf [](https://pypi.org/project/mypy-boto3-waf) [](https://pypi.org/project/mypy-boto3-waf) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/mypy-boto3-waf)  Type annotations for [boto3.WAF 1.20.35](https://boto3.amazonaws.com/v1/documentation/api/1.20.35/reference/services/waf.html#WAF) 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-builder 6.3.2](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 docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_waf/) See how it helps to find and fix potential bugs:  - [mypy-boto3-waf](#mypy-boto3-waf) - [How to install](#how-to-install) - [VSCode extension](#vscode-extension) - [From PyPI with pip](#from-pypi-with-pip) - [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) - [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 <a id="vscode-extension"></a> ### VSCode extension Add [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) extension to your VSCode and run `AWS boto3: Quick Start` command. Click `Modify` and select `boto3 common` and `WAF`. <a id="from-pypi-with-pip"></a> ### From PyPI with pip Install `boto3-stubs` for `WAF` service. ```bash python -m pip install boto3-stubs[waf] ``` <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]` in your environment: `python -m pip install 'boto3-stubs[waf]'` Both type checking and auto-complete should work for `WAF` service. No explicit type annotations required, write your `boto3` code as usual. <a id="pycharm"></a> ### PyCharm - Install `boto-stubs[waf]` in your environment: `python -m pip install 'boto3-stubs[waf]'` Both type checking and auto-complete should work for `WAF` 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 supports `mypy` or `pyright`, everything should work. <a id="mypy"></a> ### mypy - Install `mypy`: `python -m pip install mypy` - Install `boto-stubs[waf]` in your environment: `python -m pip install 'boto3-stubs[waf]'` - Run `mypy` as usual Type checking should work for `WAF` 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]` in your environment: `python -m pip install 'boto3-stubs[waf]'` - Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should work for `WAF` 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 `WAFClient` provides annotations for `boto3.client("waf")`. ```python import boto3 from mypy_boto3_waf import WAFClient client: WAFClient = boto3.client("waf") # 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: WAFClient = session.client("waf") ``` <a id="paginators-annotations"></a> ### Paginators annotations `mypy_boto3_waf.paginator` module contains type annotations for all paginators. ```python from mypy_boto3_waf import WAFClient from mypy_boto3_waf.paginator import ( GetRateBasedRuleManagedKeysPaginator, ListActivatedRulesInRuleGroupPaginator, ListByteMatchSetsPaginator, ListGeoMatchSetsPaginator, ListIPSetsPaginator, ListLoggingConfigurationsPaginator, ListRateBasedRulesPaginator, ListRegexMatchSetsPaginator, ListRegexPatternSetsPaginator, ListRuleGroupsPaginator, ListRulesPaginator, ListSizeConstraintSetsPaginator, ListSqlInjectionMatchSetsPaginator, ListSubscribedRuleGroupsPaginator, ListWebACLsPaginator, ListXssMatchSetsPaginator, ) client: WAFClient = boto3.client("waf") # Explicit type annotations are optional here # Type should be correctly discovered by mypy and IDEs # VSCode requires explicit type annotations get_rate_based_rule_managed_keys_paginator: GetRateBasedRuleManagedKeysPaginator = client.get_paginator("get_rate_based_rule_managed_keys") list_activated_rules_in_rule_group_paginator: ListActivatedRulesInRuleGroupPaginator = client.get_paginator("list_activated_rules_in_rule_group") list_byte_match_sets_paginator: ListByteMatchSetsPaginator = client.get_paginator("list_byte_match_sets") list_geo_match_sets_paginator: ListGeoMatchSetsPaginator = client.get_paginator("list_geo_match_sets") list_ip_sets_paginator: ListIPSetsPaginator = client.get_paginator("list_ip_sets") list_logging_configurations_paginator: ListLoggingConfigurationsPaginator = client.get_paginator("list_logging_configurations") list_rate_based_rules_paginator: ListRateBasedRulesPaginator = client.get_paginator("list_rate_based_rules") list_regex_match_sets_paginator: ListRegexMatchSetsPaginator = client.get_paginator("list_regex_match_sets") list_regex_pattern_sets_paginator: ListRegexPatternSetsPaginator = client.get_paginator("list_regex_pattern_sets") list_rule_groups_paginator: ListRuleGroupsPaginator = client.get_paginator("list_rule_groups") list_rules_paginator: ListRulesPaginator = client.get_paginator("list_rules") list_size_constraint_sets_paginator: ListSizeConstraintSetsPaginator = client.get_paginator("list_size_constraint_sets") list_sql_injection_match_sets_paginator: ListSqlInjectionMatchSetsPaginator = client.get_paginator("list_sql_injection_match_sets") list_subscribed_rule_groups_paginator: ListSubscribedRuleGroupsPaginator = client.get_paginator("list_subscribed_rule_groups") list_web_acls_paginator: ListWebACLsPaginator = client.get_paginator("list_web_acls") list_xss_match_sets_paginator: ListXssMatchSetsPaginator = client.get_paginator("list_xss_match_sets") ``` <a id="literals"></a> ### Literals `mypy_boto3_waf.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_waf.literals import ( ChangeActionType, ChangeTokenStatusType, ComparisonOperatorType, GeoMatchConstraintTypeType, GeoMatchConstraintValueType, GetRateBasedRuleManage