mypy-boto3-signin Type Annotations

1.42.3 · active · verified Sat Apr 11

mypy-boto3-signin provides static type annotations for the `boto3` AWS SDK's SignInService. It is generated by `mypy-boto3-builder` and aims to enhance developer experience by enabling IDE auto-completion, catching type-related errors at development time, and improving code readability for `boto3` client interactions with the SignInService. Releases are frequent, typically aligning with new `boto3` versions or `mypy-boto3-builder` updates.

Warnings

breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0, which generates `mypy-boto3-signin`. Projects using older Python versions must update to Python 3.9 or newer.
Fix: Upgrade Python environment to 3.9 or a newer supported version.
breaking In `mypy-boto3-builder` 8.9.0, there were breaking changes to `TypeDef` naming conventions, e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. While specific to service names, this applies generally across the `mypy-boto3` ecosystem and could affect custom stub usage.
Fix: Update `TypeDef` imports and usage to reflect the new, shorter naming conventions.
gotcha This package provides *only* type stubs. The actual `boto3` library must be installed separately for the code to run at runtime.
Fix: Ensure `pip install boto3` is executed in your environment alongside `mypy-boto3-signin`.
gotcha The `mypy-boto3` ecosystem migrated to PEP 561-compliant packages. While beneficial, this might cause issues with very old `mypy` or `setuptools` configurations.
Fix: Ensure `mypy` and packaging tools (like `setuptools`, `pip`) are up-to-date. In some cases, explicit `pip install --upgrade mypy setuptools` might be needed.
gotcha Explicit type annotations (e.g., `client: SignInServiceClient = boto3.client(...)`) may be necessary for full IDE auto-completion in some environments (e.g., VSCode with certain extensions), even though `mypy` and PyCharm often infer types automatically.
Fix: Add explicit type annotations to `boto3` client and resource assignments if auto-completion or type checking is not working as expected in your IDE.

Install

pip install mypy-boto3-signin boto3 Install with boto3

Imports

SignInServiceClient
```
from mypy_boto3_signin.client import SignInServiceClient
```
For type-hinting the boto3 'signin' client.
CreateAccountSubscriptionOutputTypeDef
```
from mypy_boto3_signin.type_defs import CreateAccountSubscriptionOutputTypeDef
```
For type-hinting the response of 'create_account_subscription' operation.

Quickstart

This quickstart demonstrates how to type-hint a `boto3` 'signin' client and its response using `mypy-boto3-signin` stubs. It showcases the use of `SignInServiceClient` for the client object and `CreateAccountSubscriptionOutputTypeDef` for a hypothetical operation's return type, improving static analysis and IDE support.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_signin.client import SignInServiceClient
    from mypy_boto3_signin.type_defs import CreateAccountSubscriptionOutputTypeDef

def create_signin_subscription() -> CreateAccountSubscriptionOutputTypeDef:
    # A real 'signin' service operation might be different or require more parameters.
    # This is a hypothetical example for demonstration purposes.
    client: SignInServiceClient = boto3.client("signin")
    response = client.create_account_subscription(
        # Actual parameters would go here, e.g., 'SourceId': 'some-id'
    )
    print(f"Subscription created: {response}")
    return response

if __name__ == "__main__":
    # This code is illustrative. Actual 'signin' service interaction 
    # will depend on its capabilities and available operations.
    try:
        result = create_signin_subscription()
        print(f"Result type: {type(result)}")
    except Exception as e:
        print(f"Error interacting with SignInService: {e}")

view raw JSON →