mypy-boto3-bcm-data-exports Type Annotations

Warnings

• breaking Python 3.8 support has been officially removed for all `mypy-boto3` packages. Projects targeting Python 3.8 must use older versions of `mypy-boto3` or `mypy-boto3-builder`.
  Fix: Upgrade your Python environment to 3.9 or higher. If not possible, pin `mypy-boto3-bcm-data-exports` to a version older than 8.12.0 (e.g., `mypy-boto3-bcm-data-exports<8.12.0`).
• breaking All `mypy-boto3` packages, including `mypy-boto3-bcm-data-exports`, have migrated to PEP 561 `py.typed` packages. This changes how type checkers discover stubs and might require updates to your `mypy` configuration or import paths if you were relying on older, non-PEP 561 compatible patterns.
  Fix: Ensure your type checker (e.g., MyPy) is up-to-date. In most cases, this change is transparent, but if issues arise, check your `mypy` configuration for `mypy_path` or similar settings that might conflict with `py.typed` discovery.
• breaking TypeDef naming conventions were changed, potentially affecting custom code that directly imports or references generated `TypedDict` names. For example, some 'RequestRequestTypeDef' names were shortened, and 'Extra' postfixes were moved.
  Fix: Review your code for direct imports of `mypy_boto3_bcm_data_exports.type_defs` and update `TypedDict` names to match the new conventions as indicated by your type checker.
• gotcha Explicit type annotations are highly recommended (and sometimes required, e.g., for `lite` versions) for `boto3.client()` and `boto3.resource()` calls to fully leverage `mypy-boto3` type checking and IDE autocomplete.
  Fix: Always explicitly annotate your `boto3` client and resource variables with the imported `Client` or `ServiceResource` types (e.g., `client: BCMDataExportsClient = boto3.client(...)`).
• gotcha `mypy-boto3-bcm-data-exports` provides *type annotations* only; it does not include `boto3` itself. `boto3` must be installed separately for your application to run.
  Fix: Ensure `pip install boto3` is part of your project's dependencies.
• gotcha The `mypy-boto3` packages are generated for specific `boto3` versions. To ensure correct type checking, it is crucial to keep your `mypy-boto3-bcm-data-exports` package version synchronized with your installed `boto3` runtime version.
  Fix: Regularly update both `boto3` and its corresponding `mypy-boto3-*` stub packages. Consider using `pip install 'boto3-stubs[bcm-data-exports]'` which often manages this synchronization.

Install

• pip install mypy-boto3-bcm-data-exports Install service-specific stubs
• pip install boto3-stubs[bcm-data-exports] Install via boto3-stubs extras

Imports

• BCMDataExportsClient

  from mypy_boto3_bcm_data_exports.client import BCMDataExportsClient

  Importing the specific client type for BCM Data Exports.
• BCMDataExportsServiceResource

  from mypy_boto3_bcm_data_exports.service_resource import BCMDataExportsServiceResource

  Importing the specific service resource type if applicable for this service.
• CreateExportRequestRequestTypeDef

  from mypy_boto3_bcm_data_exports.type_defs import CreateExportRequestRequestTypeDef

  Example of importing a generated TypedDict for request parameters.

Quickstart

This quickstart demonstrates how to initialize a `bcm-data-exports` client using `boto3` and explicitly annotate it with the `BCMDataExportsClient` type from `mypy-boto3-bcm-data-exports` for enhanced type checking and IDE support. It includes a basic example of calling `list_exports`.

import boto3
from mypy_boto3_bcm_data_exports.client import BCMDataExportsClient

def get_bcm_data_exports_client() -> BCMDataExportsClient:
    """Returns a type-hinted BCM Data Exports client."""
    client: BCMDataExportsClient = boto3.client(
        "bcm-data-exports",
        region_name="us-east-1",
        aws_access_key_id="{}".format(os.environ.get('AWS_ACCESS_KEY_ID', '')),
        aws_secret_access_key="{}".format(os.environ.get('AWS_SECRET_ACCESS_KEY', '')),
    )
    return client

# Example usage:
if __name__ == "__main__":
    import os
    client = get_bcm_data_exports_client()
    # You can now use 'client' with full type hints and autocomplete
    # For example, to list exports:
    try:
        response = client.list_exports()
        print("Successfully listed BCM Data Exports:")
        for export in response.get('Exports', []):
            print(f"  - {export.get('ExportArn')}")
    except Exception as e:
        print(f"Error listing exports: {e}")