Skip to main content

Type annotations for boto3 Route53RecoveryReadiness 1.41.0 service generated with mypy-boto3-builder 8.12.0

Project description

mypy-boto3-route53-recovery-readiness

PyPI - mypy-boto3-route53-recovery-readiness PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3 Route53RecoveryReadiness 1.41.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

More information can be found on boto3-stubs page and in mypy-boto3-route53-recovery-readiness docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

How to install

Generate locally (recommended)

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.41.0' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add Route53RecoveryReadiness service.
  4. Use provided commands to install generated packages.

VSCode extension

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

Click Modify and select boto3 common and Route53RecoveryReadiness.

From PyPI with pip

Install boto3-stubs for Route53RecoveryReadiness service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[route53-recovery-readiness]'

# 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[route53-recovery-readiness]'

# standalone installation
python -m pip install mypy-boto3-route53-recovery-readiness

How to uninstall

python -m pip uninstall -y mypy-boto3-route53-recovery-readiness

Usage

VSCode

python -m pip install 'boto3-stubs[route53-recovery-readiness]'

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

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[route53-recovery-readiness] in your environment:

python -m pip install 'boto3-stubs[route53-recovery-readiness]'

Both type checking and code completion should now work.

Emacs

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

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

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

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

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

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid mypy-boto3-route53-recovery-readiness 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.

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

...

Explicit type annotations

Client annotations

Route53RecoveryReadinessClient provides annotations for boto3.client("route53-recovery-readiness").

from boto3.session import Session

from mypy_boto3_route53_recovery_readiness import Route53RecoveryReadinessClient

client: Route53RecoveryReadinessClient = Session().client("route53-recovery-readiness")

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

Paginators annotations

mypy_boto3_route53_recovery_readiness.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_route53_recovery_readiness import Route53RecoveryReadinessClient
from mypy_boto3_route53_recovery_readiness.paginator import (
    GetCellReadinessSummaryPaginator,
    GetReadinessCheckResourceStatusPaginator,
    GetReadinessCheckStatusPaginator,
    GetRecoveryGroupReadinessSummaryPaginator,
    ListCellsPaginator,
    ListCrossAccountAuthorizationsPaginator,
    ListReadinessChecksPaginator,
    ListRecoveryGroupsPaginator,
    ListResourceSetsPaginator,
    ListRulesPaginator,
)

client: Route53RecoveryReadinessClient = Session().client("route53-recovery-readiness")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
get_cell_readiness_summary_paginator: GetCellReadinessSummaryPaginator = client.get_paginator(
    "get_cell_readiness_summary"
)
get_readiness_check_resource_status_paginator: GetReadinessCheckResourceStatusPaginator = (
    client.get_paginator("get_readiness_check_resource_status")
)
get_readiness_check_status_paginator: GetReadinessCheckStatusPaginator = client.get_paginator(
    "get_readiness_check_status"
)
get_recovery_group_readiness_summary_paginator: GetRecoveryGroupReadinessSummaryPaginator = (
    client.get_paginator("get_recovery_group_readiness_summary")
)
list_cells_paginator: ListCellsPaginator = client.get_paginator("list_cells")
list_cross_account_authorizations_paginator: ListCrossAccountAuthorizationsPaginator = (
    client.get_paginator("list_cross_account_authorizations")
)
list_readiness_checks_paginator: ListReadinessChecksPaginator = client.get_paginator(
    "list_readiness_checks"
)
list_recovery_groups_paginator: ListRecoveryGroupsPaginator = client.get_paginator(
    "list_recovery_groups"
)
list_resource_sets_paginator: ListResourceSetsPaginator = client.get_paginator("list_resource_sets")
list_rules_paginator: ListRulesPaginator = client.get_paginator("list_rules")

Literals

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

Full list of Route53RecoveryReadiness Literals can be found in docs.

from mypy_boto3_route53_recovery_readiness.literals import GetCellReadinessSummaryPaginatorName


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

Type definitions

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

Full list of Route53RecoveryReadiness TypeDefs can be found in docs.

# TypedDict usage example
from mypy_boto3_route53_recovery_readiness.type_defs import CellOutputTypeDef


def get_value() -> CellOutputTypeDef:
    return {
        "CellArn": ...,
    }

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

mypy-boto3-route53-recovery-readiness version is the same as related boto3 version and follows Python Packaging version specifiers.

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mypy_boto3_route53_recovery_readiness-1.41.0.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file mypy_boto3_route53_recovery_readiness-1.41.0.tar.gz.

File metadata

File hashes

Hashes for mypy_boto3_route53_recovery_readiness-1.41.0.tar.gz
Algorithm Hash digest
SHA256 56b7a90a0eee9124bade903d1c0c837728e2e7915e41bbd31b1484d0f24619e5
MD5 aad2708e97bc0bc0591df2ff784a8633
BLAKE2b-256 297ab38c482e4b5de51829785537195162226f2461f892787773aaea9df918d1

See more details on using hashes here.

File details

Details for the file mypy_boto3_route53_recovery_readiness-1.41.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mypy_boto3_route53_recovery_readiness-1.41.0-py3-none-any.whl
Algorithm Hash digest
SHA256 92b0abde06ee25dae2ae1452bb590e261df228aef43b4cd1a12272b46fa7a041
MD5 1ef5abfdf7280bb7f78cdcd1df3cc703
BLAKE2b-256 08fe37a10728b543a2842198acdfae01fd69159a26e64f5f2e269f69c03c5183

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page