mypy-boto3-workspaces-web type stubs

Warnings

• breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0. This means `mypy-boto3-workspaces-web` generated with this builder version (and newer) will not support Python 3.8.
  Fix: Upgrade your Python environment to version 3.9 or newer. Ensure `mypy` is also updated to a compatible version (mypy itself dropped Python 3.8 support).
• breaking The `mypy-boto3` packages, including `mypy-boto3-workspaces-web`, migrated to PEP 561 packaging. While this improves discoverability, it might affect how older `mypy` versions or IDEs resolve stubs if not properly installed or configured.
  Fix: Ensure `mypy-boto3-workspaces-web` (or `boto3-stubs[workspaces-web]`) is installed in the same Python environment used by your type checker. Update your `mypy` version to ensure full PEP 561 compatibility.
• breaking TypeDef naming conventions were changed in `mypy-boto3-builder` 8.9.0. Some TypeDefs for packed method arguments or those with conflicting names were renamed (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and `Extra` postfix moved to end).
  Fix: Review your code for any explicit `TypeDef` imports and update their names according to the new convention if you are on an affected `mypy-boto3` version.
• gotcha This package only provides type stubs. You *must* also install the `boto3` library for your application to run at runtime.
  Fix: Install `boto3` using `pip install boto3`.
• gotcha For optimal performance and to avoid adding unnecessary runtime dependencies, it is a best practice to encapsulate `mypy-boto3` type imports within `if TYPE_CHECKING:` blocks.
  Fix: Use `from typing import TYPE_CHECKING` and wrap your `mypy_boto3_workspaces_web` imports inside `if TYPE_CHECKING:` blocks.

Install

• pip install mypy-boto3-workspaces-web boto3 mypy Install type stubs, boto3, and mypy

Imports

• WorkSpacesWebClient

  from mypy_boto3_workspaces_web.client import WorkSpacesWebClient

  Import the typed client for WorkSpacesWeb service.
• WorkSpacesWebServiceName

  from mypy_boto3_workspaces_web.literals import WorkSpacesWebServiceName

  Import literal types for service names.
• AssociateBrowserSettingsRequestTypeDef

  from mypy_boto3_workspaces_web.type_defs import AssociateBrowserSettingsRequestTypeDef

  Import TypedDicts for request/response payloads.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `boto3` WorkSpacesWeb client and use it with `mypy-boto3-workspaces-web` stubs. It showcases importing the client type and a `TypeDef` for a response, and importantly uses `if TYPE_CHECKING:` to avoid runtime dependencies on the stub package. Remember to configure your AWS credentials for the code to run successfully.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_workspaces_web.client import WorkSpacesWebClient
    from mypy_boto3_workspaces_web.type_defs import ListBrowserSettingsResponseTypeDef

def get_workspaces_web_client() -> 'WorkSpacesWebClient':
    """Returns a typed boto3 WorkSpacesWeb client."""
    return boto3.client("workspaces-web")

def list_browser_settings_typed() -> ListBrowserSettingsResponseTypeDef:
    """Lists WorkSpaces Web browser settings with type hints."""
    client: WorkSpacesWebClient = get_workspaces_web_client()
    response = client.list_browser_settings()
    print(f"Found {len(response.get('browserSettings', []))} browser settings.")
    return response

if __name__ == "__main__":
    # This part requires AWS credentials configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
    # It will attempt to call the AWS API.
    try:
        list_browser_settings_typed()
    except Exception as e:
        print(f"An error occurred: {e}. Ensure AWS credentials are configured and WorkSpaces Web service is available.")