Type annotations for boto3.ElasticsearchService 1.13.24 service, generated by mypy-boto3-buider 2.0.2
Project description
mypy-boto3-es
Type annotations for boto3.ElasticsearchService 1.13.24 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.2.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ElasticsearchService
service.
python -m pip install boto3-stubs[es]
# update installed packages index for automated type discovery
python -m mypy_boto3
Use boto3
with mypy_boto3_es
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_es import ElasticsearchServiceClient
# Now mypy can check if your code is valid.
client: ElasticsearchServiceClient = boto3.client("es")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ElasticsearchServiceClient = session.client("es")
# Annotated paginators are included as well
import mypy_boto3_es.paginator as es_paginators
describe_reserved_elasticsearch_instance_offerings_paginator: es_paginators.DescribeReservedElasticsearchInstanceOfferingsPaginator = client.get_paginator("describe_reserved_elasticsearch_instance_offerings")
describe_reserved_elasticsearch_instances_paginator: es_paginators.DescribeReservedElasticsearchInstancesPaginator = client.get_paginator("describe_reserved_elasticsearch_instances")
get_upgrade_history_paginator: es_paginators.GetUpgradeHistoryPaginator = client.get_paginator("get_upgrade_history")
list_elasticsearch_instance_types_paginator: es_paginators.ListElasticsearchInstanceTypesPaginator = client.get_paginator("list_elasticsearch_instance_types")
list_elasticsearch_versions_paginator: es_paginators.ListElasticsearchVersionsPaginator = client.get_paginator("list_elasticsearch_versions")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_es
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
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 carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_es as es
from mypy_boto3_es import ElasticsearchServiceClient
# with these
from mypy_boto3 import es
from mypy_boto3.es import ElasticsearchServiceClient
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_es-1.13.24.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15aafd9419beffd1909e7264a96e8d92fa377ddcbc750a95015de0cdcb690855 |
|
MD5 | b1bd5c7b437860ded7452f5d2107c068 |
|
BLAKE2b-256 | 285412534321df4a0e881eff6d33be0b7e4a612324699db5305ee634ccf91bbb |