mypy-boto3-events 1.13.26.2

Type annotations for boto3.EventBridge 1.13.26 service, generated by mypy-boto3-buider 2.0.4

mypy-boto3-events

• mypy-boto3-events
  • How to use
  • Automated type discovery

Type annotations for boto3.EventBridge 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.4.

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]

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")

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 expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
• VSCode 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")