<a id="types-aiobotocore-full"></a>
# types-aiobotocore-full
[](https://pypi.org/project/types-aiobotocore-full)
[](https://pypi.org/project/types-aiobotocore-full)
[](https://youtype.github.io/types_aiobotocore_docs/)
[](https://pepy.tech/project/types-aiobotocore-full)
All-in-one type annotations for
[aiobotocore 2.15.2](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 8.1.2](https://github.com/youtype/mypy_boto3_builder).
More information can be found in
[types-aiobotocore-full docs](https://youtype.github.io/types_aiobotocore_docs/).
See how it helps to find and fix potential bugs:
- [types-aiobotocore-full](#types-aiobotocore-full)
- [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-full` to add type annotations for `aiobotocore`
package.
```bash
# install type annotations
python -m pip install types-aiobotocore-full
# or install annotations in sync with aiobotocore version
python -m pip install 'types-aiobotocore-full[aiobotocore]'
```
<a id="how-to-uninstall"></a>
## How to uninstall
```bash
# uninstall types-aiobotocore-full
python -m pip uninstall -y types-aiobotocore-full
```
<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-full` in your environment:
```bash
python -m pip install types-aiobotocore-full
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `aiobotocore` code as usual.
<a id="pycharm"></a>
### PyCharm
Install `types-aiobotocore-full` in your environment:
```bash
python -m pip install types-aiobotocore-full
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
<a id="emacs"></a>
### Emacs
- Install `types-aiobotocore-full` with services you use in your environment:
```bash
python -m pip install types-aiobotocore-full
```
- 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-full`
Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.
<a id="sublime-text"></a>
### Sublime Text
- Install `types-aiobotocore-full` with services you use in your environment:
```bash
python -m pip install types-aiobotocore-full
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `aiobotocore` 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 `types-aiobotocore-full` in your environment:
```bash
python -m pip install types-aiobotocore-full
```
Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `types-aiobotocore-full` in your environment:
```bash
python -m pip install types-aiobotocore-full
```
Optionally, you can install `types-aiobotocore-full` to `typings` directory.
Type checking should now work. 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/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for
`aiobotocore` updates. It delivers drop-in type annotations for you and makes
sure that:
- All available `aiobotocore` services are covered.
- Each public class and method of every `aiobotocore` 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 [ruff](https://docs.astral.sh/ruff/) 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
`types-aiobotocore-full` version is the same as related `aiobotocore` 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
[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/)
<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.
Raw data
{
"_id": null,
"home_page": "https://github.com/youtype/mypy_boto3_builder",
"name": "types-aiobotocore-full",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "aiobotocore type-annotations aiobotocore-stubs botocore-stubs mypy typeshed autocomplete",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/30/77/f2287ab3f6b8e95177a84d83d883bd5920264ebfd3367eff115a733e7ab2/types_aiobotocore_full-2.15.2.tar.gz",
"platform": null,
"description": "<a id=\"types-aiobotocore-full\"></a>\n\n# types-aiobotocore-full\n\n[](https://pypi.org/project/types-aiobotocore-full)\n[](https://pypi.org/project/types-aiobotocore-full)\n[](https://youtype.github.io/types_aiobotocore_docs/)\n[](https://pepy.tech/project/types-aiobotocore-full)\n\n\n\nAll-in-one type annotations for\n[aiobotocore 2.15.2](https://github.com/aio-libs/aiobotocore) compatible with\n[VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 8.1.2](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found in\n[types-aiobotocore-full docs](https://youtype.github.io/types_aiobotocore_docs/).\n\nSee how it helps to find and fix potential bugs:\n\n\n\n- [types-aiobotocore-full](#types-aiobotocore-full)\n - [How to install](#how-to-install)\n - [From PyPI with pip](#from-pypi-with-pip)\n - [How to uninstall](#how-to-uninstall)\n - [Usage](#usage)\n - [VSCode](#vscode)\n - [PyCharm](#pycharm)\n - [Emacs](#emacs)\n - [Sublime Text](#sublime-text)\n - [Other IDEs](#other-ides)\n - [mypy](#mypy)\n - [pyright](#pyright)\n - [How it works](#how-it-works)\n - [What's new](#what's-new)\n - [Implemented features](#implemented-features)\n - [Latest changes](#latest-changes)\n - [Versioning](#versioning)\n - [Thank you](#thank-you)\n - [Documentation](#documentation)\n - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `types-aiobotocore-full` to add type annotations for `aiobotocore`\npackage.\n\n```bash\n# install type annotations\npython -m pip install types-aiobotocore-full\n\n# or install annotations in sync with aiobotocore version\npython -m pip install 'types-aiobotocore-full[aiobotocore]'\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\n# uninstall types-aiobotocore-full\npython -m pip uninstall -y types-aiobotocore-full\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `types-aiobotocore-full` in your environment:\n\n```bash\npython -m pip install types-aiobotocore-full\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `aiobotocore` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `types-aiobotocore-full` in your environment:\n\n```bash\npython -m pip install types-aiobotocore-full\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `types-aiobotocore-full` with services you use in your environment:\n\n```bash\npython -m pip install types-aiobotocore-full\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n [lsp](https://github.com/emacs-lsp/lsp-mode/),\n [company](https://github.com/company-mode/company-mode) and\n [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n :ensure t\n :hook (python-mode . (lambda ()\n (require 'lsp-pyright)\n (lsp))) ; or lsp-deferred\n :init (when (executable-find \"python3\")\n (setq lsp-pyright-python-executable-cmd \"python3\"))\n )\n```\n\n- Make sure emacs uses the environment where you have installed\n `types-aiobotocore-full`\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `types-aiobotocore-full` with services you use in your environment:\n\n```bash\npython -m pip install types-aiobotocore-full\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `types-aiobotocore-full` in your environment:\n\n```bash\npython -m pip install types-aiobotocore-full\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `types-aiobotocore-full` in your environment:\n\n```bash\npython -m pip install types-aiobotocore-full\n```\n\nOptionally, you can install `types-aiobotocore-full` to `typings` directory.\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for\n`aiobotocore` updates. It delivers drop-in type annotations for you and makes\nsure that:\n\n- All available `aiobotocore` services are covered.\n- Each public class and method of every `aiobotocore` service gets valid type\n annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`types-aiobotocore-full` version is the same as related `aiobotocore` version\nand follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "All-in-one type annotations for aiobotocore 2.15.2 generated with mypy-boto3-builder 8.1.2",
"version": "2.15.2",
"project_urls": {
"Documentation": "https://youtype.github.io/types_aiobotocore_docs/",
"Homepage": "https://github.com/youtype/mypy_boto3_builder",
"Source": "https://github.com/youtype/mypy_boto3_builder",
"Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
},
"split_keywords": [
"aiobotocore",
"type-annotations",
"aiobotocore-stubs",
"botocore-stubs",
"mypy",
"typeshed",
"autocomplete"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef6bfc5089dc6f66d3ba45612058eedac4610e85a85575c5dd290f3643904c78",
"md5": "89d4521c2fbb9443f90e2bd44b9ae67f",
"sha256": "867f0f6e6037f376a567da3e892dda03aa6423ed25f5e2b52bb40ecbfeb5b262"
},
"downloads": -1,
"filename": "types_aiobotocore_full-2.15.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89d4521c2fbb9443f90e2bd44b9ae67f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11756091,
"upload_time": "2024-10-10T01:05:44",
"upload_time_iso_8601": "2024-10-10T01:05:44.478849Z",
"url": "https://files.pythonhosted.org/packages/ef/6b/fc5089dc6f66d3ba45612058eedac4610e85a85575c5dd290f3643904c78/types_aiobotocore_full-2.15.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3077f2287ab3f6b8e95177a84d83d883bd5920264ebfd3367eff115a733e7ab2",
"md5": "36b33a2249d539ecff2e8c6a185b56f4",
"sha256": "22292abbfb57fea9eee9435caad49d33a287838ff3c203b8a6bd53ab540e74d1"
},
"downloads": -1,
"filename": "types_aiobotocore_full-2.15.2.tar.gz",
"has_sig": false,
"md5_digest": "36b33a2249d539ecff2e8c6a185b56f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7840858,
"upload_time": "2024-10-10T01:05:48",
"upload_time_iso_8601": "2024-10-10T01:05:48.440720Z",
"url": "https://files.pythonhosted.org/packages/30/77/f2287ab3f6b8e95177a84d83d883bd5920264ebfd3367eff115a733e7ab2/types_aiobotocore_full-2.15.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 01:05:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "youtype",
"github_project": "mypy_boto3_builder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "types-aiobotocore-full"
}
JSON
