Type annotations for boto3.ElasticBeanstalk 1.14.5 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-elasticbeanstalk
Type annotations for boto3.ElasticBeanstalk 1.14.5 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 ElasticBeanstalk
service.
python -m pip install boto3-stubs[elasticbeanstalk]
How to use
Client annotations
ElasticBeanstalkClient
provides annotations for boto3.client("elasticbeanstalk")
.
import boto3
from mypy_boto3_elasticbeanstalk import ElasticBeanstalkClient
from mypy_boto3_elasticbeanstalk.paginator import (
DescribeApplicationVersionsPaginator,
DescribeEnvironmentManagedActionHistoryPaginator,
DescribeEnvironmentsPaginator,
DescribeEventsPaginator,
ListPlatformVersionsPaginator,
)
from mypy_boto3_elasticbeanstalk.type_defs import ApplicationDescriptionTypeDef, ...
client: ElasticBeanstalkClient = boto3.client("elasticbeanstalk")
# 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: ElasticBeanstalkClient = session.client("elasticbeanstalk")
Paginators annotations
mypy_boto3_elasticbeanstalk.paginator
module contains type annotations for all paginators.
client: ElasticBeanstalkClient = boto3.client("elasticbeanstalk")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_application_versions_paginator: DescribeApplicationVersionsPaginator = client.get_paginator("describe_application_versions")
describe_environment_managed_action_history_paginator: DescribeEnvironmentManagedActionHistoryPaginator = client.get_paginator("describe_environment_managed_action_history")
describe_environments_paginator: DescribeEnvironmentsPaginator = client.get_paginator("describe_environments")
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
list_platform_versions_paginator: ListPlatformVersionsPaginator = client.get_paginator("list_platform_versions")
Typed dictionations
mypy_boto3_elasticbeanstalk.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ApplicationDescriptionTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_elasticbeanstalk
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("elasticbeanstalk")
session_client = boto3.Session().client("elasticbeanstalk")
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-elasticbeanstalk-1.14.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20003c9350cf1b2db1b4007161946547fb70f40aaa5be77ba27605742b0b0443 |
|
MD5 | c9d808041195090471d460915cc2c123 |
|
BLAKE2b-256 | 92c871d38b7f788e3a3655790ecdb8eb3824943223ea196e4ba59252af0420d9 |
Hashes for mypy_boto3_elasticbeanstalk-1.14.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 754f0ec687582e4a961688e43ff6e540d8d2b585dbe32773c255e919db45da9c |
|
MD5 | 3dca24daf8ee3a4630a591b57dec515e |
|
BLAKE2b-256 | 879447ec0b6a24405b91e87a424541bf89c314b62bd501b665230d7591ad7e6e |