Type annotations for boto3.CloudTrail 1.14.16 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloudtrail
Type annotations for boto3.CloudTrail 1.14.16 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 CloudTrail
service.
python -m pip install boto3-stubs[cloudtrail]
How to use
Client annotations
CloudTrailClient
provides annotations for boto3.client("cloudtrail")
.
import boto3
from mypy_boto3_cloudtrail import CloudTrailClient
from mypy_boto3_cloudtrail.paginator import (
ListPublicKeysPaginator,
ListTagsPaginator,
ListTrailsPaginator,
LookupEventsPaginator,
)
from mypy_boto3_cloudtrail.type_defs import DataResourceTypeDef, ...
client: CloudTrailClient = boto3.client("cloudtrail")
# 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: CloudTrailClient = session.client("cloudtrail")
Paginators annotations
mypy_boto3_cloudtrail.paginator
module contains type annotations for all paginators.
client: CloudTrailClient = boto3.client("cloudtrail")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_public_keys_paginator: ListPublicKeysPaginator = client.get_paginator("list_public_keys")
list_tags_paginator: ListTagsPaginator = client.get_paginator("list_tags")
list_trails_paginator: ListTrailsPaginator = client.get_paginator("list_trails")
lookup_events_paginator: LookupEventsPaginator = client.get_paginator("lookup_events")
Typed dictionations
mypy_boto3_cloudtrail.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> DataResourceTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloudtrail
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("cloudtrail")
session_client = boto3.Session().client("cloudtrail")
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-cloudtrail-1.14.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61c13d84f36c08d14d13d1688bbd00e8490d8dc8fa9c482b863e85c6d002c0b5 |
|
MD5 | aef7fa3371bb3cd1eb19955343d18204 |
|
BLAKE2b-256 | 55e436edd857d8d4eeff926792f6c144e45fbbf48dfc57aaa0fd6ab3324e414b |
Hashes for mypy_boto3_cloudtrail-1.14.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d28592a6ccea6f05248160deddbbd3eb7f3126c87053d8777d5c03f3c34cf9c7 |
|
MD5 | 78e3563b13354b7342a687cbb366c670 |
|
BLAKE2b-256 | 2a0f21870c02f8e451a8ac10408b5aed6135d6a29b8715a1e221884c66afb662 |