Skip to main content

mypy-boto3-backupstorage

PyPI - mypy-boto3-backupstorage PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3.BackupStorage 1.28.15 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 7.16.1.

More information can be found on boto3-stubs page and in mypy-boto3-backupstorage docs.

See how it helps to find and fix potential bugs:

boto3-stubs demo

How to install

VSCode extension

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

Click Modify and select boto3 common and BackupStorage.

From PyPI with pip

Install boto3-stubs for BackupStorage service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[backupstorage]'


# 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[backupstorage]'


# standalone installation
python -m pip install mypy-boto3-backupstorage

How to uninstall

python -m pip uninstall -y mypy-boto3-backupstorage

Usage

VSCode

python -m pip install 'boto3-stubs[backupstorage]'

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

PyCharm

Install boto3-stubs-lite[backupstorage] in your environment:

python -m pip install 'boto3-stubs-lite[backupstorage]'`

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

Use boto3-stubs package instead for implicit type discovery.

Emacs

  • Install boto3-stubs with services you use in your environment:
python -m pip install 'boto3-stubs[backupstorage]'
(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

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

Sublime Text

  • Install boto3-stubs[backupstorage] with services you use in your environment:
python -m pip install 'boto3-stubs[backupstorage]'

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[backupstorage] in your environment:
python -m pip install 'boto3-stubs[backupstorage]'`

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[backupstorage] in your environment:
python -m pip install 'boto3-stubs[backupstorage]'

Optionally, you can install boto3-stubs to typings folder.

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

Explicit type annotations

Client annotations

BackupStorageClient provides annotations for boto3.client("backupstorage").

from boto3.session import Session

from mypy_boto3_backupstorage import BackupStorageClient

client: BackupStorageClient = Session().client("backupstorage")

# now client usage is checked by mypy and IDE should provide code completion

Literals

mypy_boto3_backupstorage.literals module contains literals extracted from shapes that can be used in user code for type checking.

from mypy_boto3_backupstorage.literals import (
    DataChecksumAlgorithmType,
    SummaryChecksumAlgorithmType,
    BackupStorageServiceName,
    ServiceName,
    ResourceServiceName,
    RegionName,
)


def check_value(value: DataChecksumAlgorithmType) -> bool:
    ...

Typed dictionaries

mypy_boto3_backupstorage.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from mypy_boto3_backupstorage.type_defs import (
    BackupObjectTypeDef,
    ChunkTypeDef,
    DeleteObjectInputRequestTypeDef,
    ResponseMetadataTypeDef,
    GetChunkInputRequestTypeDef,
    GetObjectMetadataInputRequestTypeDef,
    ListChunksInputRequestTypeDef,
    ListObjectsInputRequestTypeDef,
    NotifyObjectCompleteInputRequestTypeDef,
    PutChunkInputRequestTypeDef,
    PutObjectInputRequestTypeDef,
    StartObjectInputRequestTypeDef,
    EmptyResponseMetadataTypeDef,
    GetChunkOutputTypeDef,
    GetObjectMetadataOutputTypeDef,
    ListChunksOutputTypeDef,
    ListObjectsOutputTypeDef,
    NotifyObjectCompleteOutputTypeDef,
    PutChunkOutputTypeDef,
    PutObjectOutputTypeDef,
    StartObjectOutputTypeDef,
)


def get_structure() -> BackupObjectTypeDef:
    return {...}

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 black and isort 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

mypy-boto3-backupstorage version is the same as related boto3 version and follows PEP 440 format.

Thank you

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.

Metadata

Release files for mypy-boto3-backupstorage 1.28.15

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mypy-boto3-backupstorage 1.28.15
File Size Uploaded Provenance Actions
mypy-boto3-backupstorage-1.28.15.tar.gz 15.3 kB Without provenance Details for mypy-boto3-backupstorage-1.28.15.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mypy-boto3-backupstorage 1.28.15
File Interpreter ABI Platform Actions
mypy_boto3_backupstorage-1.28.15-py3-none-any.whl Python 3 none any Details for mypy_boto3_backupstorage-1.28.15-py3-none-any.whl

Total release size: 35.3 kB

Release files / mypy-boto3-backupstorage-1.28.15.tar.gz

Download URL mypy-boto3-backupstorage-1.28.15.tar.gz
Size 15.3 kB
Tags Source
SHA-256 checksum
How to use checksums
faf4e238f97b7c6df5066df0a97617ca43352111b07f5576f0613de934a0ee18
BLAKE2b-256 checksum
How to use checksums
31d3abedea2fd62d09f263b7dad15d85c3ff09d93a9058b3a862b0e9a0ce8738
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / mypy_boto3_backupstorage-1.28.15-py3-none-any.whl

Download URL mypy_boto3_backupstorage-1.28.15-py3-none-any.whl
Size 20.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
26dd1c7bea9523374f3741e6e8eedb6e7377dcd20d4703dc1fbb74d1518b0565
BLAKE2b-256 checksum
How to use checksums
c154b8ef858d68b92c106c98202ea90ffab6849b7ebfbc14fde4764be329f195
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Security for mypy-boto3-backupstorage 1.28.15

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page