Type annotations for boto3.Budgets 1.14.52 service, generated by mypy-boto3-buider 2.4.0
Project description
mypy-boto3-budgets
Type annotations for boto3.Budgets 1.14.52 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.4.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 Budgets
service.
python -m pip install boto3-stubs[budgets]
How to use
Client annotations
BudgetsClient
provides annotations for boto3.client("budgets")
.
import boto3
from mypy_boto3_budgets import BudgetsClient
from mypy_boto3_budgets.paginator import (
DescribeBudgetsPaginator,
DescribeNotificationsForBudgetPaginator,
DescribeSubscribersForNotificationPaginator,
)
from mypy_boto3_budgets.type_defs import BudgetPerformanceHistoryTypeDef, ...
client: BudgetsClient = boto3.client("budgets")
# 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: BudgetsClient = session.client("budgets")
Paginators annotations
mypy_boto3_budgets.paginator
module contains type annotations for all paginators.
client: BudgetsClient = boto3.client("budgets")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_budgets_paginator: DescribeBudgetsPaginator = client.get_paginator("describe_budgets")
describe_notifications_for_budget_paginator: DescribeNotificationsForBudgetPaginator = client.get_paginator("describe_notifications_for_budget")
describe_subscribers_for_notification_paginator: DescribeSubscribersForNotificationPaginator = client.get_paginator("describe_subscribers_for_notification")
Typed dictionations
mypy_boto3_budgets.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BudgetPerformanceHistoryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_budgets
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("budgets")
session_client = boto3.Session().client("budgets")
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-budgets-1.14.52.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 760c6ebe8f76a138aada65be0dd8ef0ba0d33cf2c322fec1b1832d03c9836068 |
|
MD5 | 213b203745b8a895a4769c4c44f7595b |
|
BLAKE2b-256 | d6dac9ba0dffdb71edba955033976510148b8cbbbacc33537d8a3219b01fde54 |
Hashes for mypy_boto3_budgets-1.14.52.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b5b8766fd105f6671e35515be51e725dabdf536aeb41afbe17a1700abc0c138 |
|
MD5 | 23d02d2570351b636786154222f57a4e |
|
BLAKE2b-256 | 3217bca26ab101a56c37086cd9cb47ae11c61b240d931fe820bd0b3462578dc1 |