Skip to main content

Type annotations for aiobotocore DLM 3.5.0 service generated with mypy-boto3-builder 8.12.0

Project description

types-aiobotocore-dlm

PyPI - types-aiobotocore-dlm PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for aiobotocore DLM 3.5.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 types-aiobotocore page and in types-aiobotocore-dlm 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 aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

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

From PyPI with pip

Install types-aiobotocore for DLM service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[dlm]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[dlm]'

# standalone installation
python -m pip install types-aiobotocore-dlm

How to uninstall

python -m pip uninstall -y types-aiobotocore-dlm

Usage

VSCode

python -m pip install 'types-aiobotocore[dlm]'

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

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use types-aiobotocore-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 types-aiobotocore with types-aiobotocore-lite:

pip uninstall types-aiobotocore
pip install types-aiobotocore-lite

Install types-aiobotocore[dlm] in your environment:

python -m pip install 'types-aiobotocore[dlm]'

Both type checking and code completion should now work.

Emacs

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

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

Sublime Text

  • Install types-aiobotocore[dlm] with services you use in your environment:
python -m pip install 'types-aiobotocore[dlm]'

Type checking should now work. No explicit type annotations required, write your aiobotocore 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 types-aiobotocore[dlm] in your environment:
python -m pip install 'types-aiobotocore[dlm]'

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

pyright

  • Install pyright: npm i -g pyright
  • Install types-aiobotocore[dlm] in your environment:
python -m pip install 'types-aiobotocore[dlm]'

Optionally, you can install types-aiobotocore to typings directory.

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

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-aiobotocore-dlm 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 types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
    from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
    from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

DLMClient provides annotations for session.create_client("dlm").

from aiobotocore.session import get_session

from types_aiobotocore_dlm import DLMClient

session = get_session()
async with session.create_client("dlm") as client:
    client: DLMClient
    # now client usage is checked by mypy and IDE should provide code completion

Literals

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

Full list of DLM Literals can be found in docs.

from types_aiobotocore_dlm.literals import DefaultPoliciesTypeValuesType


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

Type definitions

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

Full list of DLM TypeDefs can be found in docs.

# TypedDict usage example
from types_aiobotocore_dlm.type_defs import RetentionArchiveTierTypeDef


def get_value() -> RetentionArchiveTierTypeDef:
    return {
        "Count": ...,
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers drop-in type annotations for you and makes sure that:

  • All available aiobotocore services are covered.
  • Each public class and method of every aiobotocore 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

types-aiobotocore-dlm version is the same as related aiobotocore version and follows Python Packaging version specifiers.

Thank you

Documentation

All services type annotations can be found in aiobotocore 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

types_aiobotocore_dlm-3.5.0.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

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

types_aiobotocore_dlm-3.5.0-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file types_aiobotocore_dlm-3.5.0.tar.gz.

File metadata

  • Download URL: types_aiobotocore_dlm-3.5.0.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for types_aiobotocore_dlm-3.5.0.tar.gz
Algorithm Hash digest
SHA256 bba0ee467c2cb59085f9eed2f3102e06e7be74e257a879b1ad39670c251885bd
MD5 04e16fc0aa2fdc430192f3ec6919ed50
BLAKE2b-256 12e804c509347aacaea123854a44696706da1f7daa68fa388cf9ab9830b947c8

See more details on using hashes here.

File details

Details for the file types_aiobotocore_dlm-3.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_dlm-3.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c58594b24b67a22245845a70bc8c8f7a097dd21b61cc560ec3cb482f0b5447d1
MD5 88d6c4c45384ad6b5aaceb3333549dbe
BLAKE2b-256 c4602adfa1da1fe07627a072b37b172716f89c5861a752e600378daa1fe39f3f

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