mypy-boto3-workdocs Type Annotations

Warnings

• breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0 and later. Users on Python 3.8 will need to upgrade to Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or later.
• breaking TypeDef naming conventions changed in `mypy-boto3-builder` version 8.9.0. Some TypeDef names for packed method arguments became shorter (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` -> `CreateDistributionRequestExtraTypeDef`). This might break existing type hints that use the old names.
  Fix: Review your code for explicitly typed `TypeDef` objects and update their names according to the new conventions.
• gotcha When using PyCharm, performance issues with `Literal` overloads might lead to slow performance or high CPU usage. It is recommended to use `boto3-stubs-lite` (if available for your service) or disable PyCharm's type checker and rely on `mypy` or `pyright` instead.
  Fix: Consider `pip install boto3-stubs-lite` (if you are using `boto3-stubs` umbrella package) or use `mypy`/`pyright` for type checking in PyCharm.
• gotcha Pylint might report 'undefined variable' errors when using `TYPE_CHECKING` guards for `mypy-boto3` types. To fix this, set all types to `object` in the non-`TYPE_CHECKING` branch of your conditional imports.
  Fix: Implement a conditional import pattern like `if TYPE_CHECKING: from mypy_boto3_workdocs.client import WorkDocsClient else: WorkDocsClient = object`.
• gotcha The `mypy-boto3` ecosystem migrated to PEP 561 compliant packages in version 8.12.0. While this is primarily an internal packaging change, it ensures better compatibility and discovery of type stubs by type checkers, but users should be aware of modern packaging practices.
  Fix: Ensure your project's packaging follows current best practices, especially if encountering issues with type checker discovery.

Install

• pip install mypy-boto3-workdocs boto3 mypy Install with pip

Imports

• WorkDocsClient

  from mypy_boto3_workdocs.client import WorkDocsClient

  While boto3.client is the runtime client, mypy_boto3_workdocs provides the type definitions for static analysis.
• DescribeUsersRequestRequestTypeDef

  from mypy_boto3_workdocs.type_defs import DescribeUsersRequestRequestTypeDef

  Type definitions (TypedDicts) are typically found in the `type_defs` submodule, not directly under `client`.

Quickstart

This quickstart demonstrates how to initialize a WorkDocs client with explicit type annotations for `mypy` using `mypy-boto3-workdocs`. It shows how to obtain a typed client and use a method with its corresponding response type definition. For full functionality, ensure your AWS credentials and WorkDocs Organization ID are configured, e.g., via environment variables.

import boto3
from typing import TYPE_CHECKING
import os

if TYPE_CHECKING:
    from mypy_boto3_workdocs.client import WorkDocsClient
    from mypy_boto3_workdocs.type_defs import DescribeUsersResponseTypeDef


def get_workdocs_client() -> 'WorkDocsClient':
    # In a real application, configure AWS credentials securely.
    # For quickstart, using environment variables.
    session = boto3.Session(
        aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', ''),
        aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', ''),
        region_name=os.environ.get('AWS_DEFAULT_REGION', 'us-east-1')
    )
    return session.client('workdocs')


if __name__ == '__main__':
    client: WorkDocsClient = get_workdocs_client()
    print(f"Client type: {type(client)}")

    # Example: Describe users with explicit type hints
    response: DescribeUsersResponseTypeDef = client.describe_users(
        OrganizationId="your_organization_id" # Replace with actual Organization ID
    )
    print("Successfully described users.")
    print(f"Users: {response.get('Users')}")
    # Note: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION
    # and your_organization_id must be set for this to run successfully.