Type annotations for boto3.Budgets 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-budgets
Type annotations for boto3.Budgets 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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
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.
from mypy_boto3_budgets import BudgetsClient
from mypy_boto3_budgets.paginator import (
DescribeBudgetsPaginator,
DescribeNotificationsForBudgetPaginator,
DescribeSubscribersForNotificationPaginator,
)
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.
from mypy_boto3_budgets.type_defs import BudgetPerformanceHistoryTypeDef, ...
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
import boto3
# 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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c28ba92dbf5028137d1501f88a8aeea0e9e2187ea1425d72435ad9401b2d936 |
|
MD5 | 104401713f3b60d0573239e1db983233 |
|
BLAKE2b-256 | 0006ba280ffd511ea70b8bca0908b062cf4ceb2a700584a56d4f7b234a7a5e6a |
Hashes for mypy_boto3_budgets-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a24400d693fd11efd7ca5c3aeeb2d3d1f36d024c799a9254356617afe3dc934 |
|
MD5 | f2aa5f30d35193e7616ed8e52d5e87d3 |
|
BLAKE2b-256 | b83342bb51e56ade1bbffd132eeaa2a6fe857ca3ac329e2244577aa8495c57f0 |