<a id="mypy-boto3"></a>
# mypy-boto3
[](https://pypi.org/project/mypy-boto3)
[](https://pypi.org/project/mypy-boto3)
[](https://youtype.github.io/boto3_stubs_docs/)
[](https://pepy.tech/project/mypy-boto3)
Dynamic
[boto3 1.35.54](https://boto3.amazonaws.com/v1/documentation/api/1.35.54/index.html)
type annotations builder for
[boto3-stubs](https://pypi.org/project/boto3-stubs/).
Generated by
[mypy-boto3-builder 8.1.4](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
See how it helps to find and fix potential bugs:
- [mypy-boto3](#mypy-boto3)
- [How to install](#how-to-install)
- [Usage](#usage)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
```bash
# Install this package
python -m pip install boto3-stubs
# Install type annotations for boto3 services you use
python -m pip install 'boto3-stubs[s3,ec2]'
# 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[s3,ec2]'
```
<a id="usage"></a>
## Usage
Provides `ServiceName` and `ResourceServiceName` literals:
```python
from typing import overload
import boto3
from botocore.client import BaseClient
from mypy_boto3.literals import ServiceName
from mypy_boto3_ec2.client import EC2Client
from mypy_boto3_ec2.literals import EC2ServiceName
from mypy_boto3_s3.client import S3Client
from mypy_boto3_s3.literals import S3ServiceName
@overload
def get_client(service_name: EC2ServiceName) -> EC2Client: ...
@overload
def get_client(service_name: S3ServiceName) -> S3Client: ...
@overload
def get_client(service_name: ServiceName) -> BaseClient: ...
def get_client(service_name: ServiceName) -> BaseClient:
return boto3.client(service_name)
# type: S3Client, fully type annotated
# All methods and attributes are auto-completed and type checked
s3_client = get_client("s3")
# type: EC2Client, fully type annotated
# All methods and attributes are auto-completed and type checked
ec2_client = get_client("ec2")
# type: BaseClient, only basic type annotations
# Dynamodb-specific methods and attributes are not auto-completed and not type checked
dynamodb_client = get_client("dynamodb")
```
<a id="latest-changes"></a>
### Latest changes
Full changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
<a id="versioning"></a>
## Versioning
`mypy-boto3` version is the same as related `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
<a id="support-and-contributing"></a>
## Support and contributing
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": "mypy-boto3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "boto3 type-annotations boto3-stubs mypy mypy-stubs typeshed autocomplete auto-generated",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6e/1d/2f5d81c0fd42fa884c0040e678ee091423794ce3d58b54a1f28d158e7cc0/mypy_boto3-1.35.54.tar.gz",
"platform": null,
"description": "<a id=\"mypy-boto3\"></a>\n\n# mypy-boto3\n\n[](https://pypi.org/project/mypy-boto3)\n[](https://pypi.org/project/mypy-boto3)\n[](https://youtype.github.io/boto3_stubs_docs/)\n[](https://pepy.tech/project/mypy-boto3)\n\n\n\nDynamic\n[boto3 1.35.54](https://boto3.amazonaws.com/v1/documentation/api/1.35.54/index.html)\ntype annotations builder for\n[boto3-stubs](https://pypi.org/project/boto3-stubs/).\n\nGenerated by\n[mypy-boto3-builder 8.1.4](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[boto3-stubs](https://pypi.org/project/boto3-stubs/) page.\n\nSee how it helps to find and fix potential bugs:\n\n\n\n- [mypy-boto3](#mypy-boto3)\n - [How to install](#how-to-install)\n - [Usage](#usage)\n - [Latest changes](#latest-changes)\n - [Versioning](#versioning)\n - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n```bash\n# Install this package\npython -m pip install boto3-stubs\n\n# Install type annotations for boto3 services you use\npython -m pip install 'boto3-stubs[s3,ec2]'\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[s3,ec2]'\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\nProvides `ServiceName` and `ResourceServiceName` literals:\n\n```python\nfrom typing import overload\n\nimport boto3\nfrom botocore.client import BaseClient\nfrom mypy_boto3.literals import ServiceName\nfrom mypy_boto3_ec2.client import EC2Client\nfrom mypy_boto3_ec2.literals import EC2ServiceName\nfrom mypy_boto3_s3.client import S3Client\nfrom mypy_boto3_s3.literals import S3ServiceName\n\n\n@overload\ndef get_client(service_name: EC2ServiceName) -> EC2Client: ...\n\n\n@overload\ndef get_client(service_name: S3ServiceName) -> S3Client: ...\n\n\n@overload\ndef get_client(service_name: ServiceName) -> BaseClient: ...\n\n\ndef get_client(service_name: ServiceName) -> BaseClient:\n return boto3.client(service_name)\n\n\n# type: S3Client, fully type annotated\n# All methods and attributes are auto-completed and type checked\ns3_client = get_client(\"s3\")\n\n# type: EC2Client, fully type annotated\n# All methods and attributes are auto-completed and type checked\nec2_client = get_client(\"ec2\")\n\n# type: BaseClient, only basic type annotations\n# Dynamodb-specific methods and attributes are not auto-completed and not type checked\ndynamodb_client = get_client(\"dynamodb\")\n```\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nFull 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`mypy-boto3` version is the same as related `boto3` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nPlease reports any bugs or request new features in\n[mypy_boto3_builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Type annotations for boto3 1.35.54 master module generated with mypy-boto3-builder 8.1.4",
"version": "1.35.54",
"project_urls": {
"Documentation": "https://youtype.github.io/boto3_stubs_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": [
"boto3",
"type-annotations",
"boto3-stubs",
"mypy",
"mypy-stubs",
"typeshed",
"autocomplete",
"auto-generated"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a909503d5e48ab82444acaee28d1cb2362a257aae8acff83e9c20af59d8a5b49",
"md5": "01d9273436d54394566da417594e3545",
"sha256": "749cef72b7ed18e2d8165de09c4104b9c6b5ad6693a8bdd7ce5278ed71a015c6"
},
"downloads": -1,
"filename": "mypy_boto3-1.35.54-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01d9273436d54394566da417594e3545",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21388,
"upload_time": "2024-11-01T19:47:06",
"upload_time_iso_8601": "2024-11-01T19:47:06.411264Z",
"url": "https://files.pythonhosted.org/packages/a9/09/503d5e48ab82444acaee28d1cb2362a257aae8acff83e9c20af59d8a5b49/mypy_boto3-1.35.54-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e1d2f5d81c0fd42fa884c0040e678ee091423794ce3d58b54a1f28d158e7cc0",
"md5": "40ab0477d75c7e83ca16d2aae1fdfb9c",
"sha256": "93dd1a3f8afb6db84dc4cb27876e75c1ddf24955afeaaa7344cf1f88eb0af103"
},
"downloads": -1,
"filename": "mypy_boto3-1.35.54.tar.gz",
"has_sig": false,
"md5_digest": "40ab0477d75c7e83ca16d2aae1fdfb9c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21634,
"upload_time": "2024-11-01T19:47:08",
"upload_time_iso_8601": "2024-11-01T19:47:08.566372Z",
"url": "https://files.pythonhosted.org/packages/6e/1d/2f5d81c0fd42fa884c0040e678ee091423794ce3d58b54a1f28d158e7cc0/mypy_boto3-1.35.54.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-01 19:47:08",
"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": "mypy-boto3"
}
JSON
