mypy-boto3-partnercentral-benefits

Warnings

• breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0 and later, affecting all generated `mypy-boto3` stub packages. This package (1.42.3) requires Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or higher.
• breaking Migration to PEP 561-compliant packages occurred in `mypy-boto3-builder` 8.12.0. While this generally improves type checker discovery, users with highly customized build systems or older `mypy` versions might need to verify compatibility.
  Fix: Ensure `mypy` is up-to-date and your build system correctly recognizes PEP 561-compliant `py.typed` packages.
• breaking TypeDef naming conventions were changed in `mypy-boto3-builder` 8.9.0. This includes shorter names for packed method arguments (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`) and moving 'Extra' postfixes (`CreateDistributionExtraRequestTypeDef` -> `CreateDistributionRequestExtraTypeDef`). Code explicitly importing or referencing these TypeDefs will break.
  Fix: Update explicit `TypeDef` imports and references in your code to match the new naming conventions. Refer to the specific service's documentation for exact TypeDef names.
• gotcha This package provides only type annotations. `boto3` (the actual AWS SDK for Python) must be installed separately for your code to function at runtime. Ensure `boto3` is installed and its version is compatible with the stubs.
  Fix: Always install `boto3` alongside `mypy-boto3-partnercentral-benefits` (e.g., `pip install boto3 mypy-boto3-partnercentral-benefits`).
• gotcha PyCharm users might experience slow performance or high CPU usage due to `Literal` overloads (PyCharm issue PY-40997). The `mypy-boto3` project recommends using `boto3-stubs-lite` packages or disabling PyCharm's type checker and relying on `mypy` or `pyright` instead.
  Fix: Consider installing `boto3-stubs-lite[partnercentral-benefits]` if using PyCharm, or configure PyCharm to use an external type checker like `mypy` or `pyright`.

Install

• pip install mypy-boto3-partnercentral-benefits boto3 Install with boto3

Imports

• PartnerCentralBenefitsClient

  from mypy_boto3_partnercentral_benefits.client import PartnerCentralBenefitsClient

• ListPartnerBenefitsResponseTypeDef

  from mypy_boto3_partnercentral_benefits.type_defs import ListPartnerBenefitsResponseTypeDef

  Example for a common TypeDef import. Specific TypeDefs vary by service operation.
• PartnerCentralBenefitsServiceName

  from mypy_boto3_partnercentral_benefits.literals import PartnerCentralBenefitsServiceName

  For literal type hints, useful in overloads.

Quickstart

This example demonstrates how to initialize a `PartnerCentralBenefitsClient` with explicit type annotation, enabling static type checking and IDE autocompletion for its methods and arguments. It then calls `list_partner_benefits` to retrieve and print a summary of benefits. Ensure `boto3` is installed alongside `mypy-boto3-partnercentral-benefits`.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_partnercentral_benefits.client import PartnerCentralBenefitsClient


def get_benefits_summary():
    # The stubs provide type hints; boto3 itself performs the AWS API calls.
    client: PartnerCentralBenefitsClient = boto3.client(
        "partnercentral-benefits",
        region_name="us-east-1",
        aws_access_key_id="test", # Replace with actual credentials or env vars
        aws_secret_access_key="test"
    )

    try:
        response = client.list_partner_benefits(MaxResults=10)
        print("Successfully listed partner benefits.")
        for benefit in response.get("PartnerBenefitSummaries", []):
            print(f"- Benefit ID: {benefit.get('BenefitId')}, Status: {benefit.get('Status')}")
    except Exception as e:
        print(f"Error listing partner benefits: {e}")


if __name__ == "__main__":
    get_benefits_summary()