Skip to main content

Type annotations for aiobotocore.QLDBSession 2.5.0 service generated with mypy-boto3-builder 7.13.0

Project description

types-aiobotocore-qldb-session

PyPI - types-aiobotocore-qldb-session PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for aiobotocore.QLDBSession 2.5.0 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 7.13.0.

More information can be found on types-aiobotocore page and in types-aiobotocore-qldb-session docs.

See how it helps to find and fix potential bugs:

boto3-stubs demo

How to install

From PyPI with pip

Install types-aiobotocore for QLDBSession service.

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


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


# standalone installation
python -m pip install types-aiobotocore-qldb-session

How to uninstall

python -m pip uninstall -y types-aiobotocore-qldb-session

Usage

VSCode

python -m pip install 'types-aiobotocore[qldb-session]'

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

PyCharm

Install types-aiobotocore-lite[qldb-session] in your environment:

python -m pip install 'types-aiobotocore-lite[qldb-session]'`

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

Use types-aiobotocore package instead for implicit type discovery.

Emacs

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

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[qldb-session] in your environment:
python -m pip install 'types-aiobotocore[qldb-session]'`

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[qldb-session] in your environment:
python -m pip install 'types-aiobotocore[qldb-session]'

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

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

Explicit type annotations

Client annotations

QLDBSessionClient provides annotations for session.create_client("qldb-session").

from aiobotocore.session import get_session

from types_aiobotocore_qldb_session import QLDBSessionClient

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

Literals

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

from types_aiobotocore_qldb_session.literals import (
    QLDBSessionServiceName,
    ServiceName,
    ResourceServiceName,
    RegionName,
)


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

Typed dictionaries

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

from types_aiobotocore_qldb_session.type_defs import (
    TimingInformationTypeDef,
    CommitTransactionRequestTypeDef,
    IOUsageTypeDef,
    ValueHolderTypeDef,
    FetchPageRequestTypeDef,
    ResponseMetadataTypeDef,
    StartSessionRequestTypeDef,
    AbortTransactionResultTypeDef,
    EndSessionResultTypeDef,
    StartSessionResultTypeDef,
    StartTransactionResultTypeDef,
    CommitTransactionResultTypeDef,
    ExecuteStatementRequestTypeDef,
    PageTypeDef,
    SendCommandRequestRequestTypeDef,
    ExecuteStatementResultTypeDef,
    FetchPageResultTypeDef,
    SendCommandResultTypeDef,
)


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

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers a 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 the documentation (blame botocore docs if types are incorrect).
  • 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 and aiobotocore 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.session calls
  • Auto discovery of types for session.client and session.session 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-qldb-session version is the same as related aiobotocore version and follows PEP 440 format.

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


Download files

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

Source Distribution

Built Distribution

File details

Details for the file types-aiobotocore-qldb-session-2.5.0.post1.tar.gz.

File metadata

File hashes

Hashes for types-aiobotocore-qldb-session-2.5.0.post1.tar.gz
Algorithm Hash digest
SHA256 ab4ec1a31d1007327ddcd4510b891746dcb86fe49c93ae44f6a35332737b95c8
MD5 58666f162d35bafc5bfc5754b6c65505
BLAKE2b-256 d6e90be60b8e18f787e198be15c009d1fd2628ee4470eff49e628a9b1658d79f

See more details on using hashes here.

File details

Details for the file types_aiobotocore_qldb_session-2.5.0.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_qldb_session-2.5.0.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 488a92105f0afd5b72b8edc1ca290babaae0ee0a21af592dcb8a9c9ab68d5bc4
MD5 7682c5267a90373c913b4de765283c80
BLAKE2b-256 f1281946a9ef4bde1aae6b56229bc1461214cf6784eb8e5a867e9886c866f09b

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