# mypy-boto3-groundstation
[![PyPI - mypy-boto3-groundstation](https://img.shields.io/pypi/v/mypy-boto3-groundstation.svg?color=blue)](https://pypi.org/project/mypy-boto3-groundstation)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-groundstation.svg?color=blue)](https://pypi.org/project/mypy-boto3-groundstation)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-groundstation?color=blue)](https://pypistats.org/packages/mypy-boto3-groundstation)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.GroundStation 1.17.65](https://boto3.amazonaws.com/v1/documentation/api/1.17.65/reference/services/groundstation.html#GroundStation)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-buider 4.10.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-groundstation docs](https://github.com/vemel/mypy_boto3_builder/service_docs/mypy_boto3_groundstation/README.md)
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-groundstation](#mypy-boto3-groundstation)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
## How to install
Install `boto3-stubs` for `GroundStation` service.
```bash
python -m pip install boto3-stubs[groundstation]
```
## Usage
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[groundstation]` in your environment:
`python -m pip install 'boto3-stubs[groundstation]'`
Both type checking and auto-complete should work for `GroundStation` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[groundstation]` in your environment:
`python -m pip install 'boto3-stubs[groundstation]'`
Both type checking and auto-complete should work for `GroundStation` service.
No explicit type annotations required, write your `boto3` code as usual.
Auto-complete can be slow on big projects or if you have a lot of installed
`boto3-stubs` submodules.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[groundstation]` in your environment:
`python -m pip install 'boto3-stubs[groundstation]'`
- Run `mypy` as usual
Type checking should work for `GroundStation` service. No explicit type
annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[groundstation]` in your environment:
`python -m pip install 'boto3-stubs[groundstation]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `GroundStation` service. No explicit type
annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`GroundStationClient` provides annotations for `boto3.client("groundstation")`.
```python
import boto3
from mypy_boto3_groundstation import GroundStationClient
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.
```python
from mypy_boto3_groundstation import GroundStationClient
from mypy_boto3_groundstation.paginator import (
ListConfigsPaginator,
ListContactsPaginator,
ListDataflowEndpointGroupsPaginator,
ListGroundStationsPaginator,
ListMissionProfilesPaginator,
ListSatellitesPaginator,
)
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")
```
### Literals
`mypy_boto3_groundstation.literals` module contains literals extracted from
shapes that can be used in user code for type checking.
```python
from mypy_boto3_groundstation.literals import (
AngleUnits,
BandwidthUnits,
ConfigCapabilityType,
ContactStatus,
Criticality,
EirpUnits,
EndpointStatus,
FrequencyUnits,
ListConfigsPaginatorName,
ListContactsPaginatorName,
ListDataflowEndpointGroupsPaginatorName,
ListGroundStationsPaginatorName,
ListMissionProfilesPaginatorName,
ListSatellitesPaginatorName,
Polarization,
)
def check_value(value: AngleUnits) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_groundstation.type_defs` module contains structures and shapes
assembled to typed dictionaries for additional type checking.
```python
from mypy_boto3_groundstation.type_defs import (
AntennaDemodDecodeDetailsTypeDef,
AntennaDownlinkConfigTypeDef,
AntennaDownlinkDemodDecodeConfigTypeDef,
AntennaUplinkConfigTypeDef,
ConfigDetailsTypeDef,
ConfigIdResponseTypeDef,
ConfigListItemTypeDef,
ConfigTypeDataTypeDef,
ContactDataTypeDef,
ContactIdResponseTypeDef,
DataflowDetailTypeDef,
DataflowEndpointConfigTypeDef,
DataflowEndpointGroupIdResponseTypeDef,
DataflowEndpointListItemTypeDef,
DataflowEndpointTypeDef,
DecodeConfigTypeDef,
DemodulationConfigTypeDef,
DescribeContactResponseTypeDef,
DestinationTypeDef,
EirpTypeDef,
ElevationTypeDef,
EndpointDetailsTypeDef,
FrequencyBandwidthTypeDef,
FrequencyTypeDef,
GetConfigResponseTypeDef,
GetDataflowEndpointGroupResponseTypeDef,
GetMinuteUsageResponseTypeDef,
GetMissionProfileResponseTypeDef,
GetSatelliteResponseTypeDef,
GroundStationDataTypeDef,
ListConfigsResponseTypeDef,
ListContactsResponseTypeDef,
ListDataflowEndpointGroupsResponseTypeDef,
ListGroundStationsResponseTypeDef,
ListMissionProfilesResponseTypeDef,
ListSatellitesResponseTypeDef,
ListTagsForResourceResponseTypeDef,
MissionProfileIdResponseTypeDef,
MissionProfileListItemTypeDef,
PaginatorConfigTypeDef,
S3RecordingConfigTypeDef,
S3RecordingDetailsTypeDef,
SatelliteListItemTypeDef,
SecurityDet
PyPI 官网下载 | mypy-boto3-groundstation-1.17.65.0.tar.gz
版权申诉
49 浏览量
2022-01-13
14:25:54
上传
评论
收藏 12KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- juhua-p8YYy-v0e13a7b5(1).apk
- Neo4j资源:Neo4j.rb的性能测试相关程序
- 排序算法之堆排序算法:用C++语言实现堆排序算法
- 基于Springboot的房屋租赁系统(源代码+论文+说明文档+PPT)-计算机专业精品毕业设计和课程设计
- leidian.py
- 直接插入排序算法:C语言实现直接插入排序算法
- 基于Springboot的大学生就业招聘系统(源代码+论文+说明文档+PPT)-计算机专业精品毕业设计和课程设计
- 基于Vue的H5结婚请帖前端设计源码
- saxaxasxasx
- 基于SSM++jsp的实验室耗材管理系统(源代码+论文+说明文档+PPT)-计算机专业精品毕业设计和课程设计
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈