diff options
author | CoprDistGit <infra@openeuler.org> | 2023-04-11 02:51:15 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 02:51:15 +0000 |
commit | 7a88fc09b08d1c5b4601c1c039580ffee9f47e6b (patch) | |
tree | b4be97637e3e8fb7a6c38c8d1810f60cd3f3e004 | |
parent | 44ebf5d1980687120e2cba0185ce89fcdb48aaec (diff) |
automatic import of python-mypy-boto3-athena
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-mypy-boto3-athena.spec | 1837 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 1839 insertions, 0 deletions
@@ -0,0 +1 @@ +/mypy-boto3-athena-1.26.103.tar.gz diff --git a/python-mypy-boto3-athena.spec b/python-mypy-boto3-athena.spec new file mode 100644 index 0000000..517bba8 --- /dev/null +++ b/python-mypy-boto3-athena.spec @@ -0,0 +1,1837 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-athena +Version: 1.26.103 +Release: 1 +Summary: Type annotations for boto3.Athena 1.26.103 service generated with mypy-boto3-builder 7.14.4 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/13/55/89483bf64e02b5486bb6622922cff5b66706afc027b45d38192f142f6f9a/mypy-boto3-athena-1.26.103.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-athena"></a> + +# mypy-boto3-athena + +[](https://pypi.org/project/mypy-boto3-athena) +[](https://pypi.org/project/mypy-boto3-athena) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/) +[](https://pypistats.org/packages/mypy-boto3-athena) + + + +Type annotations for +[boto3.Athena 1.26.103](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.14.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-athena docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-athena](#mypy-boto3-athena) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Athena`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Athena` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[athena]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[athena]' + + +# standalone installation +python -m pip install mypy-boto3-athena +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-athena +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[athena]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[athena]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`AthenaClient` provides annotations for `boto3.client("athena")`. + +```python +from boto3.session import Session + +from mypy_boto3_athena import AthenaClient + +client: AthenaClient = Session().client("athena") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_athena.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_athena import AthenaClient +from mypy_boto3_athena.paginator import ( + GetQueryResultsPaginator, + ListDataCatalogsPaginator, + ListDatabasesPaginator, + ListNamedQueriesPaginator, + ListQueryExecutionsPaginator, + ListTableMetadataPaginator, + ListTagsForResourcePaginator, +) + +client: AthenaClient = Session().client("athena") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_athena.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_athena.literals import ( + CalculationExecutionStateType, + ColumnNullableType, + DataCatalogTypeType, + EncryptionOptionType, + ExecutorStateType, + ExecutorTypeType, + GetQueryResultsPaginatorName, + ListDataCatalogsPaginatorName, + ListDatabasesPaginatorName, + ListNamedQueriesPaginatorName, + ListQueryExecutionsPaginatorName, + ListTableMetadataPaginatorName, + ListTagsForResourcePaginatorName, + NotebookTypeType, + QueryExecutionStateType, + S3AclOptionType, + SessionStateType, + StatementTypeType, + WorkGroupStateType, + AthenaServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: CalculationExecutionStateType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_athena.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_athena.type_defs import ( + AclConfigurationTypeDef, + ApplicationDPUSizesTypeDef, + AthenaErrorTypeDef, + BatchGetNamedQueryInputRequestTypeDef, + NamedQueryTypeDef, + ResponseMetadataTypeDef, + UnprocessedNamedQueryIdTypeDef, + BatchGetPreparedStatementInputRequestTypeDef, + PreparedStatementTypeDef, + UnprocessedPreparedStatementNameTypeDef, + BatchGetQueryExecutionInputRequestTypeDef, + UnprocessedQueryExecutionIdTypeDef, + CalculationConfigurationTypeDef, + CalculationResultTypeDef, + CalculationStatisticsTypeDef, + CalculationStatusTypeDef, + ColumnInfoTypeDef, + ColumnTypeDef, + TagTypeDef, + CreateNamedQueryInputRequestTypeDef, + CreateNotebookInputRequestTypeDef, + CreatePreparedStatementInputRequestTypeDef, + CreatePresignedNotebookUrlRequestRequestTypeDef, + CustomerContentEncryptionConfigurationTypeDef, + DataCatalogSummaryTypeDef, + DataCatalogTypeDef, + DatabaseTypeDef, + DatumTypeDef, + DeleteDataCatalogInputRequestTypeDef, + DeleteNamedQueryInputRequestTypeDef, + DeleteNotebookInputRequestTypeDef, + DeletePreparedStatementInputRequestTypeDef, + DeleteWorkGroupInputRequestTypeDef, + EncryptionConfigurationTypeDef, + EngineConfigurationTypeDef, + EngineVersionTypeDef, + ExecutorsSummaryTypeDef, + ExportNotebookInputRequestTypeDef, + NotebookMetadataTypeDef, + FilterDefinitionTypeDef, + GetCalculationExecutionCodeRequestRequestTypeDef, + GetCalculationExecutionRequestRequestTypeDef, + GetCalculationExecutionStatusRequestRequestTypeDef, + GetDataCatalogInputRequestTypeDef, + GetDatabaseInputRequestTypeDef, + GetNamedQueryInputRequestTypeDef, + GetNotebookMetadataInputRequestTypeDef, + GetPreparedStatementInputRequestTypeDef, + GetQueryExecutionInputRequestTypeDef, + PaginatorConfigTypeDef, + GetQueryResultsInputRequestTypeDef, + GetQueryRuntimeStatisticsInputRequestTypeDef, + GetSessionRequestRequestTypeDef, + SessionStatisticsTypeDef, + SessionStatusTypeDef, + GetSessionStatusRequestRequestTypeDef, + GetTableMetadataInputRequestTypeDef, + GetWorkGroupInputRequestTypeDef, + ImportNotebookInputRequestTypeDef, + ListApplicationDPUSizesInputRequestTypeDef, + ListCalculationExecutionsRequestRequestTypeDef, + ListDataCatalogsInputRequestTypeDef, + ListDatabasesInputRequestTypeDef, + ListEngineVersionsInputRequestTypeDef, + ListExecutorsRequestRequestTypeDef, + ListNamedQueriesInputRequestTypeDef, + ListNotebookSessionsRequestRequestTypeDef, + NotebookSessionSummaryTypeDef, + ListPreparedStatementsInputRequestTypeDef, + PreparedStatementSummaryTypeDef, + ListQueryExecutionsInputRequestTypeDef, + ListSessionsRequestRequestTypeDef, + ListTableMetadataInputRequestTypeDef, + ListTagsForResourceInputRequestTypeDef, + ListWorkGroupsInputRequestTypeDef, + QueryExecutionContextTypeDef, + ResultReuseInformationTypeDef, + QueryRuntimeStatisticsRowsTypeDef, + QueryRuntimeStatisticsTimelineTypeDef, + QueryStagePlanNodeTypeDef, + QueryStageTypeDef, + ResultReuseByAgeConfigurationTypeDef, + StopCalculationExecutionRequestRequestTypeDef, + StopQueryExecutionInputRequestTypeDef, + TerminateSessionRequestRequestTypeDef, + UntagResourceInputRequestTypeDef, + UpdateDataCatalogInputRequestTypeDef, + UpdateNamedQueryInputRequestTypeDef, + UpdateNotebookInputRequestTypeDef, + UpdateNotebookMetadataInputRequestTypeDef, + UpdatePreparedStatementInputRequestTypeDef, + QueryExecutionStatusTypeDef, + CreateNamedQueryOutputTypeDef, + CreateNotebookOutputTypeDef, + CreatePresignedNotebookUrlResponseTypeDef, + GetCalculationExecutionCodeResponseTypeDef, + GetNamedQueryOutputTypeDef, + ImportNotebookOutputTypeDef, + ListApplicationDPUSizesOutputTypeDef, + ListNamedQueriesOutputTypeDef, + ListQueryExecutionsOutputTypeDef, + StartCalculationExecutionResponseTypeDef, + StartQueryExecutionOutputTypeDef, + StartSessionResponseTypeDef, + StopCalculationExecutionResponseTypeDef, + TerminateSessionResponseTypeDef, + BatchGetNamedQueryOutputTypeDef, + GetPreparedStatementOutputTypeDef, + BatchGetPreparedStatementOutputTypeDef, + StartCalculationExecutionRequestRequestTypeDef, + CalculationSummaryTypeDef, + GetCalculationExecutionResponseTypeDef, + GetCalculationExecutionStatusResponseTypeDef, + ResultSetMetadataTypeDef, + TableMetadataTypeDef, + CreateDataCatalogInputRequestTypeDef, + ListTagsForResourceOutputTypeDef, + TagResourceInputRequestTypeDef, + ListDataCatalogsOutputTypeDef, + GetDataCatalogOutputTypeDef, + GetDatabaseOutputTypeDef, + ListDatabasesOutputTypeDef, + RowTypeDef, + ResultConfigurationTypeDef, + ResultConfigurationUpdatesTypeDef, + SessionConfigurationTypeDef, + StartSessionRequestRequestTypeDef, + ListEngineVersionsOutputTypeDef, + WorkGroupSummaryTypeDef, + ListExecutorsResponseTypeDef, + ExportNotebookOutputTypeDef, + GetNotebookMetadataOutputTypeDef, + ListNotebookMetadataOutputTypeDef, + ListNotebookMetadataInputRequestTypeDef, + GetQueryResultsInputGetQueryResultsPaginateTypeDef, + ListDataCatalogsInputListDataCatalogsPaginateTypeDef, + ListDatabasesInputListDatabasesPaginateTypeDef, + ListNamedQueriesInputListNamedQueriesPaginateTypeDef, + ListQueryExecutionsInputListQueryExecutionsPaginateTypeDef, + ListTableMetadataInputListTableMetadataPaginateTypeDef, + ListTagsForResourceInputListTagsForResourcePaginateTypeDef, + GetSessionStatusResponseTypeDef, + SessionSummaryTypeDef, + ListNotebookSessionsResponseTypeDef, + ListPreparedStatementsOutputTypeDef, + QueryExecutionStatisticsTypeDef, + QueryRuntimeStatisticsTypeDef, + ResultReuseConfigurationTypeDef, + ListCalculationExecutionsResponseTypeDef, + GetTableMetadataOutputTypeDef, + ListTableMetadataOutputTypeDef, + ResultSetTypeDef, + WorkGroupConfigurationTypeDef, + WorkGroupConfigurationUpdatesTypeDef, + GetSessionResponseTypeDef, + ListWorkGroupsOutputTypeDef, + ListSessionsResponseTypeDef, + GetQueryRuntimeStatisticsOutputTypeDef, + QueryExecutionTypeDef, + StartQueryExecutionInputRequestTypeDef, + GetQueryResultsOutputTypeDef, + CreateWorkGroupInputRequestTypeDef, + WorkGroupTypeDef, + UpdateWorkGroupInputRequestTypeDef, + BatchGetQueryExecutionOutputTypeDef, + GetQueryExecutionOutputTypeDef, + GetWorkGroupOutputTypeDef, +) + + +def get_structure() -> AclConfigurationTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from `botocore` schemas. +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-athena` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-athena +Summary: Type annotations for boto3.Athena 1.26.103 service generated with mypy-boto3-builder 7.14.4 +Provides: python-mypy-boto3-athena +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-athena +<a id="mypy-boto3-athena"></a> + +# mypy-boto3-athena + +[](https://pypi.org/project/mypy-boto3-athena) +[](https://pypi.org/project/mypy-boto3-athena) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/) +[](https://pypistats.org/packages/mypy-boto3-athena) + + + +Type annotations for +[boto3.Athena 1.26.103](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.14.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-athena docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-athena](#mypy-boto3-athena) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Athena`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Athena` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[athena]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[athena]' + + +# standalone installation +python -m pip install mypy-boto3-athena +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-athena +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[athena]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[athena]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`AthenaClient` provides annotations for `boto3.client("athena")`. + +```python +from boto3.session import Session + +from mypy_boto3_athena import AthenaClient + +client: AthenaClient = Session().client("athena") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_athena.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_athena import AthenaClient +from mypy_boto3_athena.paginator import ( + GetQueryResultsPaginator, + ListDataCatalogsPaginator, + ListDatabasesPaginator, + ListNamedQueriesPaginator, + ListQueryExecutionsPaginator, + ListTableMetadataPaginator, + ListTagsForResourcePaginator, +) + +client: AthenaClient = Session().client("athena") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_athena.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_athena.literals import ( + CalculationExecutionStateType, + ColumnNullableType, + DataCatalogTypeType, + EncryptionOptionType, + ExecutorStateType, + ExecutorTypeType, + GetQueryResultsPaginatorName, + ListDataCatalogsPaginatorName, + ListDatabasesPaginatorName, + ListNamedQueriesPaginatorName, + ListQueryExecutionsPaginatorName, + ListTableMetadataPaginatorName, + ListTagsForResourcePaginatorName, + NotebookTypeType, + QueryExecutionStateType, + S3AclOptionType, + SessionStateType, + StatementTypeType, + WorkGroupStateType, + AthenaServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: CalculationExecutionStateType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_athena.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_athena.type_defs import ( + AclConfigurationTypeDef, + ApplicationDPUSizesTypeDef, + AthenaErrorTypeDef, + BatchGetNamedQueryInputRequestTypeDef, + NamedQueryTypeDef, + ResponseMetadataTypeDef, + UnprocessedNamedQueryIdTypeDef, + BatchGetPreparedStatementInputRequestTypeDef, + PreparedStatementTypeDef, + UnprocessedPreparedStatementNameTypeDef, + BatchGetQueryExecutionInputRequestTypeDef, + UnprocessedQueryExecutionIdTypeDef, + CalculationConfigurationTypeDef, + CalculationResultTypeDef, + CalculationStatisticsTypeDef, + CalculationStatusTypeDef, + ColumnInfoTypeDef, + ColumnTypeDef, + TagTypeDef, + CreateNamedQueryInputRequestTypeDef, + CreateNotebookInputRequestTypeDef, + CreatePreparedStatementInputRequestTypeDef, + CreatePresignedNotebookUrlRequestRequestTypeDef, + CustomerContentEncryptionConfigurationTypeDef, + DataCatalogSummaryTypeDef, + DataCatalogTypeDef, + DatabaseTypeDef, + DatumTypeDef, + DeleteDataCatalogInputRequestTypeDef, + DeleteNamedQueryInputRequestTypeDef, + DeleteNotebookInputRequestTypeDef, + DeletePreparedStatementInputRequestTypeDef, + DeleteWorkGroupInputRequestTypeDef, + EncryptionConfigurationTypeDef, + EngineConfigurationTypeDef, + EngineVersionTypeDef, + ExecutorsSummaryTypeDef, + ExportNotebookInputRequestTypeDef, + NotebookMetadataTypeDef, + FilterDefinitionTypeDef, + GetCalculationExecutionCodeRequestRequestTypeDef, + GetCalculationExecutionRequestRequestTypeDef, + GetCalculationExecutionStatusRequestRequestTypeDef, + GetDataCatalogInputRequestTypeDef, + GetDatabaseInputRequestTypeDef, + GetNamedQueryInputRequestTypeDef, + GetNotebookMetadataInputRequestTypeDef, + GetPreparedStatementInputRequestTypeDef, + GetQueryExecutionInputRequestTypeDef, + PaginatorConfigTypeDef, + GetQueryResultsInputRequestTypeDef, + GetQueryRuntimeStatisticsInputRequestTypeDef, + GetSessionRequestRequestTypeDef, + SessionStatisticsTypeDef, + SessionStatusTypeDef, + GetSessionStatusRequestRequestTypeDef, + GetTableMetadataInputRequestTypeDef, + GetWorkGroupInputRequestTypeDef, + ImportNotebookInputRequestTypeDef, + ListApplicationDPUSizesInputRequestTypeDef, + ListCalculationExecutionsRequestRequestTypeDef, + ListDataCatalogsInputRequestTypeDef, + ListDatabasesInputRequestTypeDef, + ListEngineVersionsInputRequestTypeDef, + ListExecutorsRequestRequestTypeDef, + ListNamedQueriesInputRequestTypeDef, + ListNotebookSessionsRequestRequestTypeDef, + NotebookSessionSummaryTypeDef, + ListPreparedStatementsInputRequestTypeDef, + PreparedStatementSummaryTypeDef, + ListQueryExecutionsInputRequestTypeDef, + ListSessionsRequestRequestTypeDef, + ListTableMetadataInputRequestTypeDef, + ListTagsForResourceInputRequestTypeDef, + ListWorkGroupsInputRequestTypeDef, + QueryExecutionContextTypeDef, + ResultReuseInformationTypeDef, + QueryRuntimeStatisticsRowsTypeDef, + QueryRuntimeStatisticsTimelineTypeDef, + QueryStagePlanNodeTypeDef, + QueryStageTypeDef, + ResultReuseByAgeConfigurationTypeDef, + StopCalculationExecutionRequestRequestTypeDef, + StopQueryExecutionInputRequestTypeDef, + TerminateSessionRequestRequestTypeDef, + UntagResourceInputRequestTypeDef, + UpdateDataCatalogInputRequestTypeDef, + UpdateNamedQueryInputRequestTypeDef, + UpdateNotebookInputRequestTypeDef, + UpdateNotebookMetadataInputRequestTypeDef, + UpdatePreparedStatementInputRequestTypeDef, + QueryExecutionStatusTypeDef, + CreateNamedQueryOutputTypeDef, + CreateNotebookOutputTypeDef, + CreatePresignedNotebookUrlResponseTypeDef, + GetCalculationExecutionCodeResponseTypeDef, + GetNamedQueryOutputTypeDef, + ImportNotebookOutputTypeDef, + ListApplicationDPUSizesOutputTypeDef, + ListNamedQueriesOutputTypeDef, + ListQueryExecutionsOutputTypeDef, + StartCalculationExecutionResponseTypeDef, + StartQueryExecutionOutputTypeDef, + StartSessionResponseTypeDef, + StopCalculationExecutionResponseTypeDef, + TerminateSessionResponseTypeDef, + BatchGetNamedQueryOutputTypeDef, + GetPreparedStatementOutputTypeDef, + BatchGetPreparedStatementOutputTypeDef, + StartCalculationExecutionRequestRequestTypeDef, + CalculationSummaryTypeDef, + GetCalculationExecutionResponseTypeDef, + GetCalculationExecutionStatusResponseTypeDef, + ResultSetMetadataTypeDef, + TableMetadataTypeDef, + CreateDataCatalogInputRequestTypeDef, + ListTagsForResourceOutputTypeDef, + TagResourceInputRequestTypeDef, + ListDataCatalogsOutputTypeDef, + GetDataCatalogOutputTypeDef, + GetDatabaseOutputTypeDef, + ListDatabasesOutputTypeDef, + RowTypeDef, + ResultConfigurationTypeDef, + ResultConfigurationUpdatesTypeDef, + SessionConfigurationTypeDef, + StartSessionRequestRequestTypeDef, + ListEngineVersionsOutputTypeDef, + WorkGroupSummaryTypeDef, + ListExecutorsResponseTypeDef, + ExportNotebookOutputTypeDef, + GetNotebookMetadataOutputTypeDef, + ListNotebookMetadataOutputTypeDef, + ListNotebookMetadataInputRequestTypeDef, + GetQueryResultsInputGetQueryResultsPaginateTypeDef, + ListDataCatalogsInputListDataCatalogsPaginateTypeDef, + ListDatabasesInputListDatabasesPaginateTypeDef, + ListNamedQueriesInputListNamedQueriesPaginateTypeDef, + ListQueryExecutionsInputListQueryExecutionsPaginateTypeDef, + ListTableMetadataInputListTableMetadataPaginateTypeDef, + ListTagsForResourceInputListTagsForResourcePaginateTypeDef, + GetSessionStatusResponseTypeDef, + SessionSummaryTypeDef, + ListNotebookSessionsResponseTypeDef, + ListPreparedStatementsOutputTypeDef, + QueryExecutionStatisticsTypeDef, + QueryRuntimeStatisticsTypeDef, + ResultReuseConfigurationTypeDef, + ListCalculationExecutionsResponseTypeDef, + GetTableMetadataOutputTypeDef, + ListTableMetadataOutputTypeDef, + ResultSetTypeDef, + WorkGroupConfigurationTypeDef, + WorkGroupConfigurationUpdatesTypeDef, + GetSessionResponseTypeDef, + ListWorkGroupsOutputTypeDef, + ListSessionsResponseTypeDef, + GetQueryRuntimeStatisticsOutputTypeDef, + QueryExecutionTypeDef, + StartQueryExecutionInputRequestTypeDef, + GetQueryResultsOutputTypeDef, + CreateWorkGroupInputRequestTypeDef, + WorkGroupTypeDef, + UpdateWorkGroupInputRequestTypeDef, + BatchGetQueryExecutionOutputTypeDef, + GetQueryExecutionOutputTypeDef, + GetWorkGroupOutputTypeDef, +) + + +def get_structure() -> AclConfigurationTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from `botocore` schemas. +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-athena` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-athena +Provides: python3-mypy-boto3-athena-doc +%description help +<a id="mypy-boto3-athena"></a> + +# mypy-boto3-athena + +[](https://pypi.org/project/mypy-boto3-athena) +[](https://pypi.org/project/mypy-boto3-athena) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/) +[](https://pypistats.org/packages/mypy-boto3-athena) + + + +Type annotations for +[boto3.Athena 1.26.103](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/athena.html#Athena) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.14.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-athena docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-athena](#mypy-boto3-athena) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Athena`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Athena` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[athena]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[athena]' + + +# standalone installation +python -m pip install mypy-boto3-athena +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-athena +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[athena]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[athena]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[athena]` in your environment: + +```bash +python -m pip install 'boto3-stubs[athena]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`AthenaClient` provides annotations for `boto3.client("athena")`. + +```python +from boto3.session import Session + +from mypy_boto3_athena import AthenaClient + +client: AthenaClient = Session().client("athena") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_athena.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_athena import AthenaClient +from mypy_boto3_athena.paginator import ( + GetQueryResultsPaginator, + ListDataCatalogsPaginator, + ListDatabasesPaginator, + ListNamedQueriesPaginator, + ListQueryExecutionsPaginator, + ListTableMetadataPaginator, + ListTagsForResourcePaginator, +) + +client: AthenaClient = Session().client("athena") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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" +) +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_athena.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_athena.literals import ( + CalculationExecutionStateType, + ColumnNullableType, + DataCatalogTypeType, + EncryptionOptionType, + ExecutorStateType, + ExecutorTypeType, + GetQueryResultsPaginatorName, + ListDataCatalogsPaginatorName, + ListDatabasesPaginatorName, + ListNamedQueriesPaginatorName, + ListQueryExecutionsPaginatorName, + ListTableMetadataPaginatorName, + ListTagsForResourcePaginatorName, + NotebookTypeType, + QueryExecutionStateType, + S3AclOptionType, + SessionStateType, + StatementTypeType, + WorkGroupStateType, + AthenaServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: CalculationExecutionStateType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_athena.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_athena.type_defs import ( + AclConfigurationTypeDef, + ApplicationDPUSizesTypeDef, + AthenaErrorTypeDef, + BatchGetNamedQueryInputRequestTypeDef, + NamedQueryTypeDef, + ResponseMetadataTypeDef, + UnprocessedNamedQueryIdTypeDef, + BatchGetPreparedStatementInputRequestTypeDef, + PreparedStatementTypeDef, + UnprocessedPreparedStatementNameTypeDef, + BatchGetQueryExecutionInputRequestTypeDef, + UnprocessedQueryExecutionIdTypeDef, + CalculationConfigurationTypeDef, + CalculationResultTypeDef, + CalculationStatisticsTypeDef, + CalculationStatusTypeDef, + ColumnInfoTypeDef, + ColumnTypeDef, + TagTypeDef, + CreateNamedQueryInputRequestTypeDef, + CreateNotebookInputRequestTypeDef, + CreatePreparedStatementInputRequestTypeDef, + CreatePresignedNotebookUrlRequestRequestTypeDef, + CustomerContentEncryptionConfigurationTypeDef, + DataCatalogSummaryTypeDef, + DataCatalogTypeDef, + DatabaseTypeDef, + DatumTypeDef, + DeleteDataCatalogInputRequestTypeDef, + DeleteNamedQueryInputRequestTypeDef, + DeleteNotebookInputRequestTypeDef, + DeletePreparedStatementInputRequestTypeDef, + DeleteWorkGroupInputRequestTypeDef, + EncryptionConfigurationTypeDef, + EngineConfigurationTypeDef, + EngineVersionTypeDef, + ExecutorsSummaryTypeDef, + ExportNotebookInputRequestTypeDef, + NotebookMetadataTypeDef, + FilterDefinitionTypeDef, + GetCalculationExecutionCodeRequestRequestTypeDef, + GetCalculationExecutionRequestRequestTypeDef, + GetCalculationExecutionStatusRequestRequestTypeDef, + GetDataCatalogInputRequestTypeDef, + GetDatabaseInputRequestTypeDef, + GetNamedQueryInputRequestTypeDef, + GetNotebookMetadataInputRequestTypeDef, + GetPreparedStatementInputRequestTypeDef, + GetQueryExecutionInputRequestTypeDef, + PaginatorConfigTypeDef, + GetQueryResultsInputRequestTypeDef, + GetQueryRuntimeStatisticsInputRequestTypeDef, + GetSessionRequestRequestTypeDef, + SessionStatisticsTypeDef, + SessionStatusTypeDef, + GetSessionStatusRequestRequestTypeDef, + GetTableMetadataInputRequestTypeDef, + GetWorkGroupInputRequestTypeDef, + ImportNotebookInputRequestTypeDef, + ListApplicationDPUSizesInputRequestTypeDef, + ListCalculationExecutionsRequestRequestTypeDef, + ListDataCatalogsInputRequestTypeDef, + ListDatabasesInputRequestTypeDef, + ListEngineVersionsInputRequestTypeDef, + ListExecutorsRequestRequestTypeDef, + ListNamedQueriesInputRequestTypeDef, + ListNotebookSessionsRequestRequestTypeDef, + NotebookSessionSummaryTypeDef, + ListPreparedStatementsInputRequestTypeDef, + PreparedStatementSummaryTypeDef, + ListQueryExecutionsInputRequestTypeDef, + ListSessionsRequestRequestTypeDef, + ListTableMetadataInputRequestTypeDef, + ListTagsForResourceInputRequestTypeDef, + ListWorkGroupsInputRequestTypeDef, + QueryExecutionContextTypeDef, + ResultReuseInformationTypeDef, + QueryRuntimeStatisticsRowsTypeDef, + QueryRuntimeStatisticsTimelineTypeDef, + QueryStagePlanNodeTypeDef, + QueryStageTypeDef, + ResultReuseByAgeConfigurationTypeDef, + StopCalculationExecutionRequestRequestTypeDef, + StopQueryExecutionInputRequestTypeDef, + TerminateSessionRequestRequestTypeDef, + UntagResourceInputRequestTypeDef, + UpdateDataCatalogInputRequestTypeDef, + UpdateNamedQueryInputRequestTypeDef, + UpdateNotebookInputRequestTypeDef, + UpdateNotebookMetadataInputRequestTypeDef, + UpdatePreparedStatementInputRequestTypeDef, + QueryExecutionStatusTypeDef, + CreateNamedQueryOutputTypeDef, + CreateNotebookOutputTypeDef, + CreatePresignedNotebookUrlResponseTypeDef, + GetCalculationExecutionCodeResponseTypeDef, + GetNamedQueryOutputTypeDef, + ImportNotebookOutputTypeDef, + ListApplicationDPUSizesOutputTypeDef, + ListNamedQueriesOutputTypeDef, + ListQueryExecutionsOutputTypeDef, + StartCalculationExecutionResponseTypeDef, + StartQueryExecutionOutputTypeDef, + StartSessionResponseTypeDef, + StopCalculationExecutionResponseTypeDef, + TerminateSessionResponseTypeDef, + BatchGetNamedQueryOutputTypeDef, + GetPreparedStatementOutputTypeDef, + BatchGetPreparedStatementOutputTypeDef, + StartCalculationExecutionRequestRequestTypeDef, + CalculationSummaryTypeDef, + GetCalculationExecutionResponseTypeDef, + GetCalculationExecutionStatusResponseTypeDef, + ResultSetMetadataTypeDef, + TableMetadataTypeDef, + CreateDataCatalogInputRequestTypeDef, + ListTagsForResourceOutputTypeDef, + TagResourceInputRequestTypeDef, + ListDataCatalogsOutputTypeDef, + GetDataCatalogOutputTypeDef, + GetDatabaseOutputTypeDef, + ListDatabasesOutputTypeDef, + RowTypeDef, + ResultConfigurationTypeDef, + ResultConfigurationUpdatesTypeDef, + SessionConfigurationTypeDef, + StartSessionRequestRequestTypeDef, + ListEngineVersionsOutputTypeDef, + WorkGroupSummaryTypeDef, + ListExecutorsResponseTypeDef, + ExportNotebookOutputTypeDef, + GetNotebookMetadataOutputTypeDef, + ListNotebookMetadataOutputTypeDef, + ListNotebookMetadataInputRequestTypeDef, + GetQueryResultsInputGetQueryResultsPaginateTypeDef, + ListDataCatalogsInputListDataCatalogsPaginateTypeDef, + ListDatabasesInputListDatabasesPaginateTypeDef, + ListNamedQueriesInputListNamedQueriesPaginateTypeDef, + ListQueryExecutionsInputListQueryExecutionsPaginateTypeDef, + ListTableMetadataInputListTableMetadataPaginateTypeDef, + ListTagsForResourceInputListTagsForResourcePaginateTypeDef, + GetSessionStatusResponseTypeDef, + SessionSummaryTypeDef, + ListNotebookSessionsResponseTypeDef, + ListPreparedStatementsOutputTypeDef, + QueryExecutionStatisticsTypeDef, + QueryRuntimeStatisticsTypeDef, + ResultReuseConfigurationTypeDef, + ListCalculationExecutionsResponseTypeDef, + GetTableMetadataOutputTypeDef, + ListTableMetadataOutputTypeDef, + ResultSetTypeDef, + WorkGroupConfigurationTypeDef, + WorkGroupConfigurationUpdatesTypeDef, + GetSessionResponseTypeDef, + ListWorkGroupsOutputTypeDef, + ListSessionsResponseTypeDef, + GetQueryRuntimeStatisticsOutputTypeDef, + QueryExecutionTypeDef, + StartQueryExecutionInputRequestTypeDef, + GetQueryResultsOutputTypeDef, + CreateWorkGroupInputRequestTypeDef, + WorkGroupTypeDef, + UpdateWorkGroupInputRequestTypeDef, + BatchGetQueryExecutionOutputTypeDef, + GetQueryExecutionOutputTypeDef, + GetWorkGroupOutputTypeDef, +) + + +def get_structure() -> AclConfigurationTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from `botocore` schemas. +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-athena` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_athena/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-athena-1.26.103 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-athena -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.103-1 +- Package Spec generated @@ -0,0 +1 @@ +3cd83fe7cce402a97a73a8a3b7f521bc mypy-boto3-athena-1.26.103.tar.gz |