Type annotations for boto3.WAFRegional 1.14.0 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-waf-regional
Type annotations for boto3.WAFRegional 1.14.0 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.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fdd83c6a773144dee9c3e3f501550010027e21de7a8cb902cea0ce30818f266 |
|
MD5 | ce5baf6d132dddbc538ad3703d2f9ae2 |
|
BLAKE2b-256 | 4347d7c944f7476ea3fe41f25d9909d672bdbe69d50e034931d36c5c0dafcef3 |
Hashes for mypy_boto3_waf_regional-1.14.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85de414e153bae63767eead4d45c86306e961f92a2e38e8ec1e55720534466ab |
|
MD5 | d8a9bb1194538f950319a9ee1e13543f |
|
BLAKE2b-256 | 02f0921816b047ed722e1352906c786af983481e7d7652bf78803c37c16a7da4 |