Type annotations for boto3.WAFRegional 1.14.2 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-waf-regional
Type annotations for boto3.WAFRegional 1.14.2 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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a472541e612d5e2194ab34f802b9d9bbc86552eed6f180df43e68fc94f0e451 |
|
MD5 | 009cec788e6be6775df41caaf96c74be |
|
BLAKE2b-256 | 136582baee9f8543994aae3214a5501dbeecde317e2b59c8c026ccb33640604a |
Hashes for mypy_boto3_waf_regional-1.14.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71131b789e09b8189ad39ab3cd986f4f792db1344181cd1e9534abcc6e197d14 |
|
MD5 | 71ad5e93e26edee764f32d57f6fb1641 |
|
BLAKE2b-256 | 0dfa65c507f15b692d40ec91837373e2f70970f45d88207a65a45646b63b6ba6 |