Type annotations for boto3.Macie 1.14.20 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-macie
Type annotations for boto3.Macie 1.14.20 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 Macie
service.
python -m pip install boto3-stubs[macie]
How to use
Client annotations
MacieClient
provides annotations for boto3.client("macie")
.
import boto3
from mypy_boto3_macie import MacieClient
from mypy_boto3_macie.paginator import ListMemberAccountsPaginator, ListS3ResourcesPaginator
from mypy_boto3_macie.type_defs import ClassificationTypeTypeDef, ...
client: MacieClient = boto3.client("macie")
# 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: MacieClient = session.client("macie")
Paginators annotations
mypy_boto3_macie.paginator
module contains type annotations for all paginators.
client: MacieClient = boto3.client("macie")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_member_accounts_paginator: ListMemberAccountsPaginator = client.get_paginator("list_member_accounts")
list_s3_resources_paginator: ListS3ResourcesPaginator = client.get_paginator("list_s3_resources")
Typed dictionations
mypy_boto3_macie.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ClassificationTypeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_macie
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("macie")
session_client = boto3.Session().client("macie")
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-macie-1.14.20.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9df8a9d65981477452b9948afe19eda8368bc8f0b1cc626264bec53c7ef340a6 |
|
MD5 | 8a774e6c8da34b4ea087950165fc2d97 |
|
BLAKE2b-256 | 52f35f9efb969d7171e71aa4568d3ad9676148109ed5173da7d4338c4c7ca723 |
Hashes for mypy_boto3_macie-1.14.20.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e15520c3fefdad3d6ec5e7e9b69ef7cfbd1a93faf2cf6e468d911864b1b0b1ea |
|
MD5 | e8dc03fde2fc731e8bf6e8daa9d3ec39 |
|
BLAKE2b-256 | f42f5fb770825dec3729860e45fd55ff0239253e071989e4f4fe34a5246c50ee |