Skip to main content

Type annotations for boto3 HealthImaging 1.40.71 service generated with mypy-boto3-builder 8.12.0

Project description

types-boto3-medical-imaging

PyPI - types-boto3-medical-imaging PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3 HealthImaging 1.40.71 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-boto3 page and in types-boto3-medical-imaging 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 boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.40.71' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add HealthImaging service.
  4. Use provided commands to install generated packages.

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and HealthImaging.

From PyPI with pip

Install types-boto3 for HealthImaging service.

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

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

# standalone installation
python -m pip install types-boto3-medical-imaging

How to uninstall

python -m pip uninstall -y types-boto3-medical-imaging

Usage

VSCode

python -m pip install 'types-boto3[medical-imaging]'

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

python -m pip install 'types-boto3[medical-imaging]'

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

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

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

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.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-boto3-medical-imaging 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_boto3_ec2 import EC2Client, EC2ServiceResource
    from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from types_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

HealthImagingClient provides annotations for boto3.client("medical-imaging").

from boto3.session import Session

from types_boto3_medical_imaging import HealthImagingClient

client: HealthImagingClient = Session().client("medical-imaging")

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

Paginators annotations

types_boto3_medical_imaging.paginator module contains type annotations for all paginators.

from boto3.session import Session

from types_boto3_medical_imaging import HealthImagingClient
from types_boto3_medical_imaging.paginator import (
    ListDICOMImportJobsPaginator,
    ListDatastoresPaginator,
    ListImageSetVersionsPaginator,
    SearchImageSetsPaginator,
)

client: HealthImagingClient = Session().client("medical-imaging")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_dicom_import_jobs_paginator: ListDICOMImportJobsPaginator = client.get_paginator(
    "list_dicom_import_jobs"
)
list_datastores_paginator: ListDatastoresPaginator = client.get_paginator("list_datastores")
list_image_set_versions_paginator: ListImageSetVersionsPaginator = client.get_paginator(
    "list_image_set_versions"
)
search_image_sets_paginator: SearchImageSetsPaginator = client.get_paginator("search_image_sets")

Literals

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

Full list of HealthImaging Literals can be found in docs.

from types_boto3_medical_imaging.literals import DatastoreStatusType


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

Type definitions

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

Full list of HealthImaging TypeDefs can be found in docs.

# TypedDict usage example
from types_boto3_medical_imaging.type_defs import CopyDestinationImageSetPropertiesTypeDef


def get_value() -> CopyDestinationImageSetPropertiesTypeDef:
    return {
        "imageSetId": ...,
    }

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-medical-imaging version is the same as related boto3 version and follows Python Packaging version specifiers.

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 Distribution

types_boto3_medical_imaging-1.40.71.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

types_boto3_medical_imaging-1.40.71-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file types_boto3_medical_imaging-1.40.71.tar.gz.

File metadata

File hashes

Hashes for types_boto3_medical_imaging-1.40.71.tar.gz
Algorithm Hash digest
SHA256 4a1d1d463f2702e98e63509b74f6f41d4e329e2391d9623fd5a60b8ef0cbbe9f
MD5 f0c95d53d07f50275fc0dde9de608d81
BLAKE2b-256 888ea4486f88186776bc5d286db3ef7b91b4749e6955e2fdf60863c829159d49

See more details on using hashes here.

File details

Details for the file types_boto3_medical_imaging-1.40.71-py3-none-any.whl.

File metadata

File hashes

Hashes for types_boto3_medical_imaging-1.40.71-py3-none-any.whl
Algorithm Hash digest
SHA256 df2d09d71238ee2052332f6b487554f4c50487757186ba7330763441e39c5c07
MD5 8700d2d0d37537705be81990a3388b7c
BLAKE2b-256 23be1ce17aee3a0e4ee8581b1a3384a7042cc37b27b524bbd4f7c9b78328cca3

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