Type annotations for boto3.Greengrass 1.14.15 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-greengrass
Type annotations for boto3.Greengrass 1.14.15 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 Greengrass
service.
python -m pip install boto3-stubs[greengrass]
How to use
Client annotations
GreengrassClient
provides annotations for boto3.client("greengrass")
.
import boto3
from mypy_boto3_greengrass import GreengrassClient
from mypy_boto3_greengrass.paginator import (
ListBulkDeploymentDetailedReportsPaginator,
ListBulkDeploymentsPaginator,
ListConnectorDefinitionsPaginator,
ListConnectorDefinitionVersionsPaginator,
ListCoreDefinitionsPaginator,
ListCoreDefinitionVersionsPaginator,
ListDeploymentsPaginator,
ListDeviceDefinitionsPaginator,
ListDeviceDefinitionVersionsPaginator,
ListFunctionDefinitionsPaginator,
ListFunctionDefinitionVersionsPaginator,
ListGroupsPaginator,
ListGroupVersionsPaginator,
ListLoggerDefinitionsPaginator,
ListLoggerDefinitionVersionsPaginator,
ListResourceDefinitionsPaginator,
ListResourceDefinitionVersionsPaginator,
ListSubscriptionDefinitionsPaginator,
ListSubscriptionDefinitionVersionsPaginator,
)
from mypy_boto3_greengrass.type_defs import BulkDeploymentMetricsTypeDef, ...
client: GreengrassClient = boto3.client("greengrass")
# 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: GreengrassClient = session.client("greengrass")
Paginators annotations
mypy_boto3_greengrass.paginator
module contains type annotations for all paginators.
client: GreengrassClient = boto3.client("greengrass")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_bulk_deployment_detailed_reports_paginator: ListBulkDeploymentDetailedReportsPaginator = client.get_paginator("list_bulk_deployment_detailed_reports")
list_bulk_deployments_paginator: ListBulkDeploymentsPaginator = client.get_paginator("list_bulk_deployments")
list_connector_definition_versions_paginator: ListConnectorDefinitionVersionsPaginator = client.get_paginator("list_connector_definition_versions")
list_connector_definitions_paginator: ListConnectorDefinitionsPaginator = client.get_paginator("list_connector_definitions")
list_core_definition_versions_paginator: ListCoreDefinitionVersionsPaginator = client.get_paginator("list_core_definition_versions")
list_core_definitions_paginator: ListCoreDefinitionsPaginator = client.get_paginator("list_core_definitions")
list_deployments_paginator: ListDeploymentsPaginator = client.get_paginator("list_deployments")
list_device_definition_versions_paginator: ListDeviceDefinitionVersionsPaginator = client.get_paginator("list_device_definition_versions")
list_device_definitions_paginator: ListDeviceDefinitionsPaginator = client.get_paginator("list_device_definitions")
list_function_definition_versions_paginator: ListFunctionDefinitionVersionsPaginator = client.get_paginator("list_function_definition_versions")
list_function_definitions_paginator: ListFunctionDefinitionsPaginator = client.get_paginator("list_function_definitions")
list_group_versions_paginator: ListGroupVersionsPaginator = client.get_paginator("list_group_versions")
list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups")
list_logger_definition_versions_paginator: ListLoggerDefinitionVersionsPaginator = client.get_paginator("list_logger_definition_versions")
list_logger_definitions_paginator: ListLoggerDefinitionsPaginator = client.get_paginator("list_logger_definitions")
list_resource_definition_versions_paginator: ListResourceDefinitionVersionsPaginator = client.get_paginator("list_resource_definition_versions")
list_resource_definitions_paginator: ListResourceDefinitionsPaginator = client.get_paginator("list_resource_definitions")
list_subscription_definition_versions_paginator: ListSubscriptionDefinitionVersionsPaginator = client.get_paginator("list_subscription_definition_versions")
list_subscription_definitions_paginator: ListSubscriptionDefinitionsPaginator = client.get_paginator("list_subscription_definitions")
Typed dictionations
mypy_boto3_greengrass.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BulkDeploymentMetricsTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_greengrass
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("greengrass")
session_client = boto3.Session().client("greengrass")
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-greengrass-1.14.15.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c41b85c6a4caf607d61676f34031de41115125f6650f3831c6d9d797604fa67 |
|
MD5 | 0034e03ee9c53510651d698021a8037e |
|
BLAKE2b-256 | df0655cb72cdf4d4768c31412b545ffb62d41f2ca1c4ac3222f16d97d0b9bfe1 |
Hashes for mypy_boto3_greengrass-1.14.15.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fa71e4b8205acceb0d4352e4f6e26a31d37b5086acdeb6b79336e4f36239c6c |
|
MD5 | 42354cc9d99ec45b1156db1afde07a70 |
|
BLAKE2b-256 | 666fb7b614544438471b5f6ad50dd83b5544e5c4baf5b9403d268eea30768902 |