diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-mypy-boto3-robomaker.spec | 1927 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 1929 insertions, 0 deletions
@@ -0,0 +1 @@ +/mypy-boto3-robomaker-1.26.0.post1.tar.gz diff --git a/python-mypy-boto3-robomaker.spec b/python-mypy-boto3-robomaker.spec new file mode 100644 index 0000000..eab8322 --- /dev/null +++ b/python-mypy-boto3-robomaker.spec @@ -0,0 +1,1927 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-robomaker +Version: 1.26.0.post1 +Release: 1 +Summary: Type annotations for boto3.RoboMaker 1.26.0 service generated with mypy-boto3-builder 7.11.10 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/e6/01/696c28d65401d4ac0e3e371fa40331f9745a97f8a52a0553cce12233b19d/mypy-boto3-robomaker-1.26.0.post1.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-robomaker"></a> + +# mypy-boto3-robomaker + +[](https://pypi.org/project/mypy-boto3-robomaker) +[](https://pypi.org/project/mypy-boto3-robomaker) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-robomaker) + + + +Type annotations for +[boto3.RoboMaker 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/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 7.11.10](https://github.com/youtype/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://youtype.github.io/boto3_stubs_docs/mypy_boto3_robomaker/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-robomaker](#mypy-boto3-robomaker) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [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 it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `RoboMaker`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `RoboMaker` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[robomaker]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[robomaker]' + + +# standalone installation +python -m pip install mypy-boto3-robomaker +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[robomaker]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[robomaker]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. 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 +from boto3.session import Session + +from mypy_boto3_robomaker import RoboMakerClient + +client: RoboMakerClient = Session().client("robomaker") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_robomaker.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +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 = Session().client("robomaker") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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, + ComputeTypeType, + DataSourceTypeType, + 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, + RoboMakerServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ArchitectureType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_robomaker.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_robomaker.type_defs import ( + BatchDeleteWorldsRequestRequestTypeDef, + ResponseMetadataTypeDef, + BatchDescribeSimulationJobRequestRequestTypeDef, + BatchPolicyTypeDef, + CancelDeploymentJobRequestRequestTypeDef, + CancelSimulationJobBatchRequestRequestTypeDef, + CancelSimulationJobRequestRequestTypeDef, + CancelWorldExportJobRequestRequestTypeDef, + CancelWorldGenerationJobRequestRequestTypeDef, + ComputeResponseTypeDef, + ComputeTypeDef, + CreateFleetRequestRequestTypeDef, + EnvironmentTypeDef, + RobotSoftwareSuiteTypeDef, + SourceConfigTypeDef, + SourceTypeDef, + CreateRobotApplicationVersionRequestRequestTypeDef, + CreateRobotRequestRequestTypeDef, + RenderingEngineTypeDef, + SimulationSoftwareSuiteTypeDef, + CreateSimulationApplicationVersionRequestRequestTypeDef, + DataSourceConfigTypeDef, + LoggingConfigTypeDef, + OutputLocationTypeDef, + VPCConfigTypeDef, + VPCConfigResponseTypeDef, + WorldCountTypeDef, + TemplateLocationTypeDef, + S3KeyOutputTypeDef, + DeleteFleetRequestRequestTypeDef, + DeleteRobotApplicationRequestRequestTypeDef, + DeleteRobotRequestRequestTypeDef, + DeleteSimulationApplicationRequestRequestTypeDef, + DeleteWorldTemplateRequestRequestTypeDef, + DeploymentLaunchConfigTypeDef, + S3ObjectTypeDef, + DeregisterRobotRequestRequestTypeDef, + DescribeDeploymentJobRequestRequestTypeDef, + DescribeFleetRequestRequestTypeDef, + RobotTypeDef, + DescribeRobotApplicationRequestRequestTypeDef, + DescribeRobotRequestRequestTypeDef, + DescribeSimulationApplicationRequestRequestTypeDef, + DescribeSimulationJobBatchRequestRequestTypeDef, + SimulationJobSummaryTypeDef, + DescribeSimulationJobRequestRequestTypeDef, + NetworkInterfaceTypeDef, + DescribeWorldExportJobRequestRequestTypeDef, + DescribeWorldGenerationJobRequestRequestTypeDef, + DescribeWorldRequestRequestTypeDef, + DescribeWorldTemplateRequestRequestTypeDef, + WorldFailureTypeDef, + FilterTypeDef, + FleetTypeDef, + GetWorldTemplateBodyRequestRequestTypeDef, + PaginatorConfigTypeDef, + SimulationJobBatchSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListWorldTemplatesRequestRequestTypeDef, + TemplateSummaryTypeDef, + WorldSummaryTypeDef, + PortMappingTypeDef, + ProgressDetailTypeDef, + RegisterRobotRequestRequestTypeDef, + RestartSimulationJobRequestRequestTypeDef, + ToolTypeDef, + UploadConfigurationTypeDef, + WorldConfigTypeDef, + SyncDeploymentJobRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + BatchDeleteWorldsResponseTypeDef, + CreateFleetResponseTypeDef, + CreateRobotResponseTypeDef, + CreateWorldTemplateResponseTypeDef, + DeregisterRobotResponseTypeDef, + DescribeRobotResponseTypeDef, + DescribeWorldResponseTypeDef, + DescribeWorldTemplateResponseTypeDef, + GetWorldTemplateBodyResponseTypeDef, + ListTagsForResourceResponseTypeDef, + RegisterRobotResponseTypeDef, + UpdateWorldTemplateResponseTypeDef, + RobotApplicationSummaryTypeDef, + CreateRobotApplicationRequestRequestTypeDef, + UpdateRobotApplicationRequestRequestTypeDef, + CreateRobotApplicationResponseTypeDef, + CreateRobotApplicationVersionResponseTypeDef, + DescribeRobotApplicationResponseTypeDef, + UpdateRobotApplicationResponseTypeDef, + CreateSimulationApplicationRequestRequestTypeDef, + CreateSimulationApplicationResponseTypeDef, + CreateSimulationApplicationVersionResponseTypeDef, + DescribeSimulationApplicationResponseTypeDef, + SimulationApplicationSummaryTypeDef, + UpdateSimulationApplicationRequestRequestTypeDef, + UpdateSimulationApplicationResponseTypeDef, + CreateWorldExportJobRequestRequestTypeDef, + CreateWorldExportJobResponseTypeDef, + DescribeWorldExportJobResponseTypeDef, + WorldExportJobSummaryTypeDef, + CreateWorldGenerationJobRequestRequestTypeDef, + CreateWorldGenerationJobResponseTypeDef, + WorldGenerationJobSummaryTypeDef, + CreateWorldTemplateRequestRequestTypeDef, + UpdateWorldTemplateRequestRequestTypeDef, + DataSourceTypeDef, + DeploymentApplicationConfigTypeDef, + DeploymentConfigTypeDef, + DescribeFleetResponseTypeDef, + ListRobotsResponseTypeDef, + ListSimulationJobsResponseTypeDef, + FailureSummaryTypeDef, + ListDeploymentJobsRequestRequestTypeDef, + ListFleetsRequestRequestTypeDef, + ListRobotApplicationsRequestRequestTypeDef, + ListRobotsRequestRequestTypeDef, + ListSimulationApplicationsRequestRequestTypeDef, + ListSimulationJobBatchesRequestRequestTypeDef, + ListSimulationJobsRequestRequestTypeDef, + ListWorldExportJobsRequestRequestTypeDef, + ListWorldGenerationJobsRequestRequestTypeDef, + ListWorldsRequestRequestTypeDef, + ListFleetsResponseTypeDef, + ListDeploymentJobsRequestListDeploymentJobsPaginateTypeDef, + ListFleetsRequestListFleetsPaginateTypeDef, + ListRobotApplicationsRequestListRobotApplicationsPaginateTypeDef, + ListRobotsRequestListRobotsPaginateTypeDef, + ListSimulationApplicationsRequestListSimulationApplicationsPaginateTypeDef, + ListSimulationJobBatchesRequestListSimulationJobBatchesPaginateTypeDef, + ListSimulationJobsRequestListSimulationJobsPaginateTypeDef, + ListWorldExportJobsRequestListWorldExportJobsPaginateTypeDef, + ListWorldGenerationJobsRequestListWorldGenerationJobsPaginateTypeDef, + ListWorldTemplatesRequestListWorldTemplatesPaginateTypeDef, + ListWorldsRequestListWorldsPaginateTypeDef, + ListSimulationJobBatchesResponseTypeDef, + ListWorldTemplatesResponseTypeDef, + ListWorldsResponseTypeDef, + PortForwardingConfigTypeDef, + RobotDeploymentTypeDef, + ListRobotApplicationsResponseTypeDef, + ListSimulationApplicationsResponseTypeDef, + ListWorldExportJobsResponseTypeDef, + ListWorldGenerationJobsResponseTypeDef, + CreateDeploymentJobRequestRequestTypeDef, + CreateDeploymentJobResponseTypeDef, + DeploymentJobTypeDef, + SyncDeploymentJobResponseTypeDef, + FinishedWorldsSummaryTypeDef, + LaunchConfigTypeDef, + DescribeDeploymentJobResponseTypeDef, + ListDeploymentJobsResponseTypeDef, + DescribeWorldGenerationJobResponseTypeDef, + RobotApplicationConfigTypeDef, + SimulationApplicationConfigTypeDef, + CreateSimulationJobRequestRequestTypeDef, + CreateSimulationJobResponseTypeDef, + DescribeSimulationJobResponseTypeDef, + SimulationJobRequestTypeDef, + SimulationJobTypeDef, + FailedCreateSimulationJobRequestTypeDef, + StartSimulationJobBatchRequestRequestTypeDef, + BatchDescribeSimulationJobResponseTypeDef, + DescribeSimulationJobBatchResponseTypeDef, + StartSimulationJobBatchResponseTypeDef, +) + + +def get_structure() -> BatchDeleteWorldsRequestRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-robomaker` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_robomaker/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-robomaker +Summary: Type annotations for boto3.RoboMaker 1.26.0 service generated with mypy-boto3-builder 7.11.10 +Provides: python-mypy-boto3-robomaker +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-robomaker +<a id="mypy-boto3-robomaker"></a> + +# mypy-boto3-robomaker + +[](https://pypi.org/project/mypy-boto3-robomaker) +[](https://pypi.org/project/mypy-boto3-robomaker) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-robomaker) + + + +Type annotations for +[boto3.RoboMaker 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/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 7.11.10](https://github.com/youtype/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://youtype.github.io/boto3_stubs_docs/mypy_boto3_robomaker/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-robomaker](#mypy-boto3-robomaker) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [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 it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `RoboMaker`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `RoboMaker` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[robomaker]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[robomaker]' + + +# standalone installation +python -m pip install mypy-boto3-robomaker +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[robomaker]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[robomaker]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. 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 +from boto3.session import Session + +from mypy_boto3_robomaker import RoboMakerClient + +client: RoboMakerClient = Session().client("robomaker") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_robomaker.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +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 = Session().client("robomaker") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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, + ComputeTypeType, + DataSourceTypeType, + 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, + RoboMakerServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ArchitectureType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_robomaker.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_robomaker.type_defs import ( + BatchDeleteWorldsRequestRequestTypeDef, + ResponseMetadataTypeDef, + BatchDescribeSimulationJobRequestRequestTypeDef, + BatchPolicyTypeDef, + CancelDeploymentJobRequestRequestTypeDef, + CancelSimulationJobBatchRequestRequestTypeDef, + CancelSimulationJobRequestRequestTypeDef, + CancelWorldExportJobRequestRequestTypeDef, + CancelWorldGenerationJobRequestRequestTypeDef, + ComputeResponseTypeDef, + ComputeTypeDef, + CreateFleetRequestRequestTypeDef, + EnvironmentTypeDef, + RobotSoftwareSuiteTypeDef, + SourceConfigTypeDef, + SourceTypeDef, + CreateRobotApplicationVersionRequestRequestTypeDef, + CreateRobotRequestRequestTypeDef, + RenderingEngineTypeDef, + SimulationSoftwareSuiteTypeDef, + CreateSimulationApplicationVersionRequestRequestTypeDef, + DataSourceConfigTypeDef, + LoggingConfigTypeDef, + OutputLocationTypeDef, + VPCConfigTypeDef, + VPCConfigResponseTypeDef, + WorldCountTypeDef, + TemplateLocationTypeDef, + S3KeyOutputTypeDef, + DeleteFleetRequestRequestTypeDef, + DeleteRobotApplicationRequestRequestTypeDef, + DeleteRobotRequestRequestTypeDef, + DeleteSimulationApplicationRequestRequestTypeDef, + DeleteWorldTemplateRequestRequestTypeDef, + DeploymentLaunchConfigTypeDef, + S3ObjectTypeDef, + DeregisterRobotRequestRequestTypeDef, + DescribeDeploymentJobRequestRequestTypeDef, + DescribeFleetRequestRequestTypeDef, + RobotTypeDef, + DescribeRobotApplicationRequestRequestTypeDef, + DescribeRobotRequestRequestTypeDef, + DescribeSimulationApplicationRequestRequestTypeDef, + DescribeSimulationJobBatchRequestRequestTypeDef, + SimulationJobSummaryTypeDef, + DescribeSimulationJobRequestRequestTypeDef, + NetworkInterfaceTypeDef, + DescribeWorldExportJobRequestRequestTypeDef, + DescribeWorldGenerationJobRequestRequestTypeDef, + DescribeWorldRequestRequestTypeDef, + DescribeWorldTemplateRequestRequestTypeDef, + WorldFailureTypeDef, + FilterTypeDef, + FleetTypeDef, + GetWorldTemplateBodyRequestRequestTypeDef, + PaginatorConfigTypeDef, + SimulationJobBatchSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListWorldTemplatesRequestRequestTypeDef, + TemplateSummaryTypeDef, + WorldSummaryTypeDef, + PortMappingTypeDef, + ProgressDetailTypeDef, + RegisterRobotRequestRequestTypeDef, + RestartSimulationJobRequestRequestTypeDef, + ToolTypeDef, + UploadConfigurationTypeDef, + WorldConfigTypeDef, + SyncDeploymentJobRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + BatchDeleteWorldsResponseTypeDef, + CreateFleetResponseTypeDef, + CreateRobotResponseTypeDef, + CreateWorldTemplateResponseTypeDef, + DeregisterRobotResponseTypeDef, + DescribeRobotResponseTypeDef, + DescribeWorldResponseTypeDef, + DescribeWorldTemplateResponseTypeDef, + GetWorldTemplateBodyResponseTypeDef, + ListTagsForResourceResponseTypeDef, + RegisterRobotResponseTypeDef, + UpdateWorldTemplateResponseTypeDef, + RobotApplicationSummaryTypeDef, + CreateRobotApplicationRequestRequestTypeDef, + UpdateRobotApplicationRequestRequestTypeDef, + CreateRobotApplicationResponseTypeDef, + CreateRobotApplicationVersionResponseTypeDef, + DescribeRobotApplicationResponseTypeDef, + UpdateRobotApplicationResponseTypeDef, + CreateSimulationApplicationRequestRequestTypeDef, + CreateSimulationApplicationResponseTypeDef, + CreateSimulationApplicationVersionResponseTypeDef, + DescribeSimulationApplicationResponseTypeDef, + SimulationApplicationSummaryTypeDef, + UpdateSimulationApplicationRequestRequestTypeDef, + UpdateSimulationApplicationResponseTypeDef, + CreateWorldExportJobRequestRequestTypeDef, + CreateWorldExportJobResponseTypeDef, + DescribeWorldExportJobResponseTypeDef, + WorldExportJobSummaryTypeDef, + CreateWorldGenerationJobRequestRequestTypeDef, + CreateWorldGenerationJobResponseTypeDef, + WorldGenerationJobSummaryTypeDef, + CreateWorldTemplateRequestRequestTypeDef, + UpdateWorldTemplateRequestRequestTypeDef, + DataSourceTypeDef, + DeploymentApplicationConfigTypeDef, + DeploymentConfigTypeDef, + DescribeFleetResponseTypeDef, + ListRobotsResponseTypeDef, + ListSimulationJobsResponseTypeDef, + FailureSummaryTypeDef, + ListDeploymentJobsRequestRequestTypeDef, + ListFleetsRequestRequestTypeDef, + ListRobotApplicationsRequestRequestTypeDef, + ListRobotsRequestRequestTypeDef, + ListSimulationApplicationsRequestRequestTypeDef, + ListSimulationJobBatchesRequestRequestTypeDef, + ListSimulationJobsRequestRequestTypeDef, + ListWorldExportJobsRequestRequestTypeDef, + ListWorldGenerationJobsRequestRequestTypeDef, + ListWorldsRequestRequestTypeDef, + ListFleetsResponseTypeDef, + ListDeploymentJobsRequestListDeploymentJobsPaginateTypeDef, + ListFleetsRequestListFleetsPaginateTypeDef, + ListRobotApplicationsRequestListRobotApplicationsPaginateTypeDef, + ListRobotsRequestListRobotsPaginateTypeDef, + ListSimulationApplicationsRequestListSimulationApplicationsPaginateTypeDef, + ListSimulationJobBatchesRequestListSimulationJobBatchesPaginateTypeDef, + ListSimulationJobsRequestListSimulationJobsPaginateTypeDef, + ListWorldExportJobsRequestListWorldExportJobsPaginateTypeDef, + ListWorldGenerationJobsRequestListWorldGenerationJobsPaginateTypeDef, + ListWorldTemplatesRequestListWorldTemplatesPaginateTypeDef, + ListWorldsRequestListWorldsPaginateTypeDef, + ListSimulationJobBatchesResponseTypeDef, + ListWorldTemplatesResponseTypeDef, + ListWorldsResponseTypeDef, + PortForwardingConfigTypeDef, + RobotDeploymentTypeDef, + ListRobotApplicationsResponseTypeDef, + ListSimulationApplicationsResponseTypeDef, + ListWorldExportJobsResponseTypeDef, + ListWorldGenerationJobsResponseTypeDef, + CreateDeploymentJobRequestRequestTypeDef, + CreateDeploymentJobResponseTypeDef, + DeploymentJobTypeDef, + SyncDeploymentJobResponseTypeDef, + FinishedWorldsSummaryTypeDef, + LaunchConfigTypeDef, + DescribeDeploymentJobResponseTypeDef, + ListDeploymentJobsResponseTypeDef, + DescribeWorldGenerationJobResponseTypeDef, + RobotApplicationConfigTypeDef, + SimulationApplicationConfigTypeDef, + CreateSimulationJobRequestRequestTypeDef, + CreateSimulationJobResponseTypeDef, + DescribeSimulationJobResponseTypeDef, + SimulationJobRequestTypeDef, + SimulationJobTypeDef, + FailedCreateSimulationJobRequestTypeDef, + StartSimulationJobBatchRequestRequestTypeDef, + BatchDescribeSimulationJobResponseTypeDef, + DescribeSimulationJobBatchResponseTypeDef, + StartSimulationJobBatchResponseTypeDef, +) + + +def get_structure() -> BatchDeleteWorldsRequestRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-robomaker` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_robomaker/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-robomaker +Provides: python3-mypy-boto3-robomaker-doc +%description help +<a id="mypy-boto3-robomaker"></a> + +# mypy-boto3-robomaker + +[](https://pypi.org/project/mypy-boto3-robomaker) +[](https://pypi.org/project/mypy-boto3-robomaker) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-robomaker) + + + +Type annotations for +[boto3.RoboMaker 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/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 7.11.10](https://github.com/youtype/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://youtype.github.io/boto3_stubs_docs/mypy_boto3_robomaker/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-robomaker](#mypy-boto3-robomaker) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [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 it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `RoboMaker`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `RoboMaker` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[robomaker]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[robomaker]' + + +# standalone installation +python -m pip install mypy-boto3-robomaker +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[robomaker]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[robomaker]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[robomaker]` in your environment: + +```bash +python -m pip install 'boto3-stubs[robomaker]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. 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 +from boto3.session import Session + +from mypy_boto3_robomaker import RoboMakerClient + +client: RoboMakerClient = Session().client("robomaker") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_robomaker.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +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 = Session().client("robomaker") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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, + ComputeTypeType, + DataSourceTypeType, + 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, + RoboMakerServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ArchitectureType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_robomaker.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_robomaker.type_defs import ( + BatchDeleteWorldsRequestRequestTypeDef, + ResponseMetadataTypeDef, + BatchDescribeSimulationJobRequestRequestTypeDef, + BatchPolicyTypeDef, + CancelDeploymentJobRequestRequestTypeDef, + CancelSimulationJobBatchRequestRequestTypeDef, + CancelSimulationJobRequestRequestTypeDef, + CancelWorldExportJobRequestRequestTypeDef, + CancelWorldGenerationJobRequestRequestTypeDef, + ComputeResponseTypeDef, + ComputeTypeDef, + CreateFleetRequestRequestTypeDef, + EnvironmentTypeDef, + RobotSoftwareSuiteTypeDef, + SourceConfigTypeDef, + SourceTypeDef, + CreateRobotApplicationVersionRequestRequestTypeDef, + CreateRobotRequestRequestTypeDef, + RenderingEngineTypeDef, + SimulationSoftwareSuiteTypeDef, + CreateSimulationApplicationVersionRequestRequestTypeDef, + DataSourceConfigTypeDef, + LoggingConfigTypeDef, + OutputLocationTypeDef, + VPCConfigTypeDef, + VPCConfigResponseTypeDef, + WorldCountTypeDef, + TemplateLocationTypeDef, + S3KeyOutputTypeDef, + DeleteFleetRequestRequestTypeDef, + DeleteRobotApplicationRequestRequestTypeDef, + DeleteRobotRequestRequestTypeDef, + DeleteSimulationApplicationRequestRequestTypeDef, + DeleteWorldTemplateRequestRequestTypeDef, + DeploymentLaunchConfigTypeDef, + S3ObjectTypeDef, + DeregisterRobotRequestRequestTypeDef, + DescribeDeploymentJobRequestRequestTypeDef, + DescribeFleetRequestRequestTypeDef, + RobotTypeDef, + DescribeRobotApplicationRequestRequestTypeDef, + DescribeRobotRequestRequestTypeDef, + DescribeSimulationApplicationRequestRequestTypeDef, + DescribeSimulationJobBatchRequestRequestTypeDef, + SimulationJobSummaryTypeDef, + DescribeSimulationJobRequestRequestTypeDef, + NetworkInterfaceTypeDef, + DescribeWorldExportJobRequestRequestTypeDef, + DescribeWorldGenerationJobRequestRequestTypeDef, + DescribeWorldRequestRequestTypeDef, + DescribeWorldTemplateRequestRequestTypeDef, + WorldFailureTypeDef, + FilterTypeDef, + FleetTypeDef, + GetWorldTemplateBodyRequestRequestTypeDef, + PaginatorConfigTypeDef, + SimulationJobBatchSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListWorldTemplatesRequestRequestTypeDef, + TemplateSummaryTypeDef, + WorldSummaryTypeDef, + PortMappingTypeDef, + ProgressDetailTypeDef, + RegisterRobotRequestRequestTypeDef, + RestartSimulationJobRequestRequestTypeDef, + ToolTypeDef, + UploadConfigurationTypeDef, + WorldConfigTypeDef, + SyncDeploymentJobRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + BatchDeleteWorldsResponseTypeDef, + CreateFleetResponseTypeDef, + CreateRobotResponseTypeDef, + CreateWorldTemplateResponseTypeDef, + DeregisterRobotResponseTypeDef, + DescribeRobotResponseTypeDef, + DescribeWorldResponseTypeDef, + DescribeWorldTemplateResponseTypeDef, + GetWorldTemplateBodyResponseTypeDef, + ListTagsForResourceResponseTypeDef, + RegisterRobotResponseTypeDef, + UpdateWorldTemplateResponseTypeDef, + RobotApplicationSummaryTypeDef, + CreateRobotApplicationRequestRequestTypeDef, + UpdateRobotApplicationRequestRequestTypeDef, + CreateRobotApplicationResponseTypeDef, + CreateRobotApplicationVersionResponseTypeDef, + DescribeRobotApplicationResponseTypeDef, + UpdateRobotApplicationResponseTypeDef, + CreateSimulationApplicationRequestRequestTypeDef, + CreateSimulationApplicationResponseTypeDef, + CreateSimulationApplicationVersionResponseTypeDef, + DescribeSimulationApplicationResponseTypeDef, + SimulationApplicationSummaryTypeDef, + UpdateSimulationApplicationRequestRequestTypeDef, + UpdateSimulationApplicationResponseTypeDef, + CreateWorldExportJobRequestRequestTypeDef, + CreateWorldExportJobResponseTypeDef, + DescribeWorldExportJobResponseTypeDef, + WorldExportJobSummaryTypeDef, + CreateWorldGenerationJobRequestRequestTypeDef, + CreateWorldGenerationJobResponseTypeDef, + WorldGenerationJobSummaryTypeDef, + CreateWorldTemplateRequestRequestTypeDef, + UpdateWorldTemplateRequestRequestTypeDef, + DataSourceTypeDef, + DeploymentApplicationConfigTypeDef, + DeploymentConfigTypeDef, + DescribeFleetResponseTypeDef, + ListRobotsResponseTypeDef, + ListSimulationJobsResponseTypeDef, + FailureSummaryTypeDef, + ListDeploymentJobsRequestRequestTypeDef, + ListFleetsRequestRequestTypeDef, + ListRobotApplicationsRequestRequestTypeDef, + ListRobotsRequestRequestTypeDef, + ListSimulationApplicationsRequestRequestTypeDef, + ListSimulationJobBatchesRequestRequestTypeDef, + ListSimulationJobsRequestRequestTypeDef, + ListWorldExportJobsRequestRequestTypeDef, + ListWorldGenerationJobsRequestRequestTypeDef, + ListWorldsRequestRequestTypeDef, + ListFleetsResponseTypeDef, + ListDeploymentJobsRequestListDeploymentJobsPaginateTypeDef, + ListFleetsRequestListFleetsPaginateTypeDef, + ListRobotApplicationsRequestListRobotApplicationsPaginateTypeDef, + ListRobotsRequestListRobotsPaginateTypeDef, + ListSimulationApplicationsRequestListSimulationApplicationsPaginateTypeDef, + ListSimulationJobBatchesRequestListSimulationJobBatchesPaginateTypeDef, + ListSimulationJobsRequestListSimulationJobsPaginateTypeDef, + ListWorldExportJobsRequestListWorldExportJobsPaginateTypeDef, + ListWorldGenerationJobsRequestListWorldGenerationJobsPaginateTypeDef, + ListWorldTemplatesRequestListWorldTemplatesPaginateTypeDef, + ListWorldsRequestListWorldsPaginateTypeDef, + ListSimulationJobBatchesResponseTypeDef, + ListWorldTemplatesResponseTypeDef, + ListWorldsResponseTypeDef, + PortForwardingConfigTypeDef, + RobotDeploymentTypeDef, + ListRobotApplicationsResponseTypeDef, + ListSimulationApplicationsResponseTypeDef, + ListWorldExportJobsResponseTypeDef, + ListWorldGenerationJobsResponseTypeDef, + CreateDeploymentJobRequestRequestTypeDef, + CreateDeploymentJobResponseTypeDef, + DeploymentJobTypeDef, + SyncDeploymentJobResponseTypeDef, + FinishedWorldsSummaryTypeDef, + LaunchConfigTypeDef, + DescribeDeploymentJobResponseTypeDef, + ListDeploymentJobsResponseTypeDef, + DescribeWorldGenerationJobResponseTypeDef, + RobotApplicationConfigTypeDef, + SimulationApplicationConfigTypeDef, + CreateSimulationJobRequestRequestTypeDef, + CreateSimulationJobResponseTypeDef, + DescribeSimulationJobResponseTypeDef, + SimulationJobRequestTypeDef, + SimulationJobTypeDef, + FailedCreateSimulationJobRequestTypeDef, + StartSimulationJobBatchRequestRequestTypeDef, + BatchDescribeSimulationJobResponseTypeDef, + DescribeSimulationJobBatchResponseTypeDef, + StartSimulationJobBatchResponseTypeDef, +) + + +def get_structure() -> BatchDeleteWorldsRequestRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-robomaker` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_robomaker/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-robomaker-1.26.0.post1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-robomaker -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.0.post1-1 +- Package Spec generated @@ -0,0 +1 @@ +7a3e8c4a408f293fbf5d54265f192823 mypy-boto3-robomaker-1.26.0.post1.tar.gz |