Type annotations for boto3.GroundStation 1.14.5 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-groundstation
Type annotations for boto3.GroundStation 1.14.5 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for GroundStation
service.
python -m pip install boto3-stubs[groundstation]
How to use
Client annotations
GroundStationClient
provides annotations for boto3.client("groundstation")
.
import boto3
from mypy_boto3_groundstation import GroundStationClient
from mypy_boto3_groundstation.paginator import (
ListConfigsPaginator,
ListContactsPaginator,
ListDataflowEndpointGroupsPaginator,
ListGroundStationsPaginator,
ListMissionProfilesPaginator,
ListSatellitesPaginator,
)
from mypy_boto3_groundstation.type_defs import AntennaDownlinkConfigTypeDef, ...
client: GroundStationClient = boto3.client("groundstation")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: GroundStationClient = session.client("groundstation")
Paginators annotations
mypy_boto3_groundstation.paginator
module contains type annotations for all paginators.
client: GroundStationClient = boto3.client("groundstation")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_configs_paginator: ListConfigsPaginator = client.get_paginator("list_configs")
list_contacts_paginator: ListContactsPaginator = client.get_paginator("list_contacts")
list_dataflow_endpoint_groups_paginator: ListDataflowEndpointGroupsPaginator = client.get_paginator("list_dataflow_endpoint_groups")
list_ground_stations_paginator: ListGroundStationsPaginator = client.get_paginator("list_ground_stations")
list_mission_profiles_paginator: ListMissionProfilesPaginator = client.get_paginator("list_mission_profiles")
list_satellites_paginator: ListSatellitesPaginator = client.get_paginator("list_satellites")
Typed dictionations
mypy_boto3_groundstation.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AntennaDownlinkConfigTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_groundstation
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("groundstation")
session_client = boto3.Session().client("groundstation")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-groundstation-1.14.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a87d0ff881fade6418791603785cea127f1e579f4410ef2b0ea2977093abeefc |
|
MD5 | 294859e42685d45324afd8e5d0c51084 |
|
BLAKE2b-256 | ea145668952a972a5bc8535514f6af4f5511ecdbcb8cad7969d06494f10624e3 |
Hashes for mypy_boto3_groundstation-1.14.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba9bd7616c38bc7b7db1021e4356d04e72b1c288f3b22b998b6daec98884a592 |
|
MD5 | 98dff1063a284ed83e70e5bf831cbfdc |
|
BLAKE2b-256 | f4216b4d6ffc0f905286d14753f044330978c3d5a9957174d112d597e4be00ad |