Skip to main content

Type annotations for boto3 AuroraDSQL 1.35.74 service generated with mypy-boto3-builder 8.5.0

Project description

mypy-boto3-dsql

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

boto3.typed

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

Generated by mypy-boto3-builder 8.5.0.

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

See how it helps you find and fix potential bugs:

types-boto3 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 AuroraDSQL.

From PyPI with pip

Install boto3-stubs for AuroraDSQL service.

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


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


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

How to uninstall

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

Usage

VSCode

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

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[dsql] in your environment:

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

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

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

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

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-dsql 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

AuroraDSQLClient provides annotations for boto3.client("dsql").

from boto3.session import Session

from mypy_boto3_dsql import AuroraDSQLClient

client: AuroraDSQLClient = Session().client("dsql")

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

Paginators annotations

mypy_boto3_dsql.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_dsql import AuroraDSQLClient
from mypy_boto3_dsql.paginator import ListClustersPaginator

client: AuroraDSQLClient = Session().client("dsql")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")

Waiters annotations

mypy_boto3_dsql.waiter module contains type annotations for all waiters.

from boto3.session import Session

from mypy_boto3_dsql import AuroraDSQLClient
from mypy_boto3_dsql.waiter import ClusterActiveWaiter, ClusterNotExistsWaiter

client: AuroraDSQLClient = Session().client("dsql")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
cluster_active_waiter: ClusterActiveWaiter = client.get_waiter("cluster_active")
cluster_not_exists_waiter: ClusterNotExistsWaiter = client.get_waiter("cluster_not_exists")

Literals

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

Full list of AuroraDSQL Literals can be found in docs.

from mypy_boto3_dsql.literals import ClusterActiveWaiterName


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

Type definitions

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

Full list of AuroraDSQL TypeDefs can be found in docs.

from mypy_boto3_dsql.type_defs import ClusterSummaryTypeDef


def get_value() -> ClusterSummaryTypeDef:
    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 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-dsql 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.

Project details


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_dsql-1.35.74.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_dsql-1.35.74-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file mypy_boto3_dsql-1.35.74.tar.gz.

File metadata

  • Download URL: mypy_boto3_dsql-1.35.74.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for mypy_boto3_dsql-1.35.74.tar.gz
Algorithm Hash digest
SHA256 17d80304ea656b22b8341d95ec29f085eec100c34b3339035afe42465603b8cc
MD5 663724a784f93feffd041a2c17b4539e
BLAKE2b-256 57ff2af67b00774c8ba54c0c4f0e51d56b7247bd52d66b0aadfd8056052913d8

See more details on using hashes here.

File details

Details for the file mypy_boto3_dsql-1.35.74-py3-none-any.whl.

File metadata

File hashes

Hashes for mypy_boto3_dsql-1.35.74-py3-none-any.whl
Algorithm Hash digest
SHA256 96d3edb8dcf4f0e8acb5bea363066d11aa3f303f8ad7a5e43bb43194264f112a
MD5 10bae9a9a29a568e60b2ba567c98c3b0
BLAKE2b-256 dd200cb0e00f7583d40d1dcde808f64a7f74c9fe1796d0f12fab2f3d77552e1d

See more details on using hashes here.

Supported by

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