mypy-boto3-qbusiness Type Annotations

1.42.14 · active · verified Sat Apr 11

mypy-boto3-qbusiness provides type annotations for the `boto3` QBusiness service, generated by `mypy-boto3-builder`. It enhances code quality, readability, and error detection by enabling static type checking for `boto3` interactions with AWS QBusiness. The library is actively maintained with frequent updates to match `boto3` versions and `mypy-boto3-builder` releases, currently at version 1.42.14.

Warnings

breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0, which generates `mypy-boto3-qbusiness`. Projects relying on Python 3.8 will no longer receive updated type stubs.
Fix: Upgrade your Python environment to 3.9 or higher. The `requires_python` metadata is `>=3.9`.
breaking As of `mypy-boto3-builder` version 8.9.0, there were breaking changes to TypeDef naming conventions. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. If upgrading from significantly older versions, review TypeDef usages.
Fix: Update TypeDef import paths and names according to the latest generated stubs. Refer to the specific service's documentation or the `mypy-boto3-builder` release notes for details.
gotcha This package provides *type annotations* for `boto3`, not the `boto3` library itself. You must install `boto3` separately for your code to run.
Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
gotcha While `mypy-boto3` can offer auto-discovery for types, explicit type annotations for `boto3.client()` calls are often recommended, especially for VSCode users, to ensure optimal auto-completion and static checking.
Fix: Use explicit type hints, often guarded by `if TYPE_CHECKING:` to avoid runtime import issues, as shown in the quickstart.

Install

pip install mypy-boto3-qbusiness boto3 Install library and boto3
pip install mypy Install MyPy (for static checking)

Imports

QBusinessClient
```
from mypy_boto3_qbusiness.client import QBusinessClient
```
Imports the type for the QBusiness client.
ListApplicationsOutputTypeDef
```
from mypy_boto3_qbusiness.type_defs import ListApplicationsOutputTypeDef
```
Imports a specific TypedDict for a QBusiness API response structure. The exact TypeDef name will vary by API call.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-qbusiness` to type-hint a `boto3` QBusiness client. It shows the import of the `QBusinessClient` type and its application to the `boto3.client` call, enabling static analysis tools like MyPy and IDEs to provide accurate auto-completion and type checking. While some IDEs (like PyCharm) and MyPy can infer types, explicit annotation with `TYPE_CHECKING` is generally recommended for broader compatibility, especially with tools like VSCode.

import boto3
from mypy_boto3_qbusiness.client import QBusinessClient
from typing import TYPE_CHECKING

# In a real application, you would configure AWS credentials.
# For a runnable example, we'll assume default config or environment variables.
# client: QBusinessClient = boto3.client('qbusiness') # Implicit typing for PyCharm / mypy

if TYPE_CHECKING:
    client: QBusinessClient = boto3.client('qbusiness')
else:
    client = boto3.client('qbusiness')

# Example: Listing QBusiness applications
# The return type can also be explicitly hinted if needed
response = client.list_applications()

print(f"QBusiness Applications: {response.get('applications', [])}")

# To run mypy, save this as a .py file and run `mypy your_file.py`

view raw JSON →