Type annotations for boto3.RoboMaker 1.14.7 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-robomaker
Type annotations for boto3.RoboMaker 1.14.7 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 RoboMaker
service.
python -m pip install boto3-stubs[robomaker]
How to use
Client annotations
RoboMakerClient
provides annotations for boto3.client("robomaker")
.
import boto3
from mypy_boto3_robomaker import RoboMakerClient
from mypy_boto3_robomaker.paginator import (
ListDeploymentJobsPaginator,
ListFleetsPaginator,
ListRobotApplicationsPaginator,
ListRobotsPaginator,
ListSimulationApplicationsPaginator,
ListSimulationJobBatchesPaginator,
ListSimulationJobsPaginator,
)
from mypy_boto3_robomaker.type_defs import BatchPolicyTypeDef, ...
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")
Paginators annotations
mypy_boto3_robomaker.paginator
module contains type annotations for all paginators.
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")
Typed dictionations
mypy_boto3_robomaker.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BatchPolicyTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_robomaker
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("robomaker")
session_client = boto3.Session().client("robomaker")
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-robomaker-1.14.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d05d6c5b7aa0ce94fc0ef4ca22785f4c5e842cb3ac3de0b57da9f40c441c44d0 |
|
MD5 | 8f8c35e698c14647e03807b5ce3f2fb2 |
|
BLAKE2b-256 | 024d9281d7498f8c9468f3f66adb729598920786b418133ffe135bcb1d2a1400 |
Hashes for mypy_boto3_robomaker-1.14.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8989a5719702336293c886e11bd499ffdec4a99e7b7c8afde0cdf79be7b6b8e8 |
|
MD5 | 548a8f5bb0a7d2dc0e7d855a98ad0cce |
|
BLAKE2b-256 | 4c766c28e09fd1298e65aeb0fa99a4c29f943a8d61a036b34ab927df7520885b |