mypy-boto3


Namemypy-boto3 JSON
Version 1.34.73 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for boto3 1.34.73 master module generated with mypy-boto3-builder 7.23.2
upload_time2024-03-28 19:35:47
maintainerNone
docs_urlNone
authorVlad Emelianov
requires_python>=3.8
licenseMIT License
keywords boto3 type-annotations boto3-stubs mypy mypy-stubs typeshed autocomplete auto-generated
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <a id="mypy-boto3"></a>

# mypy-boto3

[![PyPI - mypy-boto3](https://img.shields.io/pypi/v/mypy-boto3.svg?color=blue)](https://pypi.org/project/mypy-boto3)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3.svg?color=blue)](https://pypi.org/project/mypy-boto3)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/)
[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3)](https://pepy.tech/project/mypy-boto3)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Dynamic
[boto3 1.34.73](https://boto3.amazonaws.com/v1/documentation/api/1.34.73/index.html)
type annotations builder for
[boto3-stubs](https://pypi.org/project/boto3-stubs/).

Generated by
[mypy-boto3-builder 7.23.2](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:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [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 mypy-boto3

# 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/41/21/8e21ed2553b343df53ffdf60a8c525d0c551db75f9f0e749155fe4fe0335/mypy-boto3-1.34.73.tar.gz",
    "platform": null,
    "description": "<a id=\"mypy-boto3\"></a>\n\n# mypy-boto3\n\n[![PyPI - mypy-boto3](https://img.shields.io/pypi/v/mypy-boto3.svg?color=blue)](https://pypi.org/project/mypy-boto3)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3.svg?color=blue)](https://pypi.org/project/mypy-boto3)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3)](https://pepy.tech/project/mypy-boto3)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nDynamic\n[boto3 1.34.73](https://boto3.amazonaws.com/v1/documentation/api/1.34.73/index.html)\ntype annotations builder for\n[boto3-stubs](https://pypi.org/project/boto3-stubs/).\n\nGenerated by\n[mypy-boto3-builder 7.23.2](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![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\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 mypy-boto3\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.34.73 master module generated with mypy-boto3-builder 7.23.2",
    "version": "1.34.73",
    "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": "e104366b01bf340a901f679e657bbe01541b42d204e284253ae1b693050c0775",
                "md5": "ba0aa2fbdd934530a05521c49fd93fff",
                "sha256": "6c0554b969a91be6a7b7a014a2d20cc94588eba556b0f17e64011e909ad514f2"
            },
            "downloads": -1,
            "filename": "mypy_boto3-1.34.73-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ba0aa2fbdd934530a05521c49fd93fff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 21038,
            "upload_time": "2024-03-28T19:35:38",
            "upload_time_iso_8601": "2024-03-28T19:35:38.819459Z",
            "url": "https://files.pythonhosted.org/packages/e1/04/366b01bf340a901f679e657bbe01541b42d204e284253ae1b693050c0775/mypy_boto3-1.34.73-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "41218e21ed2553b343df53ffdf60a8c525d0c551db75f9f0e749155fe4fe0335",
                "md5": "b92f8fce57c7ddcd12aa5014736eeb52",
                "sha256": "b5c7184e0827931d1c1b5db1a2f0508aec2887d9a4f4074b13b125cda82c380e"
            },
            "downloads": -1,
            "filename": "mypy-boto3-1.34.73.tar.gz",
            "has_sig": false,
            "md5_digest": "b92f8fce57c7ddcd12aa5014736eeb52",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 21227,
            "upload_time": "2024-03-28T19:35:47",
            "upload_time_iso_8601": "2024-03-28T19:35:47.924164Z",
            "url": "https://files.pythonhosted.org/packages/41/21/8e21ed2553b343df53ffdf60a8c525d0c551db75f9f0e749155fe4fe0335/mypy-boto3-1.34.73.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-28 19:35:47",
    "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"
}
        
Elapsed time: 0.23999s