Type annotations for boto3.CloudWatchLogs 1.14.16 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-logs
Type annotations for boto3.CloudWatchLogs 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 CloudWatchLogs
service.
python -m pip install boto3-stubs[logs]
How to use
Client annotations
CloudWatchLogsClient
provides annotations for boto3.client("logs")
.
import boto3
from mypy_boto3_logs import CloudWatchLogsClient
from mypy_boto3_logs.paginator import (
DescribeDestinationsPaginator,
DescribeExportTasksPaginator,
DescribeLogGroupsPaginator,
DescribeLogStreamsPaginator,
DescribeMetricFiltersPaginator,
DescribeQueriesPaginator,
DescribeResourcePoliciesPaginator,
DescribeSubscriptionFiltersPaginator,
FilterLogEventsPaginator,
)
from mypy_boto3_logs.type_defs import DestinationTypeDef, ...
client: CloudWatchLogsClient = boto3.client("logs")
# 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: CloudWatchLogsClient = session.client("logs")
Paginators annotations
mypy_boto3_logs.paginator
module contains type annotations for all paginators.
client: CloudWatchLogsClient = boto3.client("logs")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_destinations_paginator: DescribeDestinationsPaginator = client.get_paginator("describe_destinations")
describe_export_tasks_paginator: DescribeExportTasksPaginator = client.get_paginator("describe_export_tasks")
describe_log_groups_paginator: DescribeLogGroupsPaginator = client.get_paginator("describe_log_groups")
describe_log_streams_paginator: DescribeLogStreamsPaginator = client.get_paginator("describe_log_streams")
describe_metric_filters_paginator: DescribeMetricFiltersPaginator = client.get_paginator("describe_metric_filters")
describe_queries_paginator: DescribeQueriesPaginator = client.get_paginator("describe_queries")
describe_resource_policies_paginator: DescribeResourcePoliciesPaginator = client.get_paginator("describe_resource_policies")
describe_subscription_filters_paginator: DescribeSubscriptionFiltersPaginator = client.get_paginator("describe_subscription_filters")
filter_log_events_paginator: FilterLogEventsPaginator = client.get_paginator("filter_log_events")
Typed dictionations
mypy_boto3_logs.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> DestinationTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_logs
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("logs")
session_client = boto3.Session().client("logs")
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-logs-1.14.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d0ed5bbf8772e705ff4f4393e4bdf0164291d2c7fc22030aed6be245fc84c6f |
|
MD5 | 03ad43605a9d0ebcc35ac0f624feb036 |
|
BLAKE2b-256 | ca046f9a982483c52ed3a623d10e5fc10c0022f6f9ab33548abaac89b20d75ef |
Hashes for mypy_boto3_logs-1.14.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29cfc41a50492c42903295e9c904214ab3ded95b8665346c3a10996872203f1d |
|
MD5 | f2d907a15464535d78ca885043d01def |
|
BLAKE2b-256 | 8340b3b195f4334e6bd23d6f794327265a31206bbd0cd66292a32d3d611377c2 |