Type annotations for boto3.Cloud9 1.14.6 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-cloud9
Type annotations for boto3.Cloud9 1.14.6 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 Cloud9
service.
python -m pip install boto3-stubs[cloud9]
How to use
Client annotations
Cloud9Client
provides annotations for boto3.client("cloud9")
.
import boto3
from mypy_boto3_cloud9 import Cloud9Client
from mypy_boto3_cloud9.paginator import (
DescribeEnvironmentMembershipsPaginator,
ListEnvironmentsPaginator,
)
from mypy_boto3_cloud9.type_defs import EnvironmentLifecycleTypeDef, ...
client: Cloud9Client = boto3.client("cloud9")
# 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: Cloud9Client = session.client("cloud9")
Paginators annotations
mypy_boto3_cloud9.paginator
module contains type annotations for all paginators.
client: Cloud9Client = boto3.client("cloud9")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_environment_memberships_paginator: DescribeEnvironmentMembershipsPaginator = client.get_paginator("describe_environment_memberships")
list_environments_paginator: ListEnvironmentsPaginator = client.get_paginator("list_environments")
Typed dictionations
mypy_boto3_cloud9.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> EnvironmentLifecycleTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_cloud9
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("cloud9")
session_client = boto3.Session().client("cloud9")
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-cloud9-1.14.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebf3c3bb4b01c187106d0ad2416c517ce874e4c1650538e501a822598a783560 |
|
MD5 | 2d0a597b96e037edb9a5a599a2e732cb |
|
BLAKE2b-256 | 3df238ae9b9ccf905cc064f27a35f6e7031195904fde35a6f62c9af9b4def6b9 |
Hashes for mypy_boto3_cloud9-1.14.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16bb23925445a374212ace2611494b0978e4fa5658012462b6fb02bdcaa47e58 |
|
MD5 | cf6270df1f42b0606dceac04d91040eb |
|
BLAKE2b-256 | 2b9951be981d8fab72bd36b9d76624f96b5454c4f88ca6ab57643f6473b8d28c |