Type annotations for boto3.CodeStarNotifications 1.14.5 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codestar-notifications
Type annotations for boto3.CodeStarNotifications 1.14.5 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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3aefe967d201f79e64d97b0a9786e69ca6447622d903b2d9d21bd9a95d46170b |
|
MD5 | e7c2207cdd53abd311d8618d27da517b |
|
BLAKE2b-256 | bca69fce1c3bfbb0c24c41e0338abd586a37521fd6cb06c25745e0e46db600b2 |
Hashes for mypy_boto3_codestar_notifications-1.14.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 573472d190582a0fdcca897b841371fd4627ca17373133cb305c4647709ebb74 |
|
MD5 | 184a27f90fb68055ce2e303cb611d2ec |
|
BLAKE2b-256 | 011233f6e2c7de8107c9ffd50bd95fc8677b42ed616d76f23652514222751b67 |