mypy-boto3-s3control

Warnings

• breaking Python 3.8 support was removed for all `mypy-boto3` packages, including `mypy-boto3-s3control`, starting with `mypy-boto3-builder` version 8.12.0.
  Fix: Upgrade your Python environment to 3.9 or newer. The `requires_python` metadata is `^3.9`.
• breaking The `mypy-boto3` ecosystem migrated to PEP 561 compliant packages with `mypy-boto3-builder` 8.12.0. While this is generally an improvement for type checker discovery, it might affect custom build systems or older IDE integrations that expect different package structures for stub files.
  Fix: Ensure your environment and tooling are up-to-date and correctly handle PEP 561 packages. Most modern type checkers and IDEs should support this automatically.
• breaking TypedDicts for packed method arguments may have shorter names starting with `mypy-boto3-builder` version 8.9.0. For example, `CreateDistributionRequestRequestTypeDef` might become `CreateDistributionRequestTypeDef`. This could break code explicitly referencing the older, longer TypeDef names.
  Fix: Review and update explicit TypeDef references in your code to match the new naming conventions.
• gotcha `mypy-boto3-s3control` provides *only* type annotations. You must also install `boto3` for the actual runtime functionality of the AWS SDK for Python.
  Fix: Ensure `boto3` is installed in your environment alongside `mypy-boto3-s3control` (e.g., `pip install boto3 mypy-boto3-s3control`).
• gotcha For optimal type checking and auto-completion, especially if not using the `boto3-stubs` package with extras, explicitly annotating the client variable with `S3ControlClient` (e.g., `client: S3ControlClient = boto3.client("s3control")`) is highly recommended.
  Fix: Always add explicit type annotations when initializing Boto3 clients or resources from `boto3.client()` or `session.client()`.
• gotcha PyCharm users might experience slow performance with Literal overloads. The `mypy-boto3` documentation suggests using the `lite` versions of stub packages to mitigate this issue or disabling PyCharm's internal type checker in favor of external tools like `mypy` or `pyright`.
  Fix: If experiencing performance issues in PyCharm, consider installing `boto3-stubs-lite[s3control]` instead of `mypy-boto3-s3control`, or configure PyCharm to use an external type checker.

Install

• pip install mypy-boto3-s3control boto3 Standalone Installation (recommended if you only need S3Control stubs)
• pip install 'boto3-stubs[s3control]' boto3 Using boto3-stubs with extras (for multiple service stubs)

Imports

• S3ControlClient

  from mypy_boto3_s3control.client import S3ControlClient

  While `from mypy_boto3_s3control import S3ControlClient` might work due to `__init__.py` re-exports, directly importing from `mypy_boto3_s3control.client` is more explicit and robust, especially for IDE type inference.
• ListAccessPointsForDirectoryBucketsPaginator

  from mypy_boto3_s3control.paginator import ListAccessPointsForDirectoryBucketsPaginator

  For type hints of paginator objects.
• CreateAccessPointRequestRequestTypeDef

  from mypy_boto3_s3control.type_defs import CreateAccessPointRequestRequestTypeDef

  For type hints of request/response dictionaries (TypedDicts).

Quickstart

This example demonstrates how to initialize a type-hinted `S3ControlClient` and use it to call a method like `list_access_points`. The type annotations ensure that method calls and their parameters/return types are checked statically by tools like MyPy or your IDE, catching potential errors before runtime. Remember to have `boto3` installed alongside `mypy-boto3-s3control`.

import boto3
from mypy_boto3_s3control.client import S3ControlClient
from mypy_boto3_s3control.type_defs import ListAccessPointsResponseTypeDef

def get_s3control_client() -> S3ControlClient:
    """Returns a typed S3Control client."""
    # boto3.client returns an untyped client by default.
    # The explicit type annotation (S3ControlClient) provides type checking.
    client: S3ControlClient = boto3.client("s3control")
    return client

def list_access_points(client: S3ControlClient, account_id: str) -> ListAccessPointsResponseTypeDef:
    """Lists S3 access points with type checking."""
    response: ListAccessPointsResponseTypeDef = client.list_access_points(
        AccountId=account_id
    )
    return response

if __name__ == "__main__":
    # Replace with your AWS account ID
    aws_account_id = "012345678901" # os.environ.get('AWS_ACCOUNT_ID', '012345678901')
    
    s3_control_client = get_s3control_client()
    print(f"S3Control Client type: {type(s3_control_client)}")

    # Example usage (will typically require valid credentials and permissions)
    try:
        access_points = list_access_points(s3_control_client, aws_account_id)
        print(f"Found {len(access_points.get('AccessPointList', []))} S3 access points.")
    except Exception as e:
        print(f"Error listing access points (credentials/permissions might be needed): {e}")