Skip to main content

Type annotations for aiobotocore Mediapackagev2 3.6.0 service generated with mypy-boto3-builder 8.12.0

Project description

types-aiobotocore-mediapackagev2

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

boto3.typed

Type annotations for aiobotocore Mediapackagev2 3.6.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-mediapackagev2 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.6.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add Mediapackagev2 service.
  4. Use provided commands to install generated packages.

From PyPI with pip

Install types-aiobotocore for Mediapackagev2 service.

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

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

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

How to uninstall

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

Usage

VSCode

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

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

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

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

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

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

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

Mediapackagev2Client provides annotations for session.create_client("mediapackagev2").

from aiobotocore.session import get_session

from types_aiobotocore_mediapackagev2 import Mediapackagev2Client

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

Paginators annotations

types_aiobotocore_mediapackagev2.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_mediapackagev2 import Mediapackagev2Client
from types_aiobotocore_mediapackagev2.paginator import (
    ListChannelGroupsPaginator,
    ListChannelsPaginator,
    ListHarvestJobsPaginator,
    ListOriginEndpointsPaginator,
)

session = get_session()
async with session.create_client("mediapackagev2") as client:
    client: Mediapackagev2Client

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_channel_groups_paginator: ListChannelGroupsPaginator = client.get_paginator(
        "list_channel_groups"
    )
    list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
    list_harvest_jobs_paginator: ListHarvestJobsPaginator = client.get_paginator(
        "list_harvest_jobs"
    )
    list_origin_endpoints_paginator: ListOriginEndpointsPaginator = client.get_paginator(
        "list_origin_endpoints"
    )

Waiters annotations

types_aiobotocore_mediapackagev2.waiter module contains type annotations for all waiters.

from aiobotocore.session import get_session

from types_aiobotocore_mediapackagev2.client import Mediapackagev2Client
from types_aiobotocore_mediapackagev2.waiter import HarvestJobFinishedWaiter

session = get_session()
async with session.create_client("mediapackagev2") as client:
    client: Mediapackagev2Client

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    harvest_job_finished_waiter: HarvestJobFinishedWaiter = client.get_waiter(
        "harvest_job_finished"
    )

Literals

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

Full list of Mediapackagev2 Literals can be found in docs.

from types_aiobotocore_mediapackagev2.literals import AdMarkerDashType


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

Type definitions

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

Full list of Mediapackagev2 TypeDefs can be found in docs.

# TypedDict usage example
from types_aiobotocore_mediapackagev2.type_defs import CancelHarvestJobRequestTypeDef


def get_value() -> CancelHarvestJobRequestTypeDef:
    return {
        "ChannelGroupName": ...,
    }

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-mediapackagev2 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_mediapackagev2-3.6.0.tar.gz (27.3 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_mediapackagev2-3.6.0.tar.gz.

File metadata

File hashes

Hashes for types_aiobotocore_mediapackagev2-3.6.0.tar.gz
Algorithm Hash digest
SHA256 86bdd922651ca24c984c1a6ce7a10f94a66591e4d83661b61a1226b3684cf4d1
MD5 1feb50eed03baf51bc0f38ce34a1739d
BLAKE2b-256 48661e1fc08c9af66d69b9b60b75e67050b195050bc67095f59cdbc6442a8554

See more details on using hashes here.

File details

Details for the file types_aiobotocore_mediapackagev2-3.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_mediapackagev2-3.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e380f0f45910e8d8c7080f58fd9adf773ee90f2535dfc32c3d0978198bf5fb66
MD5 d572155bea9d5664fdff5670550e8c8f
BLAKE2b-256 b022dba23c9c87d64087ef8f671e1c48bb9f8697a555ee4e9026d7a9666a290e

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