Type annotations for boto3.CodeStarNotifications 1.14.23 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codestar-notifications
Type annotations for boto3.CodeStarNotifications 1.14.23 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 CodeStarNotifications
service.
python -m pip install boto3-stubs[codestar-notifications]
How to use
Client annotations
CodeStarNotificationsClient
provides annotations for boto3.client("codestar-notifications")
.
import boto3
from mypy_boto3_codestar_notifications import CodeStarNotificationsClient
from mypy_boto3_codestar_notifications.paginator import (
ListEventTypesPaginator,
ListNotificationRulesPaginator,
ListTargetsPaginator,
)
from mypy_boto3_codestar_notifications.type_defs import EventTypeSummaryTypeDef, ...
client: CodeStarNotificationsClient = boto3.client("codestar-notifications")
# 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: CodeStarNotificationsClient = session.client("codestar-notifications")
Paginators annotations
mypy_boto3_codestar_notifications.paginator
module contains type annotations for all paginators.
client: CodeStarNotificationsClient = boto3.client("codestar-notifications")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_event_types_paginator: ListEventTypesPaginator = client.get_paginator("list_event_types")
list_notification_rules_paginator: ListNotificationRulesPaginator = client.get_paginator("list_notification_rules")
list_targets_paginator: ListTargetsPaginator = client.get_paginator("list_targets")
Typed dictionations
mypy_boto3_codestar_notifications.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> EventTypeSummaryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_codestar_notifications
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("codestar-notifications")
session_client = boto3.Session().client("codestar-notifications")
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-codestar-notifications-1.14.23.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6b525e53eb8633c7785949fb628ae29ef8cff35b8f1b79c64d26110190557a9 |
|
MD5 | 2a2e6d845cd48e44fef327200840c2e0 |
|
BLAKE2b-256 | 1f56282f2056e8dd0428d6c0e44e497caa0576d96ea7f0da50ce0682ccfbc75a |
Hashes for mypy_boto3_codestar_notifications-1.14.23.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f8d7e501cf7a65facd8afe89f5e921348241e1ce0dcef20db77a2abdf1148d3 |
|
MD5 | 0e4fb7bccb7fa546fb1e862fa026479e |
|
BLAKE2b-256 | 130d24f2c9a32f3fe9cba4eb157de8bef35ce379d3d3f68e12e104222d2cffad |