mypy-boto3-freetier

1.42.3 · active · verified Sat Apr 11

mypy-boto3-freetier provides type annotations (type stubs) for the boto3 FreeTier service, enhancing developer experience with static type checking in Python projects. It is part of the larger `mypy-boto3` ecosystem, generated by `mypy-boto3-builder`, and its versions typically align with corresponding `boto3` releases, with frequent updates to reflect AWS service changes.

Warnings

breaking Python 3.8 is no longer supported for `mypy-boto3-builder` generated packages (including `mypy-boto3-freetier`) as of `mypy-boto3-builder` version 8.12.0.
Fix: Upgrade your Python environment to version 3.9 or newer.
gotcha `mypy-boto3-freetier` is a stub-only package. It provides type hints for `boto3` but does not include `boto3` itself. `boto3` must be installed separately to provide the runtime functionality.
Fix: Always install `boto3` alongside `mypy-boto3-freetier`: `pip install boto3 mypy-boto3-freetier`.
gotcha For optimal type checking accuracy, ensure the version of `mypy-boto3-freetier` closely matches your installed `boto3` version. Significant version mismatches can lead to incorrect or missing type hints.
Fix: Prefer installing `mypy-boto3-freetier` with a version constraint that aligns with your `boto3` installation (e.g., if `boto3==1.42.3`, install `mypy-boto3-freetier==1.42.3`).
gotcha The AWS FreeTier service only exposes a client interface. Attempting to use `boto3.resource('freetier')` will result in a runtime error from boto3, as there is no FreeTier resource.
Fix: Always use `boto3.client('freetier')` for interacting with the FreeTier service. `mypy-boto3-freetier` correctly reflects this by not providing a resource stub.

Install

pip install mypy-boto3-freetier boto3 Install with boto3

Imports

FreeTierClient

from mypy_boto3_freetier.client import FreeTierClient

FreeTierServiceResource
```
import boto3
# FreeTier does not have a resource interface, so this import path is not available.
```
The FreeTier service only provides a client interface; there is no resource interface in boto3 for FreeTier.

GetFreeTierUsageResponseTypeDef

from mypy_boto3_freetier.type_defs import GetFreeTierUsageResponseTypeDef

Quickstart

This example demonstrates how to use the `mypy-boto3-freetier` stubs to get type-hinted interaction with the boto3 FreeTier client. It shows importing the `FreeTierClient` for type annotations and a specific `TypeDef` for response parsing, ensuring static type checkers like mypy can validate your code.

import boto3
from mypy_boto3_freetier.client import FreeTierClient
from mypy_boto3_freetier.type_defs import GetFreeTierUsageResponseTypeDef

def get_freetier_usage() -> GetFreeTierUsageResponseTypeDef:
    # mypy-boto3-freetier provides type hints for this client
    client: FreeTierClient = boto3.client('freetier')
    response: GetFreeTierUsageResponseTypeDef = client.get_free_tier_usage()
    print(f"Free Tier Usage: {response.get('FreeTierUsages')}")
    return response

if __name__ == '__main__':
    # Ensure AWS credentials are configured or available via environment variables
    # For local testing, you might need to mock boto3 or ensure credentials are set.
    # Example: os.environ['AWS_ACCESS_KEY_ID'] = '...' 
    #          os.environ['AWS_SECRET_ACCESS_KEY'] = '...' 
    #          os.environ['AWS_DEFAULT_REGION'] = 'us-east-1'
    
    try:
        get_freetier_usage()
    except Exception as e:
        print(f"Error fetching Free Tier usage: {e}")

view raw JSON →