Type annotations for boto3.WAFRegional 1.14.17 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-waf-regional
Type annotations for boto3.WAFRegional 1.14.17 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 WAFRegional
service.
python -m pip install boto3-stubs[waf-regional]
How to use
Client annotations
WAFRegionalClient
provides annotations for boto3.client("waf-regional")
.
import boto3
from mypy_boto3_waf_regional import WAFRegionalClient
from mypy_boto3_waf_regional.type_defs import ActivatedRuleTypeDef, ...
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")
Typed dictionations
mypy_boto3_waf_regional.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ActivatedRuleTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_waf_regional
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("waf-regional")
session_client = boto3.Session().client("waf-regional")
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-waf-regional-1.14.17.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5285bb912a5904c1244449213d9c04c66be083ca42de52ced7d615c9b0aa1dd |
|
MD5 | d9ea6a3ccbf24a213ccb0972e4014b8d |
|
BLAKE2b-256 | 6adf1e51f44e379ff96c92e4c6081537bef22f4954b524d87bb5142b30aa85cf |
Hashes for mypy_boto3_waf_regional-1.14.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31dbdde8ff9abba2b381af45aa17af451d39a4073fa9fb92ca2bec804121b619 |
|
MD5 | 452d9271220b15e27cc3b5fde41fa49d |
|
BLAKE2b-256 | 43fe3830cf9caabb53619aabb6fbbf1f92612525f0aa46dfd9aa12733ebb798b |