Skip to main content

Type annotations for aiobotocore BillingandCostManagementDataExports 3.2.0 service generated with mypy-boto3-builder 8.12.0

Project description

types-aiobotocore-bcm-data-exports

PyPI - types-aiobotocore-bcm-data-exports PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for aiobotocore BillingandCostManagementDataExports 3.2.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-bcm-data-exports 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.2.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add BillingandCostManagementDataExports service.
  4. Use provided commands to install generated packages.

From PyPI with pip

Install types-aiobotocore for BillingandCostManagementDataExports service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[bcm-data-exports]'

# 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[bcm-data-exports]'

# standalone installation
python -m pip install types-aiobotocore-bcm-data-exports

How to uninstall

python -m pip uninstall -y types-aiobotocore-bcm-data-exports

Usage

VSCode

python -m pip install 'types-aiobotocore[bcm-data-exports]'

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[bcm-data-exports] in your environment:

python -m pip install 'types-aiobotocore[bcm-data-exports]'

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

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

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

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-bcm-data-exports 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

BillingandCostManagementDataExportsClient provides annotations for session.create_client("bcm-data-exports").

from aiobotocore.session import get_session

from types_aiobotocore_bcm_data_exports import BillingandCostManagementDataExportsClient

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

Paginators annotations

types_aiobotocore_bcm_data_exports.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_bcm_data_exports import BillingandCostManagementDataExportsClient
from types_aiobotocore_bcm_data_exports.paginator import (
    ListExecutionsPaginator,
    ListExportsPaginator,
    ListTablesPaginator,
)

session = get_session()
async with session.create_client("bcm-data-exports") as client:
    client: BillingandCostManagementDataExportsClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_executions_paginator: ListExecutionsPaginator = client.get_paginator("list_executions")
    list_exports_paginator: ListExportsPaginator = client.get_paginator("list_exports")
    list_tables_paginator: ListTablesPaginator = client.get_paginator("list_tables")

Literals

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

Full list of BillingandCostManagementDataExports Literals can be found in docs.

from types_aiobotocore_bcm_data_exports.literals import CompressionOptionType


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

Type definitions

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

Full list of BillingandCostManagementDataExports TypeDefs can be found in docs.

# TypedDict usage example
from types_aiobotocore_bcm_data_exports.type_defs import ColumnTypeDef


def get_value() -> ColumnTypeDef:
    return {
        "Description": ...,
    }

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-bcm-data-exports 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


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_bcm_data_exports-3.2.0.tar.gz (18.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 types_aiobotocore_bcm_data_exports-3.2.0.tar.gz.

File metadata

File hashes

Hashes for types_aiobotocore_bcm_data_exports-3.2.0.tar.gz
Algorithm Hash digest
SHA256 b8a8430ad4c2c9d89c558096e384d8f45a532c2b28e4dfa004c38887b73013b4
MD5 6f0bf1b17a046356083fffaf90358941
BLAKE2b-256 f86787ababebcd305c7b02c411e0d0de5f07660ffe45094a37bc71b86bc0f5b0

See more details on using hashes here.

File details

Details for the file types_aiobotocore_bcm_data_exports-3.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_bcm_data_exports-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff6c36d8fae12512e15f71323ffa9536c4d547e53fdbb29a8d83fabb15732b80
MD5 04d2fc8e24db8b0853d3e0c0e5f602ad
BLAKE2b-256 163bb18750a674abe0011626247b743f4dadc46c08cfa30b4c4835a4b55031d0

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