# mypy-boto3-events
[![PyPI - mypy-boto3-events](https://img.shields.io/pypi/v/mypy-boto3-events.svg?color=blue)](https://pypi.org/project/mypy-boto3-events)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-events.svg?color=blue)](https://pypi.org/project/mypy-boto3-events)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
Type annotations for
[boto3.EventBridge 1.14.47](https://boto3.amazonaws.com/v1/documentation/api/1.14.47/reference/services/events.html#EventBridge) service
compatible with [mypy](https://github.com/python/mypy), [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/) and other tools.
Generated by [mypy-boto3-buider 2.2.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
## How to install
Make sure you have [mypy](https://github.com/python/mypy) installed and activated in your IDE.
Install `boto3-stubs` for `EventBridge` service.
```bash
python -m pip install boto3-stubs[events]
```
## How to use
### Client annotations
`EventBridgeClient` provides annotations for `boto3.client("events")`.
```python
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.
```python
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.
```python
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.
```bash
# 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
```python
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("events")
session_client = boto3.Session().client("events")
```
PyPI 官网下载 | mypy-boto3-events-1.14.47.0.tar.gz
版权申诉
163 浏览量
2022-01-13
14:04:41
上传
评论
收藏 9KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+