Proxy package for boto3-stubs
Proxy package for boto3-stubs.
Install submodules for boto3
services type annotations.
Type annotations for botocore compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
See how it helps to find and fix potential bugs:
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Install botocore-stubs
to add type annotations for botocore
package.
Install boto3-stubs
to add type annotations for boto3
package.
# install type annotations only for botocore
python -m pip install botocore-stubs
# install type annotations only for boto3 and botocore
python -m pip install botocore-stubs boto3-stubs
# install `boto3` type annotations
# for ec2, s3, rds, lambda, sqs, dynamo and cloudformation
# Consumes ~7 MB of space
python -m pip install 'boto3-stubs[essential]'
# 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[essential]'
# or install annotations for services you use
python -m pip install 'boto3-stubs[acm,apigateway]'
Installing boto3-stubs
from the conda-forge
channel can be achieved by adding conda-forge
to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
Once the conda-forge
channel has been enabled, boto3-stubs
and boto3-stubs-essential
can be installed with:
conda install boto3-stubs boto3-stubs-essential
It is possible to list all of the versions of boto3-stubs
available on your platform with:
conda search boto3-stubs --channel conda-forge
# uninstall boto3-stubs
python -m pip uninstall -y boto3-stubs botocore-stubs
# uninstall submodules
python -m pip freeze | grep mypy-boto3 | xargs python -m pip uninstall -y
Pylance
as your Python Language Serverboto3-stubs
with services you use in your environment: python -m pip install 'boto3-stubs[s3,ec2]'
Both type checking and code completion should work for installed boto3
services.
No explicit type annotations required, write your boto3
code as usual.
boto3-stubs-lite
with services you use in your environment:python -m pip install 'boto3-stubs-lite[s3,ec2]'
Both type checking and code completion should work for installed services.
Explicit type annotations are required. Use boto3-stubs
package instead for implicit type discovery.
boto3-stubs
with services you use in your environment: python -m pip install 'boto3-stubs[s3,ec2]'
(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"))
)
boto3-stubs
boto3-stubs
with services you use in your environment: python -m pip install 'boto3-stubs[s3,ec2]'
boto3-stubs
Not tested, but as long as your IDE supports mypy
or pyright
, everything should work.
mypy
: python -m pip install mypy
boto3-stubs
with services you use in your environment: python -m pip install 'boto3-stubs[s3,ec2]'
mypy
as usualType checking should work for installed boto3
services.
No explicit type annotations required, write your boto3
code as usual.
pyright
: yarn global add pyright
boto3-stubs
with services you use in your environment: python -m pip install 'boto3-stubs[s3,ec2]'
boto3-stubs
to typings
folder.Type checking should work for installed boto3
services.
No explicit type annotations required, write your boto3
code as usual.
Fully automated 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:
boto3
services are covered.boto3
service gets valid type annotations
extracted from the documentation (blame botocore
docs if types are incorrect).boto3
librarymypy
, pyright
, VSCode
, PyCharm
, Sublime Text
and Emacs
compatibilityClient
type annotations for each serviceServiceResource
type annotations for each serviceResource
type annotations for each serviceWaiter
type annotations for each servicePaginator
type annotations for each serviceTypeDefs
for each serviceLiterals
for each serviceboto3.client
and boto3.session
callssession.client
and session.session
callsclient.get_waiter
and client.get_paginator
callsServiceResource
and Resource
collectionsBuilder changelog can be found in Releases.
botocore-stubs
version is the same as related botocore
version and follows
PEP 440 format.
All services type annotations can be found in boto3-stubs docs
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.