Python库 | types-aiobotocore-2.1.0.post2.tar.gz

<a id="types-aiobotocore"></a> # types-aiobotocore [](https://pypi.org/project/types-aiobotocore) [](https://pypi.org/project/types-aiobotocore) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/types-aiobotocore)  Type annotations for [aiobotocore 2.1.0](https://github.com/aio-libs/aiobotocore) 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 6.4.2](https://github.com/vemel/mypy_boto3_builder). See how it helps to find and fix potential bugs:  - [types-aiobotocore](#types-aiobotocore) - [How to install](#how-to-install) - [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) - [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="from-pypi-with-pip"></a> ### From PyPI with pip Install `types-aiobotocore` to add type annotations for `aiobotocore` package. ```bash # install type annotations only for aiobotocore python -m pip install types-aiobotocore # install `aiobotocore` type annotations # for ec2, s3, rds, lambda, sqs, dynamo and cloudformation # Consumes ~7 MB of space python -m pip install 'types-aiobotocore[essential]' # Lite version does not provide session.create_client overloads # it is more RAM-friendly, but requires explicit type annotations python -m pip install 'types-aiobotocore-lite[essential]' # or install annotations for services you use python -m pip install 'types-aiobotocore[acm,apigateway]' ``` <a id="how-to-uninstall"></a> ## How to uninstall ```bash # uninstall types-aiobotocore python -m pip uninstall -y boto3-stubs types-aiobotocore # uninstall submodules python -m pip freeze | grep mypy-aiobotocore | xargs python -m pip uninstall -y ``` <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 `types-aiobotocore` with services you use in your environment: `python -m pip install 'types-aiobotocore[s3,ec2]'` Both type checking and auto-complete should work for installed `aiobotocore` services. No explicit type annotations required, write your `aiobotocore` code as usual. <a id="pycharm"></a> ### PyCharm - Install `types-aiobotocore` with services you use in your environment: `python -m pip install 'types-aiobotocore[s3,ec2]'` - Install `mypy_boto3_builder`: `pip install mypy_boto3_builder` - Generate stubs in `<project_root>/typings` directory for services you use ```bash python -m mypy_boto3_builder --product aiobotocore --installed typings -d -s s3 ec2 ``` - Add `<project_root>/typings` folder to your [Interpreter Paths](https://www.jetbrains.com/help/pycharm/stubs.html#reuse-stubs) Since stubs are stored in your project root, you do not need to re-generate them after update. <a id="emacs"></a> ### Emacs - Install `types-aiobotocore` with services you use in your environment: `python -m pip install 'types-aiobotocore[s3,ec2]'` - 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 `types-aiobotocore` <a id="sublime-text"></a> ### Sublime Text - Install `types-aiobotocore` with services you use in your environment: `python -m pip install 'types-aiobotocore[s3,ec2]'` - Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package - Make sure emacs uses the environment where you have installed `types-aiobotocore` <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 `types-aiobotocore` with services you use in your environment: `python -m pip install 'types-aiobotocore[s3,ec2]'` - Run `mypy` as usual Type checking should work for installed `aiobotocore` services. No explicit type annotations required, write your `aiobotocore` code as usual. <a id="pyright"></a> ### pyright - Install `pyright`: `yarn global add pyright` - Install `types-aiobotocore` with services you use in your environment: `python -m pip install 'types-aiobotocore[s3,ec2]'` - Optionally, you can install `types-aiobotocore` to `typings` folder. Type checking should work for installed `aiobotocore` services. No explicit type annotations required, write your `aiobotocore` code as usual. <a id="how-it-works"></a> ## How it works Fully automated [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder) carefully generates type annotations for each service, patiently waiting for `boto3` updates. It delivers a 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 the documentation (blame `botocore` docs if types are incorrect). - 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` library - `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` compatibility - `Client` type annotations for each service - `ServiceResource` type annotations for each service - `Resource` type annotations for each service - `Waiter` type annotations for each service - `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.session` calls - Auto discovery of types for `session.client` and `session.session` calls - Auto discovery of types for `client.get_waiter` and `client.get_paginator` calls - Auto discovery of types for `ServiceResource` and `Resource` collections <a id="latest-changes"></a> ### Latest changes Builder changelog can be fou