Type annotations for boto3.Budgets 1.14.1 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-budgets
Type annotations for boto3.Budgets 1.14.1 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 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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c589afe9086eaedeba82ded0621262b1b576023ba459695a711067eac28e3162 |
|
MD5 | f98e2dbbf3e01be535b5214746fc2b7c |
|
BLAKE2b-256 | 57c497e2dedbb95fff6d04cacca913909fcf3c70d65fe7dc271fe06aa41cc5b7 |
Hashes for mypy_boto3_budgets-1.14.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff9b5cc92c630bca67d2d3331c623a939f46a302cb93591cd9cacfbd18ee5591 |
|
MD5 | 609cc3de3e2085cdc671f0dc57459c6f |
|
BLAKE2b-256 | cfcca0ef5c8c804aa68fd41be4281251b2406dece961bfd2fcbb366cf9187170 |