Skip to main content

Type annotations for aiobotocore CloudWatchEvidently 2.23.0 service generated with mypy-boto3-builder 8.11.0

Project description

types-aiobotocore-evidently

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

boto3.typed

Type annotations for aiobotocore CloudWatchEvidently 2.23.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.11.0.

More information can be found on types-aiobotocore page and in types-aiobotocore-evidently 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==2.23.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add CloudWatchEvidently service.
  4. Use provided commands to install generated packages.

From PyPI with pip

Install types-aiobotocore for CloudWatchEvidently service.

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

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

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

How to uninstall

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

Usage

VSCode

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

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

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

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

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

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

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

CloudWatchEvidentlyClient provides annotations for session.create_client("evidently").

from aiobotocore.session import get_session

from types_aiobotocore_evidently import CloudWatchEvidentlyClient

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

Paginators annotations

types_aiobotocore_evidently.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_evidently import CloudWatchEvidentlyClient
from types_aiobotocore_evidently.paginator import (
    ListExperimentsPaginator,
    ListFeaturesPaginator,
    ListLaunchesPaginator,
    ListProjectsPaginator,
    ListSegmentReferencesPaginator,
    ListSegmentsPaginator,
)

session = get_session()
async with session.create_client("evidently") as client:
    client: CloudWatchEvidentlyClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_experiments_paginator: ListExperimentsPaginator = client.get_paginator("list_experiments")
    list_features_paginator: ListFeaturesPaginator = client.get_paginator("list_features")
    list_launches_paginator: ListLaunchesPaginator = client.get_paginator("list_launches")
    list_projects_paginator: ListProjectsPaginator = client.get_paginator("list_projects")
    list_segment_references_paginator: ListSegmentReferencesPaginator = client.get_paginator(
        "list_segment_references"
    )
    list_segments_paginator: ListSegmentsPaginator = client.get_paginator("list_segments")

Literals

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

Full list of CloudWatchEvidently Literals can be found in docs.

from types_aiobotocore_evidently.literals import ChangeDirectionEnumType


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

Type definitions

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

Full list of CloudWatchEvidently TypeDefs can be found in docs.

# TypedDict usage example
from types_aiobotocore_evidently.type_defs import EvaluationRequestTypeDef


def get_value() -> EvaluationRequestTypeDef:
    return {
        "entityId": ...,
    }

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-evidently 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_evidently-2.23.0.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

types_aiobotocore_evidently-2.23.0-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file types_aiobotocore_evidently-2.23.0.tar.gz.

File metadata

File hashes

Hashes for types_aiobotocore_evidently-2.23.0.tar.gz
Algorithm Hash digest
SHA256 1c8ed9db72585c7ffd067e35430ee57feb0f09f35d7c51f8fa92c2b0ee3aa251
MD5 d1bcaa65a85e082c17ac5522da67aab7
BLAKE2b-256 6c73c70631afb7d07acf2a4bdd068b0ebdb32f6d9262934d8a88637f1bf52327

See more details on using hashes here.

File details

Details for the file types_aiobotocore_evidently-2.23.0-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_evidently-2.23.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef13612d31eae1d0a5732f06c89bd50f85a6243eaa981b5a9b982b8a75cc9a3d
MD5 2a6cf1ae2d0a99e8d499e515f5dc3114
BLAKE2b-256 3c760687dd5c5c7f677f0400d379c2d707f84befae79351d15b15056d4ec1140

See more details on using hashes here.

Supported by

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