Type annotations for boto3.ResourceGroups 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-resource-groups
Type annotations for boto3.ResourceGroups 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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 ResourceGroups
service.
python -m pip install boto3-stubs[resource-groups]
How to use
Client annotations
ResourceGroupsClient
provides annotations for boto3.client("resource-groups")
.
import boto3
from mypy_boto3_resource_groups import ResourceGroupsClient
client: ResourceGroupsClient = boto3.client("resource-groups")
# 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: ResourceGroupsClient = session.client("resource-groups")
Paginators annotations
mypy_boto3_resource_groups.paginator
module contains type annotations for all paginators.
from mypy_boto3_resource_groups import ResourceGroupsClient
from mypy_boto3_resource_groups.paginator import (
ListGroupResourcesPaginator,
ListGroupsPaginator,
SearchResourcesPaginator,
)
client: ResourceGroupsClient = boto3.client("resource-groups")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_group_resources_paginator: ListGroupResourcesPaginator = client.get_paginator("list_group_resources")
list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups")
search_resources_paginator: SearchResourcesPaginator = client.get_paginator("search_resources")
Typed dictionations
mypy_boto3_resource_groups.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_resource_groups.type_defs import GroupIdentifierTypeDef, ...
def get_structure() -> GroupIdentifierTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_resource_groups
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
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("resource-groups")
session_client = boto3.Session().client("resource-groups")
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-resource-groups-1.14.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4d818147a138e07b43bd42db6289e213035982aeeea4a2287496137e401a4de |
|
MD5 | cc59db28c92afe3885cdaf6b5a90a5bd |
|
BLAKE2b-256 | 43aff4d6e15e7264c3edf1d831b772e95065a76b7a442f1e381339270236614c |
Hashes for mypy_boto3_resource_groups-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a20a7c4a7fba5c6d011a69bf845b1ce16873a349c952a68ed61bae840b77d71 |
|
MD5 | d1db606d67526cb09638dbffdb2f7b6c |
|
BLAKE2b-256 | a4cb92f27bf64d4bb48680984b2a50ac3582613532286e6c2cf6a6aeb285b0c3 |