mypy-boto3-marketplace-reporting Type Stubs

Warnings

• breaking Support for Python 3.8 was removed from `mypy-boto3-builder` (version 8.12.0 onwards), impacting all generated `mypy-boto3` stub packages. Projects requiring Python 3.8 should use an older version of `mypy-boto3` stubs or upgrade their Python version.
  Fix: Upgrade to Python 3.9+ or pin `mypy-boto3-marketplace-reporting` to an earlier version compatible with Python 3.8.
• breaking TypeDef naming conventions changed in `mypy-boto3-builder` (version 8.9.0), affecting all generated stub packages. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. Existing code explicitly importing these verbose TypeDef names might break.
  Fix: Update your import paths and TypeDef names to reflect the shorter, standardized conventions. Refer to the specific service's `type_defs` documentation.
• gotcha This package provides only type annotations (`.pyi` files) for `boto3`. It does not include the `boto3` runtime library itself. You must install `boto3` separately to use the AWS SDK functionality at runtime.
  Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
• gotcha When using `TYPE_CHECKING` for conditional imports (as in the quickstart), Pylint may report `undefined-variable` errors for the conditionally imported types. This is a known issue with Pylint's static analysis.
  Fix: As a workaround, set the conditionally imported types to `object` in the `else` branch of the `TYPE_CHECKING` block. Example: `if TYPE_CHECKING: from my_module import MyType else: MyType = object`.

Install

• pip install mypy-boto3-marketplace-reporting Install service-specific stubs

Imports

• MarketplaceReportingClient

  from mypy_boto3_marketplace_reporting.client import MarketplaceReportingClient

  Import the typed client for MarketplaceReportingService.
• ListEntitlementsOutputTypeDef

  from mypy_boto3_marketplace_reporting.type_defs import ListEntitlementsOutputTypeDef

  Import a specific TypeDef for clearer type annotations on method returns.

Quickstart

This quickstart demonstrates how to initialize a `MarketplaceReportingClient` with type annotations. It shows how to use `TYPE_CHECKING` for conditional stub imports, which is common practice to avoid runtime dependencies on stub packages. The example then performs a `list_entitlements` operation, with the response also type-hinted for improved static analysis.

from typing import TYPE_CHECKING
import boto3

if TYPE_CHECKING:
    from mypy_boto3_marketplace_reporting.client import MarketplaceReportingClient
    from mypy_boto3_marketplace_reporting.type_defs import ListEntitlementsOutputTypeDef

def get_marketplace_reporting_client() -> 'MarketplaceReportingClient':
    """Gets a typed Marketplace Reporting Service client."""
    # boto3 client creation without type hint (type checkers will infer via stubs)
    client = boto3.client('marketplace-reporting')
    return client # type: ignore

client: MarketplaceReportingClient = get_marketplace_reporting_client()

# Example usage: List entitlements with type-hinted response
# Replace 'YOUR_PRODUCT_CODE' with an actual AWS Marketplace Product Code
try:
    response: ListEntitlementsOutputTypeDef = client.list_entitlements(
        ProductCode='YOUR_PRODUCT_CODE',
        MaxResults=5
    )
    print("Successfully listed entitlements:")
    for entitlement in response.get('Entitlements', []):
        print(f"  Entitlement ID: {entitlement.get('EntitlementId')}")
    if response.get('NextToken'):
        print(f"  NextToken: {response['NextToken']}")
except client.exceptions.ClientError as e:
    print(f"Error listing entitlements: {e}")