mypy-boto3-geo-maps

1.42.84 · active · verified Sat Apr 11

mypy-boto3-geo-maps provides type annotations for the `boto3` AWS LocationServiceMapsV2 service. It enhances development with static type checking, autocompletion, and improved code readability for `boto3` users. The library is actively maintained with frequent updates, aligning with `boto3` releases and the `mypy-boto3-builder`'s development cadence.

Warnings

breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0 (which generated `mypy-boto3-geo-maps 1.42.84`). Projects using Python 3.8 will need to upgrade to Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or a newer supported version.
breaking Breaking changes in `mypy-boto3-builder` 8.9.0 introduced shorter names for TypeDefs for packed method arguments (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). This affects explicit imports of such TypeDefs.
Fix: Review your code for explicitly imported TypeDefs and update their names according to the new convention. Consult the `mypy-boto3-builder` changelog for specific renaming patterns.
gotcha As of `mypy-boto3-builder` 8.12.0, all `mypy-boto3` packages (including `mypy-boto3-geo-maps`) are PEP 561 compliant. This generally simplifies `mypy`'s ability to find stubs, but if you had a custom or non-standard `mypy` setup for older versions, you might need to ensure your `mypy` configuration is up-to-date.
Fix: Ensure `mypy` is up-to-date. No specific action is usually required, as `mypy` should automatically discover PEP 561 compliant packages. If issues persist, check `mypy`'s `installed-packages` documentation.
gotcha When using `pylint`, it may report 'undefined variables' for type-hinted clients or TypeDefs, especially if `mypy-boto3` packages are not in `install_requires` for production builds. Using a `TYPE_CHECKING` guard can mitigate this.
Fix: Wrap `mypy-boto3-geo-maps` imports in `if TYPE_CHECKING:` blocks and define runtime fallbacks (e.g., `Client = object`) for `pylint` compatibility. This prevents `mypy-boto3-geo-maps` from being a runtime dependency.

Install

pip install mypy-boto3-geo-maps boto3 Install with boto3
pip install 'boto3-stubs[geo-maps]' boto3 Install via boto3-stubs extras (recommended)

Imports

LocationServiceMapsV2Client
```
from mypy_boto3_geo_maps.client import LocationServiceMapsV2Client
```
Import the client type from `mypy_boto3_geo_maps` for static type checking. The actual runtime client is created via `boto3.client('geo-maps')`.
CreateMapRequestRequestTypeDef
```
from mypy_boto3_geo_maps.type_defs import CreateMapRequestRequestTypeDef
```
Type definitions for service requests and responses are located in the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `LocationServiceMapsV2Client` and construct a typed request using `TypeDef`s provided by `mypy-boto3-geo-maps`. The `TYPE_CHECKING` block ensures that these imports are only used by type checkers, avoiding runtime dependencies. Replace placeholder values and ensure AWS credentials are configured for actual execution.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_geo_maps.client import LocationServiceMapsV2Client
    from mypy_boto3_geo_maps.type_defs import CreateMapRequestRequestTypeDef

# Get a typed client for AWS Location Service (Maps V2)
client: 'LocationServiceMapsV2Client' = boto3.client("geo-maps")

# Example usage with a typed request (for illustration, not runnable without AWS creds)
try:
    # Define a request payload using TypeDef
    create_map_request: CreateMapRequestRequestTypeDef = {
        "MapName": "MyTestMap",
        "Configuration": {"Style": "VectorEsriStreets"},
        "Description": "A test map created via mypy-boto3-geo-maps",
    }

    # The actual API call (will raise ClientError without valid AWS setup)
    response = client.create_map(**create_map_request)
    print(f"Successfully initiated map creation: {response['MapArn']}")

except client.exceptions.ConflictException as e:
    print(f"Map already exists: {e}")
except Exception as e:
    print(f"An error occurred: {e}")

# Example of getting a static map (assuming a map exists and permissions are set)
# This call would require valid map name and API key if used publicly
# response = client.get_static_map(
#     MapName="MyTestMap",
#     CenterX=-77.0369,
#     CenterY=38.9072,
#     Zoom=12,
#     Width=400,
#     Height=300
# )
# print(f"Received static map data: {len(response['ImageData'])} bytes")

view raw JSON →