Type annotations for boto3.WAFRegional 1.14.0 service, generated by mypy-boto3-buider 2.1.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.1.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
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.
from mypy_boto3_waf_regional.type_defs import ActivatedRuleTypeDef, ...
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
import boto3
# 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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18ef5274136f41e000a3447fd418cdcf1dba72e11cbb1a1c378a3a07175d608e |
|
MD5 | 7b7f13fcbe3103af3da7a2da03a81501 |
|
BLAKE2b-256 | 42f374ca60bc3891c655a02cea5a48e8434be8342649f5b60348a1988148ddba |
Hashes for mypy_boto3_waf_regional-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 820ef09991a3bdf651b206f5c422ff020a918607df2da641e8ac212a85799bd9 |
|
MD5 | a61f0596f1490d507f31e70377897296 |
|
BLAKE2b-256 | 010a6095471497912df4dd891bf78b16b782825ddf52b6ecdf2c7689b2225464 |