mypy-boto3-budgets Type Stubs

1.42.33 · active · verified Sat Apr 11

Type annotations for `boto3` AWS Budgets service, generated by `mypy-boto3-builder`. It provides type checking support for `boto3` clients, paginators, literals, and type definitions, compatible with various IDEs and type checkers like `mypy` and `pyright`. The library's version directly corresponds to the `boto3` version it types.

Warnings

breaking Starting with mypy-boto3-builder version 8.12.0 (which generates mypy-boto3-budgets), support for Python 3.8 has been removed across all generated packages. Ensure your Python environment is 3.9 or newer.
Fix: Upgrade Python to 3.9 or higher.
breaking mypy-boto3-builder version 8.9.0 introduced breaking changes to generated TypeDef naming conventions. Packed method arguments now use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes are moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` -> `CreateDistributionRequestExtraTypeDef`). This may affect explicit `TypeDef` imports.
Fix: Review and update explicit `TypeDef` imports and usage to reflect the new naming conventions.
gotcha This package provides only type annotations. You must still install the actual `boto3` library for your code to run. `mypy-boto3-budgets` provides no runtime functionality on its own.
Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
gotcha mypy-boto3-builder migrated to PEP 561 compliant packages with release 8.12.0. While this improves standard compatibility, ensure your `mypy` version is up-to-date to correctly discover and use these stub packages.
Fix: Update `mypy` to the latest version: `pip install --upgrade mypy`.
gotcha PyCharm users might experience slow performance with Literal overloads in these stubs (due to PyCharm issue PY-40997). It is recommended to use `boto3-stubs-lite` (if available for the service), or disable PyCharm's type checker and rely on external tools like `mypy` or `pyright`.
Fix: Consider `boto3-stubs-lite`, or configure PyCharm to use `mypy` or `pyright` for type checking, disabling its built-in type checker.

Install

pip install boto3 mypy-boto3-budgets mypy Install with boto3 and Mypy

Imports

BudgetsClient
```
from mypy_boto3_budgets import BudgetsClient
```
This is the primary way to get the type-hinted client for the Budgets service.
BudgetsServiceName
```
from mypy_boto3_budgets.literals import BudgetsServiceName
```
Literal types for service names are useful for precise type checking of client creation.
BudgetTypeDef
```
from mypy_boto3_budgets.type_defs import BudgetTypeDef
```
Type definitions for service response objects and request parameters.

Quickstart

This quickstart demonstrates how to import and use the `BudgetsClient` type annotation with a `boto3` client. It shows how to correctly type-hint a client and then use it with a common operation like `describe_budgets`, benefiting from autocompletion and static type checking. Replace '123456789012' with a valid AWS account ID or use `os.environ.get` for programmatic access.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_budgets import BudgetsClient
    from mypy_boto3_budgets.type_defs import DescribeBudgetsOutputTypeDef

# Initialize a boto3 session and client
session = boto3.session.Session()
client: BudgetsClient = session.client("budgets")

# Example usage with type-hinted client
try:
    response: DescribeBudgetsOutputTypeDef = client.describe_budgets(AccountId="123456789012")
    print("Budgets found:")
    for budget in response.get('Budgets', []):
        print(f"  - {budget.get('BudgetName')}: {budget.get('BudgetType')}")
except client.exceptions.NotFoundException:
    print("No budgets found for account.")
except Exception as e:
    print(f"An error occurred: {e}")

view raw JSON →