mypy-boto3-route53-recovery-readiness

Warnings

• breaking Python 3.8 support has been removed since `mypy-boto3-builder` version 8.12.0. Projects using this package must target Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or higher.
• breaking As of `mypy-boto3-builder` version 8.12.0, packages migrated to PEP 561 compliance. This change might affect how type checkers locate and process stubs in certain environments or older project setups.
  Fix: Ensure your `mypy` configuration and project structure are compatible with PEP 561 stub packages. You might need to rebuild or reconfigure your environment.
• breaking Type definition (TypeDef) names for service requests and responses underwent renaming in `mypy-boto3-builder` version 8.9.0. Common patterns like `RequestRequestTypeDef` were shortened to `RequestTypeDef`, and `ExtraRequestTypeDef` became `RequestExtraTypeDef`.
  Fix: Review your code for imports of specific `TypeDef` classes and adjust their names according to the new conventions. Refer to the documentation or generated stub files for the exact new names.
• gotcha This library provides type annotations *only*; it does not alter `boto3`'s runtime behavior or provide any runtime functionality itself. Its sole purpose is to enable static type checking.
  Fix: Understand that `mypy-boto3-*` packages are developer tools for compile-time checking, not runtime dependencies that change program execution.
• gotcha The `mypy-boto3` stub packages are tightly coupled to specific `boto3` versions. Using a `mypy-boto3-*` package version that doesn't align with your installed `boto3` version can lead to incorrect or missing type hints.
  Fix: Always try to match the major.minor version of `mypy-boto3-*` with your `boto3` installation (e.g., `mypy-boto3-route53-recovery-readiness==1.x.y` for `boto3==1.x.y`). Update both simultaneously if possible.

Install

• pip install mypy-boto3-route53-recovery-readiness Install package

Imports

• Route53RecoveryReadinessClient

  from mypy_boto3_route53_recovery_readiness.client import Route53RecoveryReadinessClient

  Type stubs are imported from the dedicated mypy-boto3 package, not directly from the runtime boto3 library.
• ListReadinessChecksOutputTypeDef

  from mypy_boto3_route53_recovery_readiness.type_defs import ListReadinessChecksOutputTypeDef

  Type definitions for service responses and requests are typically found in the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to use the `mypy-boto3-route53-recovery-readiness` type stubs with a standard `boto3` client. When this code is run through `mypy`, it will ensure that the `client` object and the `response` adhere to the type definitions provided by the stub package, catching potential errors at compile time.

import boto3
from mypy_boto3_route53_recovery_readiness.client import Route53RecoveryReadinessClient
from mypy_boto3_route53_recovery_readiness.type_defs import ListReadinessChecksOutputTypeDef
import os

def get_readiness_checks() -> ListReadinessChecksOutputTypeDef:
    """Fetches a list of Route53 Recovery Readiness checks and returns their typed response."""
    # mypy-boto3 provides type hints for the boto3 client object
    client: Route53RecoveryReadinessClient = boto3.client(
        "route53-recovery-readiness",
        region_name=os.environ.get("AWS_REGION", "us-east-1")
    )
    response = client.list_readiness_checks()
    print(f"Found {len(response.get('ReadinessChecks', []))} readiness checks.")
    return response

if __name__ == "__main__":
    # When mypy is run on this file, it will verify that
    # `get_readiness_checks` returns a `ListReadinessChecksOutputTypeDef`
    # and that subsequent access to 'result' follows that type definition.
    result = get_readiness_checks()
    # Example of type-safe access:
    for check in result.get('ReadinessChecks', []):
        print(f"  - {check.get('ReadinessCheckName', 'N/A')}")