Type annotations for boto3.EventBridge 1.14.29 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-events
Type annotations for boto3.EventBridge 1.14.29 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 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
from mypy_boto3_events.paginator import (
ListRuleNamesByTargetPaginator,
ListRulesPaginator,
ListTargetsByRulePaginator,
)
from mypy_boto3_events.type_defs import AwsVpcConfigurationTypeDef, ...
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.
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.
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
# 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.29.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 546a3dbd0c81a47e1e8ae311c0fe0a1451b7ecab7041ebb69369c36fc9362239 |
|
MD5 | f96a6317bc7612cbeca03f19edd9b94a |
|
BLAKE2b-256 | 6e7ece860093a2ef87eddc86cf1784612b71b24cb3704cd2ddc6e823ecd66423 |
Hashes for mypy_boto3_events-1.14.29.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bffedb4564bc5a3db28ba344cd34ba8e365383d09aafd337215f03cddd5036c |
|
MD5 | 14b95f5ad6dbbd899f8a889e520d082c |
|
BLAKE2b-256 | 8ad0cf4b8424349cc2f980e4484d7b3dd8103317c92f4e04315c5acb1b2897bd |