Type annotations for boto3.EventBridge 1.13.26 service, generated by mypy-boto3-buider 2.0.2
Project description
mypy-boto3-events
Type annotations for boto3.EventBridge 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.2.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for EventBridge
service.
python -m pip install boto3-stubs[events]
# update installed packages index for automated type discovery
python -m mypy_boto3
Use boto3
with mypy_boto3_events
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_events import EventBridgeClient
# Now mypy can check if your code is valid.
client: EventBridgeClient = boto3.client("events")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: EventBridgeClient = session.client("events")
# Annotated paginators are included as well
import mypy_boto3_events.paginator as events_paginators
list_rule_names_by_target_paginator: events_paginators.ListRuleNamesByTargetPaginator = client.get_paginator("list_rule_names_by_target")
list_rules_paginator: events_paginators.ListRulesPaginator = client.get_paginator("list_rules")
list_targets_by_rule_paginator: events_paginators.ListTargetsByRulePaginator = client.get_paginator("list_targets_by_rule")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_events
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
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 carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_events as events
from mypy_boto3_events import EventBridgeClient
# with these
from mypy_boto3 import events
from mypy_boto3.events import EventBridgeClient
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.13.26.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f42b9e32c9273b9a40b58f22185bdd9fd97af5b405c2b5a0fb69fc003393275e |
|
MD5 | 5e8c8b98579817fdf8f8b3e37b0c9246 |
|
BLAKE2b-256 | 935dfb669aa45fabf8860a6954bfac49aaca8f50c1634ce11f9739ed1ddc7ca7 |
Hashes for mypy_boto3_events-1.13.26.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc9886634516e547e30f18d00d70e214b90dd18a87a0c2346ba5f13103591830 |
|
MD5 | 5a4eeccd1c5e99099b7aa3555d6088bd |
|
BLAKE2b-256 | 817c2b9ff0870bb44fd0d8d846b022e8eba035920b81c02cc2ebf22e5bfd5157 |