mypy-boto3-wickr Type Stubs for WickrAdminAPI

1.42.55 · active · verified Sat Apr 11

mypy-boto3-wickr provides type annotations for the boto3 WickrAdminAPI service, allowing static type checking with tools like MyPy. It is part of the `mypy-boto3` family, generated with `mypy-boto3-builder`, and currently at version 1.42.55. The `mypy-boto3` project generally releases updates in sync with new boto3 and AWS service releases.

Warnings

breaking Python 3.8 support was removed for all `mypy-boto3-builder` generated packages, including `mypy-boto3-wickr`, starting with builder version 8.12.0. Users on Python 3.8 will not receive updates or new versions of these stubs.
Fix: Upgrade to Python 3.9 or newer to continue receiving type stub updates and features.
breaking All `mypy-boto3-builder` generated packages migrated to PEP 561-compliant packaging in version 8.12.0. While this improves type stub discovery, it may require adjustments in projects that manually configured type stub paths.
Fix: Ensure your project's `pyproject.toml` or `setup.py` correctly handles PEP 561 type packages. For most users, this is a transparent change handled by pip.
gotcha These packages provide type stubs only. They do not contain any runtime code or functionality. You must have `boto3` installed to use the AWS services at runtime.
Fix: Ensure `boto3` is installed alongside `mypy-boto3-wickr` (e.g., `pip install boto3 mypy-boto3-wickr`).
gotcha `mypy` (or another static type checker) is required to utilize these type stubs. Without a type checker, these packages have no effect.
Fix: Install `mypy` (`pip install mypy`) and integrate it into your project's CI/CD pipeline or development workflow.
breaking Type definition naming conventions changed in `mypy-boto3-builder` version 8.9.0. Specifically, `TypeDef`s for packed method arguments now use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes moved to the end.
Fix: If your code explicitly imports or references generated `TypeDef` names, you may need to update them according to the new naming conventions. Consult the specific `mypy-boto3-wickr` package's `__init__.py` or documentation for exact type names.

Install

pip install boto3 mypy-boto3-wickr mypy Install with boto3 and mypy

Imports

WickrAdminClient
```
from mypy_boto3_wickr.client import WickrAdminClient
```
Import the typed client for WickrAdminAPI.
WickrAdminServiceResource
```
from mypy_boto3_wickr.service_resource import WickrAdminServiceResource
```
Import the typed service resource if using boto3 resources (less common for WickrAdminAPI).

Quickstart

This example demonstrates how to instantiate a `boto3` WickrAdmin client and use the `mypy-boto3-wickr` stubs for static type checking. The `TYPE_CHECKING` block ensures that the type hints are only used by type checkers like MyPy and do not affect runtime behavior. You need to run `mypy your_script.py` to see the benefits.

import boto3
from mypy_boto3_wickr.client import WickrAdminClient
from typing import TYPE_CHECKING

# Instantiate a boto3 client (runtime code)
wickr_client = boto3.client("wickr")

# Use TYPE_CHECKING block for type hints, not runtime execution
if TYPE_CHECKING:
    # This allows mypy to confirm the client type
    reveal_type(wickr_client)  # Expected: 'WickrAdminClient'
    typed_wickr_client: WickrAdminClient = wickr_client
    # Now, typed_wickr_client has full type hints for methods and arguments
    response = typed_wickr_client.list_memberships() 
else:
    # In runtime, wickr_client is just the boto3 client
    response = wickr_client.list_memberships()

print("ListMemberships response keys:", response.keys())

view raw JSON →