Package: types-boto3
types-boto3Proxy package forboto3-stubs.
Install submodules forboto3services type annotations.Type annotations forbotocorecompatible withVSCode,PyCharm,Emacs,Sublime Text,mypy,pyrightand other tools.See how it helps to find and fix potential bugs:How to installVSCode extensionAddAWS Boto3extension to your VSCode and runAWS boto3: Quick Startcommand.From PyPI with pipInstallbotocore-stubsto add type annotations forbotocorepackage.
Installboto3-stubsto add type annotations forboto3package.# install type annotations only for botocorepython-mpipinstallbotocore-stubs# install type annotations only for boto3 and botocorepython-mpipinstallbotocore-stubsboto3-stubs# install `boto3` type annotations# for ec2, s3, rds, lambda, sqs, dynamo and cloudformation# Consumes ~7 MB of spacepython-mpipinstall'boto3-stubs[essential]'# Lite version does not provide session.client/resource overloads# it is more RAM-friendly, but requires explicit type annotationspython-mpipinstall'boto3-stubs-lite[essential]'# or install annotations for services you usepython-mpipinstall'boto3-stubs[acm,apigateway]'From conda-forgeInstallingboto3-stubsfrom theconda-forgechannel can be achieved by addingconda-forgeto your channels with:condaconfig--addchannelsconda-forge
condaconfig--setchannel_prioritystrictOnce theconda-forgechannel has been enabled,boto3-stubsandboto3-stubs-essentialcan be installed with:condainstallboto3-stubsboto3-stubs-essentialIt is possible to list all of the versions ofboto3-stubsavailable on your platform with:condasearchboto3-stubs--channelconda-forgeHow to uninstall# uninstall boto3-stubspython-mpipuninstall-yboto3-stubsbotocore-stubs# uninstall submodulespython-mpipfreeze|grepmypy-boto3|xargspython-mpipuninstall-yUsageVSCodeInstallPython extensionInstallPylance extensionSetPylanceas your Python Language ServerInstallboto3-stubswith services you use in your environment:python -m pip install 'boto3-stubs[s3,ec2]'Both type checking and code completion should work for installedboto3services.
No explicit type annotations required, write yourboto3code as usual.PyCharmInstallboto3-stubs-litewith services you use in your environment:python-mpipinstall'boto3-stubs-lite[s3,ec2]'Both type checking and code completion should work for installed services.
Explicit type annotationsare required. Useboto3-stubspackage instead for implicit type discovery.EmacsInstallboto3-stubswith services you use in your environment:python -m pip install 'boto3-stubs[s3,ec2]'Installuse-package,lsp,companyandflycheckpackagesInstalllsp-pyrightpackage(use-packagelsp-pyright:ensuret:hook(python-mode.(lambda()(require'lsp-pyright)(lsp))); or lsp-deferred:init(when(executable-find"python3")(setqlsp-pyright-python-executable-cmd"python3")))Make sure emacs uses the environment where you have installedboto3-stubsSublime TextInstallboto3-stubswith services you use in your environment:python -m pip install 'boto3-stubs[s3,ec2]'InstallLSP-pyrightpackageMake sure emacs uses the environment where you have installedboto3-stubsOther IDEsNot tested, but as long as your IDE supportsmypyorpyright, everything should work.mypyInstallmypy:python -m pip install mypyInstallboto3-stubswith services you use in your environment:python -m pip install 'boto3-stubs[s3,ec2]'Runmypyas usualType checking should work for installedboto3services.
No explicit type annotations required, write yourboto3code as usual.pyrightInstallpyright:yarn global add pyrightInstallboto3-stubswith services you use in your environment:python -m pip install 'boto3-stubs[s3,ec2]'Optionally, you can installboto3-stubstotypingsfolder.Type checking should work for installedboto3services.
No explicit type annotations required, write yourboto3code as usual.How it worksFully automatedmypy-boto3-buildercarefully generates
type annotations for each service, patiently waiting forboto3updates. It delivers
a drop-in type annotations for you and makes sure that:All availableboto3services are covered.Each public class and method of everyboto3service gets valid type annotations
extracted from the documentation (blamebotocoredocs if types are incorrect).Type annotations include up-to-date documentation.Link to documentation is provided for every method.Code is processed byblackandisortfor readability.What's newImplemented featuresFully type annotatedboto3librarymypy,pyright,VSCode,PyCharm,Sublime TextandEmacscompatibilityClienttype annotations for each serviceServiceResourcetype annotations for each serviceResourcetype annotations for each serviceWaitertype annotations for each servicePaginatortype annotations for each serviceGeneratedTypeDefsfor each serviceGeneratedLiteralsfor each serviceAuto discovery of types forboto3.clientandboto3.sessioncallsAuto discovery of types forsession.clientandsession.sessioncallsAuto discovery of types forclient.get_waiterandclient.get_paginatorcallsAuto discovery of types forServiceResourceandResourcecollectionsLatest changesBuilder changelog can be found inReleases.Versioningbotocore-stubsversion is the same as relatedbotocoreversion and followsPEP 440format.Thank youAllie Fitterforboto3-type-annotations,
this package is based on top of his workblackdevelopers for an awesome formatting toolTimothy Edmund Crosleyforisortand how flexible it ismypydevelopers for doing all dirty work for uspyrightteam for the new era of typed PythonDocumentationAll services type annotations can be found inboto3-stubs docsSupport and contributingThis package is auto-generated. Please reports any bugs or request new features inmypy-boto3-builderrepository.