<a id="mypy-boto3-robomaker"></a>
# mypy-boto3-robomaker
[![PyPI - mypy-boto3-robomaker](https://img.shields.io/pypi/v/mypy-boto3-robomaker.svg?color=blue)](https://pypi.org/project/mypy-boto3-robomaker)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-robomaker.svg?color=blue)](https://pypi.org/project/mypy-boto3-robomaker)
[![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-robomaker?color=blue)](https://pypistats.org/packages/mypy-boto3-robomaker)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.RoboMaker 1.18.6](https://boto3.amazonaws.com/v1/documentation/api/1.18.6/reference/services/robomaker.html#RoboMaker)
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-builder 5.1.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-robomaker docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_robomaker/)
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-robomaker](#mypy-boto3-robomaker)
- [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)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
Install `boto3-stubs` for `RoboMaker` service.
```bash
python -m pip install boto3-stubs[robomaker]
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### 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[robomaker]` in your environment:
`python -m pip install 'boto3-stubs[robomaker]'`
Both type checking and auto-complete should work for `RoboMaker` service. No
explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[robomaker]` in your environment:
`python -m pip install 'boto3-stubs[robomaker]'`
Both type checking and auto-complete should work for `RoboMaker` 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.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[robomaker]` in your environment:
`python -m pip install 'boto3-stubs[robomaker]'`
- Run `mypy` as usual
Type checking should work for `RoboMaker` service. No explicit type annotations
required, write your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[robomaker]` in your environment:
`python -m pip install 'boto3-stubs[robomaker]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `RoboMaker` service. No explicit type annotations
required, write your `boto3` code as usual.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`RoboMakerClient` provides annotations for `boto3.client("robomaker")`.
```python
import boto3
from mypy_boto3_robomaker import RoboMakerClient
client: RoboMakerClient = boto3.client("robomaker")
# 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: RoboMakerClient = session.client("robomaker")
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_robomaker.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_robomaker import RoboMakerClient
from mypy_boto3_robomaker.paginator import (
ListDeploymentJobsPaginator,
ListFleetsPaginator,
ListRobotApplicationsPaginator,
ListRobotsPaginator,
ListSimulationApplicationsPaginator,
ListSimulationJobBatchesPaginator,
ListSimulationJobsPaginator,
ListWorldExportJobsPaginator,
ListWorldGenerationJobsPaginator,
ListWorldTemplatesPaginator,
ListWorldsPaginator,
)
client: RoboMakerClient = boto3.client("robomaker")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_deployment_jobs_paginator: ListDeploymentJobsPaginator = client.get_paginator("list_deployment_jobs")
list_fleets_paginator: ListFleetsPaginator = client.get_paginator("list_fleets")
list_robot_applications_paginator: ListRobotApplicationsPaginator = client.get_paginator("list_robot_applications")
list_robots_paginator: ListRobotsPaginator = client.get_paginator("list_robots")
list_simulation_applications_paginator: ListSimulationApplicationsPaginator = client.get_paginator("list_simulation_applications")
list_simulation_job_batches_paginator: ListSimulationJobBatchesPaginator = client.get_paginator("list_simulation_job_batches")
list_simulation_jobs_paginator: ListSimulationJobsPaginator = client.get_paginator("list_simulation_jobs")
list_world_export_jobs_paginator: ListWorldExportJobsPaginator = client.get_paginator("list_world_export_jobs")
list_world_generation_jobs_paginator: ListWorldGenerationJobsPaginator = client.get_paginator("list_world_generation_jobs")
list_world_templates_paginator: ListWorldTemplatesPaginator = client.get_paginator("list_world_templates")
list_worlds_paginator: ListWorldsPaginator = client.get_paginator("list_worlds")
```
<a id="literals"></a>
### Literals
`mypy_boto3_robomaker.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_robomaker.literals import (
ArchitectureType,
DeploymentJobErrorCodeType,
DeploymentStatusType,
ExitBehaviorType,
FailureBehaviorType,
ListDeploymentJobsPaginatorName,
ListFleetsPaginatorName,
ListRobotApplicationsPaginatorName,
ListRobotsPaginatorName,
ListSimulationApplicationsPaginatorName,
ListSimulationJobBatchesPaginatorName,
ListSimulationJobsPaginatorName,
ListWorldExportJobsPaginatorName,
ListWorldGenerationJobsPaginatorName,
ListWorldTemplatesPaginatorName,
ListWorldsPaginatorName,
RenderingEngineTypeType,
RobotDeploymentStepType,
RobotSoftwareSuiteTypeType,
RobotSoftwareSuiteVersionTypeType,
RobotStatusType,
SimulationJobBatchErrorCodeType,
SimulationJobBatchStatusType,
SimulationJobErrorCodeType,
SimulationJobStatusType,
SimulationSoftwareSuiteTypeType,
UploadBehaviorType,
WorldExportJobErrorCodeType,
WorldExportJobStatusType,
WorldGenerationJobErrorCodeType,
WorldGenerationJobStatusType,
)
def check_value(value: ArchitectureType) -> bool:
...
```
<a id="typed-dicti
没有合适的资源?快使用搜索试试~ 我知道了~
资源详情
资源评论
资源推荐
收起资源包目录
mypy-boto3-robomaker-1.18.6.tar.gz (23个子文件)
mypy-boto3-robomaker-1.18.6
PKG-INFO 19KB
mypy_boto3_robomaker
type_defs.py 57KB
py.typed 0B
type_defs.pyi 57KB
literals.py 6KB
client.py 41KB
__main__.py 901B
__init__.py 3KB
client.pyi 41KB
paginator.pyi 13KB
paginator.py 13KB
version.py 60B
literals.pyi 6KB
__init__.pyi 3KB
mypy_boto3_robomaker.egg-info
PKG-INFO 19KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 710B
top_level.txt 21B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
README.md 15KB
共 23 条
- 1
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0