Type Annotations for boto3 LocationService

1.42.3 · active · verified Sat Apr 11

mypy-boto3-location provides type annotations for the boto3 LocationService, enhancing developer experience with type checking, autocomplete, and static analysis in IDEs like VSCode and PyCharm. It keeps pace with boto3 releases, automatically generating stubs with `mypy-boto3-builder`. The current version is 1.42.3.

Warnings

breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 or older should upgrade their Python version.
Fix: Upgrade Python to 3.9 or newer.
breaking TypeDef naming conventions changed in `mypy-boto3-builder` version 8.9.0. Some TypeDefs for packed method arguments use shorter names, and conflicting `Extra` postfixes were moved. This could break code explicitly importing or referencing these TypeDefs.
Fix: Review and update explicit TypeDef imports and references according to the new naming conventions.
gotcha PyCharm users might experience slow performance or high CPU usage due to `Literal` overloads. It is recommended to use `boto3-stubs-lite` or disable PyCharm's internal type checker and rely on `mypy` or `pyright` instead.
Fix: Install `boto3-stubs-lite[location]` instead of `mypy-boto3-location` or `boto3-stubs[location]`, or configure PyCharm to use an external type checker.
gotcha For Pylint compatibility, if `mypy-boto3-location` is a `TYPE_CHECKING` dependency, Pylint might complain about undefined variables. A common fix is to set types to `object` in non-`TYPE_CHECKING` mode.
Fix: Wrap type imports with `if TYPE_CHECKING:` and define fallback `object` assignments for runtime, as shown in the example import section.

Install

pip install mypy-boto3-location Install standalone package
pip install 'boto3-stubs[location]' # Alternative using the bundled stubs Install via boto3-stubs extras

Imports

LocationServiceClient

from mypy_boto3_location.client import LocationServiceClient

LocationService

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_location.client import LocationServiceClient

client: LocationServiceClient = boto3.client("location")

For implicit typing, just `import boto3` is often sufficient, but explicit typing of the client is recommended for full IDE support and type checking.

Quickstart

This example demonstrates how to initialize a type-hinted LocationService client and use it to list geofences. It includes an explicit type annotation for the client and the response type, enabling full static analysis and autocomplete.

import os
import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_location.client import LocationServiceClient
    from mypy_boto3_location.type_defs import ListGeofencesResponseTypeDef

def get_location_client() -> LocationServiceClient:
    """Initializes and returns a typed LocationService client."""
    # AWS credentials will be picked up from environment variables (e.g., AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
    # or ~/.aws/credentials. REGION_NAME is important for LocationService.
    region = os.environ.get('AWS_REGION', 'us-east-1')
    return boto3.client('location', region_name=region)

def list_all_geofences():
    """Lists all geofences using the LocationService client."""
    client = get_location_client()
    try:
        response: ListGeofencesResponseTypeDef = client.list_geofences(CollectionName='my-geofence-collection')
        print(f"Geofences found: {len(response['Entries'])}")
        for entry in response['Entries']:
            print(f" - Geofence ID: {entry['GeofenceId']}")
    except client.exceptions.ResourceNotFoundException:
        print("Geofence collection 'my-geofence-collection' not found or empty.")
    except Exception as e:
        print(f"An error occurred: {e}")

if __name__ == '__main__':
    # This quickstart requires an existing LocationService geofence collection.
    # Replace 'my-geofence-collection' with an actual collection name in your AWS account.
    list_all_geofences()

view raw JSON →