mypy-boto3-odb Type Stubs

Warnings

• breaking The `mypy-boto3-builder` (which generates these stubs) migrated to PEP 561 compliant packages and removed support for Python 3.8.
  Fix: Upgrade your Python environment to version 3.9 or newer. Ensure your project's `pyproject.toml` or `setup.cfg` correctly defines PEP 561 entry points if building custom stubs.
• breaking TypeDef names for packed method arguments were shortened (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes moved to the end.
  Fix: Update any custom `TypeDef` references in your codebase to reflect the new naming conventions provided by the stubs.
• deprecated The `sms-voice` service is no longer supported and has been excluded from builds. Use `pinpoint-sms-voice` instead.
  Fix: Migrate any existing usage from the `sms-voice` service to `pinpoint-sms-voice` in your `boto3` calls and corresponding type stub imports.
• gotcha These are type stubs only; the actual `boto3` library must be installed separately in your environment for runtime functionality.
  Fix: Ensure `pip install boto3` is executed in your project's environment alongside `mypy-boto3-odb`.
• gotcha In some IDEs (e.g., VSCode without Pylance, or older PyCharm versions), explicit type annotations for `boto3.client()` or `boto3.resource()` calls might be required to enable full autocomplete and type checking.
  Fix: Add explicit type hints for the client object, e.g., `client: OdbClient = boto3.client("odb")`.
• gotcha For Pylint compatibility and to avoid a runtime dependency on stubs in production, it is recommended to wrap stub imports within `typing.TYPE_CHECKING` blocks.
  Fix: Use `from typing import TYPE_CHECKING; if TYPE_CHECKING: from mypy_boto3_odb import OdbClient else: OdbClient = object` for conditional imports.

Install

• pip install mypy-boto3-odb Standalone service stubs
• pip install 'boto3-stubs[odb]' As part of boto3-stubs meta-package (recommended)

Imports

• OdbClient

  from mypy_boto3_odb import OdbClient

  While 'boto3-stubs' is the umbrella package, service-specific client types are directly imported from 'mypy_boto3_<service_name>' for explicit type hints.
• GetProfileOutputTypeDef

  from mypy_boto3_odb.type_defs import GetProfileOutputTypeDef

  For precise type checking of Boto3 response structures, TypedDict definitions are imported from the service's `type_defs` submodule.

Quickstart

This example demonstrates how to import and apply type hints for the `OdbClient` and its response types. It initializes a `boto3` client with the `OdbClient` type, allowing static analysis tools like Mypy and IDEs to provide auto-completion and type checking for Odb service calls. The `TYPE_CHECKING` block ensures that the `mypy_boto3_odb` import is only active during type checking, avoiding a runtime dependency on the stubs if desired. Replace `get_profile` with actual Odb service operations.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_odb import OdbClient
    from mypy_boto3_odb.type_defs import GetProfileOutputTypeDef

def get_odb_profile(profile_id: str) -> GetProfileOutputTypeDef:
    # Initialize an Odb client with type hints
    client: OdbClient = boto3.client("odb")

    # Example API call (replace with actual Odb service calls)
    # The actual Odb service is not widely known; this is illustrative.
    response: GetProfileOutputTypeDef = client.get_profile(ProfileId=profile_id)
    print(f"Retrieved Odb profile for {profile_id}: {response.get('Name')}")
    return response

# Example usage (requires AWS credentials configured for boto3)
if __name__ == "__main__":
    # In a real scenario, profile_id would come from input or configuration
    sample_profile_id = "some-odb-profile-id"
    try:
        # This call will fail at runtime if the 'odb' service or 'get_profile' API 
        # does not exist or if credentials are not configured correctly.
        # The purpose here is to demonstrate type hinting at static analysis time.
        # response_data = get_odb_profile(sample_profile_id)
        print("Type hinting for OdbClient and response types demonstrated.")
        print("To run, ensure 'boto3' is installed and AWS credentials are configured.")
        print("Note: 'odb' is a less common AWS service; adjust API calls as needed.")
    except Exception as e:
        print(f"An error occurred: {e}")