Type annotations for boto3.EventBridge 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-events
Type annotations for boto3.EventBridge 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 EventBridge
service.
python -m pip install boto3-stubs[events]
How to use
Client annotations
EventBridgeClient
provides annotations for boto3.client("events")
.
import boto3
from mypy_boto3_events import EventBridgeClient
client: EventBridgeClient = boto3.client("events")
# 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: EventBridgeClient = session.client("events")
Paginators annotations
mypy_boto3_events.paginator
module contains type annotations for all paginators.
from mypy_boto3_events import EventBridgeClient
from mypy_boto3_events.paginator import (
ListRuleNamesByTargetPaginator,
ListRulesPaginator,
ListTargetsByRulePaginator,
)
client: EventBridgeClient = boto3.client("events")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_rule_names_by_target_paginator: ListRuleNamesByTargetPaginator = client.get_paginator("list_rule_names_by_target")
list_rules_paginator: ListRulesPaginator = client.get_paginator("list_rules")
list_targets_by_rule_paginator: ListTargetsByRulePaginator = client.get_paginator("list_targets_by_rule")
Typed dictionations
mypy_boto3_events.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_events.type_defs import AwsVpcConfigurationTypeDef, ...
def get_structure() -> AwsVpcConfigurationTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_events
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("events")
session_client = boto3.Session().client("events")
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-events-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f32393a241ba6b45e44f1753d0415a7f3a1c13fca3aa1428f710a67163c25bf |
|
MD5 | 5a17e9533c772b31f59e8e0ecda41b98 |
|
BLAKE2b-256 | 0f0e2f92409eea3eea3bbd67d9ce3c3f54205d6da143927816dfa3a388eb2d2d |
Hashes for mypy_boto3_events-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7baf6de23e036f4055f56e73a31d3e94a16ea2f5a1a62946073fcc4bd13c0b5 |
|
MD5 | c00b940960201aa9e3f0cbf99bb8413c |
|
BLAKE2b-256 | bab9e3d54c9b6d63c635e5d1b6574b7bf1fd26a70e7401e076e6d5b3d3d7fb59 |