boto3-stubs-full

All-in-one type annotations for boto3 1.35.10 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 8.0.1.

More information can be found in boto3-stubs-full docs.

See how it helps to find and fix potential bugs:

• boto3-stubs-full
  • How to install
    • VSCode extension
    • From PyPI with pip
  • How to uninstall
  • Usage
    • VSCode
    • PyCharm
    • Emacs
    • Sublime Text
    • Other IDEs
    • mypy
    • pyright
    • Explicit type annotations
    • Pylint compatibility
  • How it works
  • What's new
    • Implemented features
    • Latest changes
  • Versioning
  • Thank you
  • Documentation
  • Support and contributing

How to install

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Auto-discover services and select services you use in the current project.

From PyPI with pip

Install boto3-stubs-full to add type annotations for boto3 package.

# install type annotations
python -m pip install boto3-stubs-full

# or install annotations in sync with boto3 version
python -m pip install 'boto3-stubs-full[boto3]'

How to uninstall

# uninstall boto3-stubs-full
python -m pip uninstall -y boto3-stubs-full

Usage

VSCode

• Install Python extension
• Install Pylance extension
• Set Pylance as your Python Language Server
• Install boto3-stubs-full in your environment:

python -m pip install boto3-stubs-full

Both type checking and code completion should now work. No explicit type annotations required, write your boto3 code as usual.

PyCharm

Install boto3-stubs-full in your environment:

python -m pip install boto3-stubs-full

Both type checking and code completion should now work. Explicit type annotations are required.

Emacs

• Install boto3-stubs-full with services you use in your environment:

python -m pip install boto3-stubs-full

• Install use-package, lsp, company and flycheck packages
• Install lsp-pyright package

(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-full

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Sublime Text

• Install boto3-stubs-full with services you use in your environment:

python -m pip install boto3-stubs-full

• Install LSP-pyright package

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

• Install mypy: python -m pip install mypy
• Install boto3-stubs-full in your environment:

python -m pip install boto3-stubs-full

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

pyright

• Install pyright: npm i -g pyright
• Install boto3-stubs-full in your environment:

python -m pip install boto3-stubs-full

Optionally, you can install boto3-stubs-full to typings directory.

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Explicit type annotations

To speed up type checking and code completion, you can set types explicitly.

import boto3
from boto3.session import Session

from mypy_boto3_ec2.client import EC2Client
from mypy_boto3_ec2.service_resource import EC2ServiceResource
from mypy_boto3_ec2.waiter import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginator import DescribeVolumesPaginator

session = Session(region_name="us-west-1")

ec2_client: EC2Client = boto3.client("ec2", region_name="us-west-1")
ec2_resource: EC2ServiceResource = session.resource("ec2")

bundle_task_complete_waiter: BundleTaskCompleteWaiter = ec2_client.get_waiter(
    "bundle_task_complete"
)
describe_volumes_paginator: DescribeVolumesPaginator = ec2_client.get_paginator("describe_volumes")

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid boto3-stubs dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
    from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

How it works

Fully automated 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 ruff for readability.

What's new

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

Latest changes

Builder changelog can be found in Releases.

Versioning

boto3-stubs-full version is the same as related boto3 version and follows PEP 440 format.

Thank you

• Allie Fitter for boto3-type-annotations, this package is based on top of his work
• black developers for an awesome formatting tool
• Timothy Edmund Crosley for isort and how flexible it is
• mypy developers for doing all dirty work for us
• pyright team for the new era of typed Python

Documentation

All services type annotations can be found in boto3 docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.