mypy-boto3-servicecatalog: ServiceCatalog Type Annotations

Warnings

• breaking Python 3.8 support was removed for all `mypy-boto3` packages (including `mypy-boto3-servicecatalog`) starting with `mypy-boto3-builder` version 8.12.0. Projects using Python 3.8 or older will need to upgrade their Python version.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking In `mypy-boto3-builder` version 8.9.0, some `TypeDef` names for method arguments were shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). Conflicting `Extra` postfixes were also moved to the end. This may require updating explicit `TypeDef` imports.
  Fix: Review and update explicit `TypeDef` imports and usage according to the new naming conventions.
• gotcha `mypy-boto3-servicecatalog` provides type stubs for `boto3` and should not be used as a runtime dependency or for importing classes directly for runtime execution. It is intended solely for static type checking.
  Fix: Ensure you are installing and using `boto3` for actual runtime operations. The `mypy-boto3-servicecatalog` package is only for type checkers (like mypy, pyright) and IDEs.
• gotcha When using `mypy-boto3` stubs with Pylint, it might complain about undefined variables within `if TYPE_CHECKING:` blocks.
  Fix: To fix this, you can set all typed variables to `object` in the `else` block of your `TYPE_CHECKING` conditional, or disable the specific Pylint warning.

Install

• pip install mypy-boto3-servicecatalog Standalone package
• pip install 'boto3-stubs[servicecatalog]' Integrated with boto3-stubs

Imports

• ServiceCatalogClient

  from mypy_boto3_servicecatalog.client import ServiceCatalogClient

• AcceptPortfolioShareInputTypeDef

  from mypy_boto3_servicecatalog.type_defs import AcceptPortfolioShareInputTypeDef

  For explicit type hints of API call parameters.
• AccessLevelFilterKeyType

  from mypy_boto3_servicecatalog.literals import AccessLevelFilterKeyType

  For explicit type hints of literal values.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-servicecatalog` to add type hints to a `boto3` ServiceCatalog client. It defines a function that lists Service Catalog products, explicitly typing the client and response objects to leverage static analysis. The `TYPE_CHECKING` block ensures the stubs are only loaded during static analysis, not at runtime.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_servicecatalog.client import ServiceCatalogClient
    from mypy_boto3_servicecatalog.type_defs import SearchProductsOutputTypeDef

def list_servicecatalog_products() -> list[str]:
    """Lists Service Catalog products with type hints."""
    # boto3 client is dynamically typed at runtime, stubs provide static types
    client: ServiceCatalogClient = boto3.client("servicecatalog")
    
    response: SearchProductsOutputTypeDef = client.search_products()
    product_names = []
    for product_view in response.get('ProductViewAggregations', []):
        if 'ProductViewSummary' in product_view and 'Name' in product_view['ProductViewSummary']:
            product_names.append(product_view['ProductViewSummary']['Name'])
    return product_names

if __name__ == "__main__":
    print("Attempting to list Service Catalog products (requires AWS credentials)...")
    try:
        products = list_servicecatalog_products()
        if products:
            print(f"Found {len(products)} products:")
            for product in products:
                print(f"- {product}")
        else:
            print("No Service Catalog products found.")
    except Exception as e:
        print(f"Error listing products: {e}")