Type annotations for boto3.Athena 1.14.0 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-athena
Type annotations for boto3.Athena 1.14.0 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 Athena
service.
python -m pip install boto3-stubs[athena]
How to use
Client annotations
AthenaClient
provides annotations for boto3.client("athena")
.
import boto3
from mypy_boto3_athena import AthenaClient
from mypy_boto3_athena.paginator import (
GetQueryResultsPaginator,
ListDatabasesPaginator,
ListDataCatalogsPaginator,
ListNamedQueriesPaginator,
ListQueryExecutionsPaginator,
ListTableMetadataPaginator,
ListTagsForResourcePaginator,
)
from mypy_boto3_athena.type_defs import ColumnInfoTypeDef, ...
client: AthenaClient = boto3.client("athena")
# 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: AthenaClient = session.client("athena")
Paginators annotations
mypy_boto3_athena.paginator
module contains type annotations for all paginators.
client: AthenaClient = boto3.client("athena")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_query_results_paginator: GetQueryResultsPaginator = client.get_paginator("get_query_results")
list_data_catalogs_paginator: ListDataCatalogsPaginator = client.get_paginator("list_data_catalogs")
list_databases_paginator: ListDatabasesPaginator = client.get_paginator("list_databases")
list_named_queries_paginator: ListNamedQueriesPaginator = client.get_paginator("list_named_queries")
list_query_executions_paginator: ListQueryExecutionsPaginator = client.get_paginator("list_query_executions")
list_table_metadata_paginator: ListTableMetadataPaginator = client.get_paginator("list_table_metadata")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
Typed dictionations
mypy_boto3_athena.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ColumnInfoTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_athena
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("athena")
session_client = boto3.Session().client("athena")
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-athena-1.14.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c782d8791202b6a68b31de5844ab7673a79e2e25ea6f5cad79e89d9349f31ca |
|
MD5 | b67e473e26024f4bb1458437b1e0f2f8 |
|
BLAKE2b-256 | d8d0a1831e1b5c2599aac02e296e8055d31c9da2fe86a75d3ee9fe5394cb4190 |
Hashes for mypy_boto3_athena-1.14.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f986546fc70aad006be2642c8e20a97745519983b9963aed9a2d23f7449e0f41 |
|
MD5 | 0436e647845492d1d41c2e7c964f9b19 |
|
BLAKE2b-256 | 88c2298753a7ea1cfdbf2e51407e510b8cc8e8dd9e9820a30e6593e169a165b2 |