Skip to main content

Type annotations for boto3 CostExplorer 1.35.71 service generated with mypy-boto3-builder 8.4.0

Project description

types-boto3-ce

PyPI - types-boto3-ce PyPI - Python Version Docs PyPI - Downloads

boto3.typed

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

Generated by mypy-boto3-builder 8.4.0.

More information can be found on types-boto3 page and in types-boto3-ce docs.

See how it helps you find and fix potential bugs:

boto3-stubs 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 CostExplorer.

From PyPI with pip

Install types-boto3 for CostExplorer service.

# install with boto3 type annotations
python -m pip install 'types-boto3[ce]'


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


# standalone installation
python -m pip install types-boto3-ce

How to uninstall

python -m pip uninstall -y types-boto3-ce

Usage

VSCode

python -m pip install 'types-boto3[ce]'

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 types-boto3-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-boto3 with types-boto3-lite:

pip uninstall types-boto3
pip install types-boto3-lite

Install types-boto3[ce] in your environment:

python -m pip install 'types-boto3[ce]'

Both type checking and code completion should now work.

Emacs

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

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

Sublime Text

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

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

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

pyright

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

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

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

Explicit type annotations

Client annotations

CostExplorerClient provides annotations for boto3.client("ce").

from boto3.session import Session

from types_boto3_ce import CostExplorerClient

client: CostExplorerClient = Session().client("ce")

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

Literals

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

Full list of CostExplorer Literals can be found in docs.

from types_boto3_ce.literals import AccountScopeType


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

Type definitions

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

Full list of CostExplorer TypeDefs can be found in docs.

from types_boto3_ce.type_defs import AnomalyDateIntervalTypeDef


def get_value() -> AnomalyDateIntervalTypeDef:
    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

types-boto3-ce 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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

types_boto3_ce-1.35.71-py3-none-any.whl (39.0 kB view details)

Uploaded Python 3

File details

Details for the file types_boto3_ce-1.35.71-py3-none-any.whl.

File metadata

File hashes

Hashes for types_boto3_ce-1.35.71-py3-none-any.whl
Algorithm Hash digest
SHA256 37f70f9acdf359ae87972d52aa23fa8862d273619a3bdb211e7fa24b510fc2f1
MD5 d8dffee4caadde27be9e3d07e2e25afa
BLAKE2b-256 8fea5698f78c21bc1e6199ce0dbf5ba81dbad8b8fb6fd70b88a7c84f23e03a56

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