Skip to main content

Type annotations for aiobotocore.ImportExport 2.1.1 service generated by mypy-boto3-builder 7.0.4

Project description

mypy-boto3-importexport

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

boto3.typed

Type annotations for aiobotocore.ImportExport 1.20.54 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 7.0.4.

More information can be found on types-aiobotocore page and in types-aiobotocore-importexport docs

See how it helps to 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 ImportExport.

From PyPI with pip

Install types-aiobotocore for ImportExport service.

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

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

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

How to uninstall

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

Usage

VSCode

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

Both type checking and auto-complete should now work. No explicit type annotations required, write your aiobotocore code as usual.

PyCharm

Install types-aiobotocore-lite[importexport] in your environment:

python -m pip install 'types-aiobotocore-lite[importexport]'`

Both type checking and auto-complete should now work. Explicit type annotations are required. Use types-aiobotocore package instead for implicit type discovery.

Emacs

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

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

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

Optionally, you can install types-aiobotocore to typings folder.

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

Explicit type annotations

Client annotations

ImportExportClient provides annotations for session.create_client("importexport").

from aiobotocore.session import get_session

from types_aiobotocore_importexport import ImportExportClient

session = get_session()
async with session.create_client("importexport") as client:
    client: ImportExportClient
    # now client usage is checked by mypy and IDE should provide code auto-complete

Paginators annotations

types_aiobotocore_importexport.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_importexport import ImportExportClient
from types_aiobotocore_importexport.paginator import (
    ListJobsPaginator,
)

session = get_session()
async with session.create_client("importexport") as client:
    client: ImportExportClient

    # Explicit type annotations are optional here
    # Type should be correctly discovered by mypy and IDEs
    # VSCode requires explicit type annotations
        list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
    ```







### Literals

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

```python
from types_aiobotocore_importexport.literals import (
    JobTypeType,
    ListJobsPaginatorName,
    ServiceName,
    PaginatorName,
)

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

Typed dictionaries

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

from types_aiobotocore_importexport.type_defs import (
    ArtifactTypeDef,
    CancelJobInputRequestTypeDef,
    CancelJobOutputTypeDef,
    CreateJobInputRequestTypeDef,
    CreateJobOutputTypeDef,
    GetShippingLabelInputRequestTypeDef,
    GetShippingLabelOutputTypeDef,
    GetStatusInputRequestTypeDef,
    GetStatusOutputTypeDef,
    JobTypeDef,
    ListJobsInputRequestTypeDef,
    ListJobsOutputTypeDef,
    PaginatorConfigTypeDef,
    ResponseMetadataTypeDef,
    UpdateJobInputRequestTypeDef,
    UpdateJobOutputTypeDef,
)

def get_structure() -> ArtifactTypeDef:
    return {
      ...
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers a 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 the documentation (blame botocore docs if types are incorrect).
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by black and isort for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore and aiobotocore 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.session calls
  • Auto discovery of types for session.client and session.session 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-importexport version is the same as related aiobotocore version and follows PEP 440 format.

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-importexport-2.1.1.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file types-aiobotocore-importexport-2.1.1.tar.gz.

File metadata

  • Download URL: types-aiobotocore-importexport-2.1.1.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for types-aiobotocore-importexport-2.1.1.tar.gz
Algorithm Hash digest
SHA256 0e2f978a2386c386038a7f1b629a4b9d9f7e1e9bc1a73c8b26acb7cd6212709a
MD5 c536070d2955ba6be34f0782754c56bc
BLAKE2b-256 ef9bb8e7d20ba4785fef8e1f7fb35fef46e036d67cac4ffdef394950e45a84a2

See more details on using hashes here.

File details

Details for the file types_aiobotocore_importexport-2.1.1-py3-none-any.whl.

File metadata

  • Download URL: types_aiobotocore_importexport-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for types_aiobotocore_importexport-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a1df27ed78af3298061a63e3537f3f3a55f56bd268a6b76b901a1bcd88ecd8f6
MD5 65e7c7ebdb3ba222177cac42bdb13b12
BLAKE2b-256 c4db3930d459b1ab2fa691baaf3a45d072953a1e97eebcb3377a48fefe29a422

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