mypy-boto3-omics


Namemypy-boto3-omics JSON
Version 1.35.68 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for boto3 Omics 1.35.68 service generated with mypy-boto3-builder 8.3.1
upload_time2024-11-22 20:34:50
maintainerNone
docs_urlNone
authorVlad Emelianov
requires_python>=3.8
licenseMIT License
keywords boto3 omics type-annotations botocore mypy typeshed autocomplete
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <a id="mypy-boto3-omics"></a>

# mypy-boto3-omics

[![PyPI - mypy-boto3-omics](https://img.shields.io/pypi/v/mypy-boto3-omics.svg?color=blue)](https://pypi.org/project/mypy-boto3-omics/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-omics.svg?color=blue)](https://pypi.org/project/mypy-boto3-omics/)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/)
[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-omics)](https://pypistats.org/packages/mypy-boto3-omics)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for [boto3 Omics 1.35.68](https://pypi.org/project/boto3/)
compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.

Generated by
[mypy-boto3-builder 8.3.1](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-omics docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/).

See how it helps you find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [mypy-boto3-omics](#mypy-boto3-omics)
  - [How to install](#how-to-install)
    - [VSCode extension](#vscode-extension)
    - [From PyPI with pip](#from-pypi-with-pip)
  - [How to uninstall](#how-to-uninstall)
  - [Usage](#usage)
    - [VSCode](#vscode)
    - [PyCharm](#pycharm)
    - [Emacs](#emacs)
    - [Sublime Text](#sublime-text)
    - [Other IDEs](#other-ides)
    - [mypy](#mypy)
    - [pyright](#pyright)
  - [Explicit type annotations](#explicit-type-annotations)
    - [Client annotations](#client-annotations)
    - [Paginators annotations](#paginators-annotations)
    - [Waiters annotations](#waiters-annotations)
    - [Literals](#literals)
    - [Type definitions](#type-definitions)
  - [How it works](#how-it-works)
  - [What's new](#what's-new)
    - [Implemented features](#implemented-features)
    - [Latest changes](#latest-changes)
  - [Versioning](#versioning)
  - [Thank you](#thank-you)
  - [Documentation](#documentation)
  - [Support and contributing](#support-and-contributing)

<a id="how-to-install"></a>

## How to install

<a id="vscode-extension"></a>

### VSCode extension

Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.

Click `Modify` and select `boto3 common` and `Omics`.

<a id="from-pypi-with-pip"></a>

### From PyPI with pip

Install `boto3-stubs` for `Omics` service.

```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[omics]'


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


# standalone installation
python -m pip install mypy-boto3-omics
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y mypy-boto3-omics
```

<a id="usage"></a>

## Usage

<a id="vscode"></a>

### VSCode

- Install
  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[omics]` in your environment:

```bash
python -m pip install 'boto3-stubs[omics]'
```

Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.

<a id="pycharm"></a>

### PyCharm

> ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until
> the issue is resolved.

> ⚠️ If you experience slow performance and high CPU usage, try to disable
> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
> [pyright](https://github.com/microsoft/pyright) instead.

> ⚠️ To continue using `PyCharm` type checker, you can try to replace
> `boto3-stubs` with
> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

```bash
pip uninstall boto3-stubs
pip install boto3-stubs-lite
```

Install `boto3-stubs[omics]` in your environment:

```bash
python -m pip install 'boto3-stubs[omics]'
```

Both type checking and code completion should now work.

<a id="emacs"></a>

### Emacs

- Install `boto3-stubs` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[omics]'
```

- Install [use-package](https://github.com/jwiegley/use-package),
  [lsp](https://github.com/emacs-lsp/lsp-mode/),
  [company](https://github.com/company-mode/company-mode) and
  [flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

```elisp
(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 `boto3-stubs`

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

<a id="sublime-text"></a>

### Sublime Text

- Install `boto3-stubs[omics]` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[omics]'
```

- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package

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

<a id="other-ides"></a>

### Other IDEs

Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.

<a id="mypy"></a>

### mypy

- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[omics]` in your environment:

```bash
python -m pip install 'boto3-stubs[omics]'
```

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

<a id="pyright"></a>

### pyright

- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[omics]` in your environment:

```bash
python -m pip install 'boto3-stubs[omics]'
```

Optionally, you can install `boto3-stubs` to `typings` directory.

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

<a id="explicit-type-annotations"></a>

## Explicit type annotations

<a id="client-annotations"></a>

### Client annotations

`OmicsClient` provides annotations for `boto3.client("omics")`.

```python
from boto3.session import Session

from mypy_boto3_omics import OmicsClient

client: OmicsClient = Session().client("omics")

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

<a id="paginators-annotations"></a>

### Paginators annotations

`mypy_boto3_omics.paginator` module contains type annotations for all
paginators.

```python
from boto3.session import Session

from mypy_boto3_omics import OmicsClient
from mypy_boto3_omics.paginator import (
    ListAnnotationImportJobsPaginator,
    ListAnnotationStoreVersionsPaginator,
    ListAnnotationStoresPaginator,
    ListMultipartReadSetUploadsPaginator,
    ListReadSetActivationJobsPaginator,
    ListReadSetExportJobsPaginator,
    ListReadSetImportJobsPaginator,
    ListReadSetUploadPartsPaginator,
    ListReadSetsPaginator,
    ListReferenceImportJobsPaginator,
    ListReferenceStoresPaginator,
    ListReferencesPaginator,
    ListRunCachesPaginator,
    ListRunGroupsPaginator,
    ListRunTasksPaginator,
    ListRunsPaginator,
    ListSequenceStoresPaginator,
    ListSharesPaginator,
    ListVariantImportJobsPaginator,
    ListVariantStoresPaginator,
    ListWorkflowsPaginator,
)

client: OmicsClient = Session().client("omics")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_annotation_import_jobs_paginator: ListAnnotationImportJobsPaginator = client.get_paginator(
    "list_annotation_import_jobs"
)
list_annotation_store_versions_paginator: ListAnnotationStoreVersionsPaginator = (
    client.get_paginator("list_annotation_store_versions")
)
list_annotation_stores_paginator: ListAnnotationStoresPaginator = client.get_paginator(
    "list_annotation_stores"
)
list_multipart_read_set_uploads_paginator: ListMultipartReadSetUploadsPaginator = (
    client.get_paginator("list_multipart_read_set_uploads")
)
list_read_set_activation_jobs_paginator: ListReadSetActivationJobsPaginator = client.get_paginator(
    "list_read_set_activation_jobs"
)
list_read_set_export_jobs_paginator: ListReadSetExportJobsPaginator = client.get_paginator(
    "list_read_set_export_jobs"
)
list_read_set_import_jobs_paginator: ListReadSetImportJobsPaginator = client.get_paginator(
    "list_read_set_import_jobs"
)
list_read_set_upload_parts_paginator: ListReadSetUploadPartsPaginator = client.get_paginator(
    "list_read_set_upload_parts"
)
list_read_sets_paginator: ListReadSetsPaginator = client.get_paginator("list_read_sets")
list_reference_import_jobs_paginator: ListReferenceImportJobsPaginator = client.get_paginator(
    "list_reference_import_jobs"
)
list_reference_stores_paginator: ListReferenceStoresPaginator = client.get_paginator(
    "list_reference_stores"
)
list_references_paginator: ListReferencesPaginator = client.get_paginator("list_references")
list_run_caches_paginator: ListRunCachesPaginator = client.get_paginator("list_run_caches")
list_run_groups_paginator: ListRunGroupsPaginator = client.get_paginator("list_run_groups")
list_run_tasks_paginator: ListRunTasksPaginator = client.get_paginator("list_run_tasks")
list_runs_paginator: ListRunsPaginator = client.get_paginator("list_runs")
list_sequence_stores_paginator: ListSequenceStoresPaginator = client.get_paginator(
    "list_sequence_stores"
)
list_shares_paginator: ListSharesPaginator = client.get_paginator("list_shares")
list_variant_import_jobs_paginator: ListVariantImportJobsPaginator = client.get_paginator(
    "list_variant_import_jobs"
)
list_variant_stores_paginator: ListVariantStoresPaginator = client.get_paginator(
    "list_variant_stores"
)
list_workflows_paginator: ListWorkflowsPaginator = client.get_paginator("list_workflows")
```

<a id="waiters-annotations"></a>

### Waiters annotations

`mypy_boto3_omics.waiter` module contains type annotations for all waiters.

```python
from boto3.session import Session

from mypy_boto3_omics import OmicsClient
from mypy_boto3_omics.waiter import (
    AnnotationImportJobCreatedWaiter,
    AnnotationStoreCreatedWaiter,
    AnnotationStoreDeletedWaiter,
    AnnotationStoreVersionCreatedWaiter,
    AnnotationStoreVersionDeletedWaiter,
    ReadSetActivationJobCompletedWaiter,
    ReadSetExportJobCompletedWaiter,
    ReadSetImportJobCompletedWaiter,
    ReferenceImportJobCompletedWaiter,
    RunCompletedWaiter,
    RunRunningWaiter,
    TaskCompletedWaiter,
    TaskRunningWaiter,
    VariantImportJobCreatedWaiter,
    VariantStoreCreatedWaiter,
    VariantStoreDeletedWaiter,
    WorkflowActiveWaiter,
)

client: OmicsClient = Session().client("omics")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
annotation_import_job_created_waiter: AnnotationImportJobCreatedWaiter = client.get_waiter(
    "annotation_import_job_created"
)
annotation_store_created_waiter: AnnotationStoreCreatedWaiter = client.get_waiter(
    "annotation_store_created"
)
annotation_store_deleted_waiter: AnnotationStoreDeletedWaiter = client.get_waiter(
    "annotation_store_deleted"
)
annotation_store_version_created_waiter: AnnotationStoreVersionCreatedWaiter = client.get_waiter(
    "annotation_store_version_created"
)
annotation_store_version_deleted_waiter: AnnotationStoreVersionDeletedWaiter = client.get_waiter(
    "annotation_store_version_deleted"
)
read_set_activation_job_completed_waiter: ReadSetActivationJobCompletedWaiter = client.get_waiter(
    "read_set_activation_job_completed"
)
read_set_export_job_completed_waiter: ReadSetExportJobCompletedWaiter = client.get_waiter(
    "read_set_export_job_completed"
)
read_set_import_job_completed_waiter: ReadSetImportJobCompletedWaiter = client.get_waiter(
    "read_set_import_job_completed"
)
reference_import_job_completed_waiter: ReferenceImportJobCompletedWaiter = client.get_waiter(
    "reference_import_job_completed"
)
run_completed_waiter: RunCompletedWaiter = client.get_waiter("run_completed")
run_running_waiter: RunRunningWaiter = client.get_waiter("run_running")
task_completed_waiter: TaskCompletedWaiter = client.get_waiter("task_completed")
task_running_waiter: TaskRunningWaiter = client.get_waiter("task_running")
variant_import_job_created_waiter: VariantImportJobCreatedWaiter = client.get_waiter(
    "variant_import_job_created"
)
variant_store_created_waiter: VariantStoreCreatedWaiter = client.get_waiter("variant_store_created")
variant_store_deleted_waiter: VariantStoreDeletedWaiter = client.get_waiter("variant_store_deleted")
workflow_active_waiter: WorkflowActiveWaiter = client.get_waiter("workflow_active")
```

<a id="literals"></a>

### Literals

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

Full list of `Omics` Literals can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/literals/).

```python
from mypy_boto3_omics.literals import AcceleratorsType


def check_value(value: AcceleratorsType) -> bool: ...
```

<a id="type-definitions"></a>

### Type definitions

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

Full list of `Omics` TypeDefs can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/type_defs/).

```python
from mypy_boto3_omics.type_defs import AbortMultipartReadSetUploadRequestRequestTypeDef


def get_value() -> AbortMultipartReadSetUploadRequestRequestTypeDef:
    return {...}
```

<a id="how-it-works"></a>

## How it works

Fully automated
[mypy-boto3-builder](https://github.com/youtype/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](https://docs.astral.sh/ruff/) for readability.

<a id="what's-new"></a>

## What's new

<a id="implemented-features"></a>

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

<a id="latest-changes"></a>

### Latest changes

Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).

<a id="versioning"></a>

## Versioning

`mypy-boto3-omics` version is the same as related `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.

<a id="thank-you"></a>

## Thank you

- [Allie Fitter](https://github.com/alliefitter) for
  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
  this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
  tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
  [isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
  for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
  Python

<a id="documentation"></a>

## Documentation

All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/)

<a id="support-and-contributing"></a>

## Support and contributing

This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/youtype/mypy_boto3_builder",
    "name": "mypy-boto3-omics",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "boto3 omics type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9c/b9/3810870696646307f0bcc7caba1f9f7a7c8e78348eab2d6901710b75dc1f/mypy_boto3_omics-1.35.68.tar.gz",
    "platform": null,
    "description": "<a id=\"mypy-boto3-omics\"></a>\n\n# mypy-boto3-omics\n\n[![PyPI - mypy-boto3-omics](https://img.shields.io/pypi/v/mypy-boto3-omics.svg?color=blue)](https://pypi.org/project/mypy-boto3-omics/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-omics.svg?color=blue)](https://pypi.org/project/mypy-boto3-omics/)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-omics)](https://pypistats.org/packages/mypy-boto3-omics)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for [boto3 Omics 1.35.68](https://pypi.org/project/boto3/)\ncompatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 8.3.1](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in\n[mypy-boto3-omics docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/).\n\nSee how it helps you find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [mypy-boto3-omics](#mypy-boto3-omics)\n  - [How to install](#how-to-install)\n    - [VSCode extension](#vscode-extension)\n    - [From PyPI with pip](#from-pypi-with-pip)\n  - [How to uninstall](#how-to-uninstall)\n  - [Usage](#usage)\n    - [VSCode](#vscode)\n    - [PyCharm](#pycharm)\n    - [Emacs](#emacs)\n    - [Sublime Text](#sublime-text)\n    - [Other IDEs](#other-ides)\n    - [mypy](#mypy)\n    - [pyright](#pyright)\n  - [Explicit type annotations](#explicit-type-annotations)\n    - [Client annotations](#client-annotations)\n    - [Paginators annotations](#paginators-annotations)\n    - [Waiters annotations](#waiters-annotations)\n    - [Literals](#literals)\n    - [Type definitions](#type-definitions)\n  - [How it works](#how-it-works)\n  - [What's new](#what's-new)\n    - [Implemented features](#implemented-features)\n    - [Latest changes](#latest-changes)\n  - [Versioning](#versioning)\n  - [Thank you](#thank-you)\n  - [Documentation](#documentation)\n  - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `Omics`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `Omics` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[omics]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[omics]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-omics\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-omics\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `boto3-stubs[omics]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[omics]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\n> \u26a0\ufe0f Due to slow PyCharm performance on `Literal` overloads (issue\n> [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended\n> to use [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/) until\n> the issue is resolved.\n\n> \u26a0\ufe0f If you experience slow performance and high CPU usage, try to disable\n> `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or\n> [pyright](https://github.com/microsoft/pyright) instead.\n\n> \u26a0\ufe0f To continue using `PyCharm` type checker, you can try to replace\n> `boto3-stubs` with\n> [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):\n\n```bash\npip uninstall boto3-stubs\npip install boto3-stubs-lite\n```\n\nInstall `boto3-stubs[omics]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[omics]'\n```\n\nBoth type checking and code completion should now work.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[omics]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n  [lsp](https://github.com/emacs-lsp/lsp-mode/),\n  [company](https://github.com/company-mode/company-mode) and\n  [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n  :ensure t\n  :hook (python-mode . (lambda ()\n                          (require 'lsp-pyright)\n                          (lsp)))  ; or lsp-deferred\n  :init (when (executable-find \"python3\")\n          (setq lsp-pyright-python-executable-cmd \"python3\"))\n  )\n```\n\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `boto3-stubs[omics]` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[omics]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs[omics]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[omics]'\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `boto3-stubs[omics]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[omics]'\n```\n\nOptionally, you can install `boto3-stubs` to `typings` directory.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`OmicsClient` provides annotations for `boto3.client(\"omics\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_omics import OmicsClient\n\nclient: OmicsClient = Session().client(\"omics\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`mypy_boto3_omics.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_omics import OmicsClient\nfrom mypy_boto3_omics.paginator import (\n    ListAnnotationImportJobsPaginator,\n    ListAnnotationStoreVersionsPaginator,\n    ListAnnotationStoresPaginator,\n    ListMultipartReadSetUploadsPaginator,\n    ListReadSetActivationJobsPaginator,\n    ListReadSetExportJobsPaginator,\n    ListReadSetImportJobsPaginator,\n    ListReadSetUploadPartsPaginator,\n    ListReadSetsPaginator,\n    ListReferenceImportJobsPaginator,\n    ListReferenceStoresPaginator,\n    ListReferencesPaginator,\n    ListRunCachesPaginator,\n    ListRunGroupsPaginator,\n    ListRunTasksPaginator,\n    ListRunsPaginator,\n    ListSequenceStoresPaginator,\n    ListSharesPaginator,\n    ListVariantImportJobsPaginator,\n    ListVariantStoresPaginator,\n    ListWorkflowsPaginator,\n)\n\nclient: OmicsClient = Session().client(\"omics\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nlist_annotation_import_jobs_paginator: ListAnnotationImportJobsPaginator = client.get_paginator(\n    \"list_annotation_import_jobs\"\n)\nlist_annotation_store_versions_paginator: ListAnnotationStoreVersionsPaginator = (\n    client.get_paginator(\"list_annotation_store_versions\")\n)\nlist_annotation_stores_paginator: ListAnnotationStoresPaginator = client.get_paginator(\n    \"list_annotation_stores\"\n)\nlist_multipart_read_set_uploads_paginator: ListMultipartReadSetUploadsPaginator = (\n    client.get_paginator(\"list_multipart_read_set_uploads\")\n)\nlist_read_set_activation_jobs_paginator: ListReadSetActivationJobsPaginator = client.get_paginator(\n    \"list_read_set_activation_jobs\"\n)\nlist_read_set_export_jobs_paginator: ListReadSetExportJobsPaginator = client.get_paginator(\n    \"list_read_set_export_jobs\"\n)\nlist_read_set_import_jobs_paginator: ListReadSetImportJobsPaginator = client.get_paginator(\n    \"list_read_set_import_jobs\"\n)\nlist_read_set_upload_parts_paginator: ListReadSetUploadPartsPaginator = client.get_paginator(\n    \"list_read_set_upload_parts\"\n)\nlist_read_sets_paginator: ListReadSetsPaginator = client.get_paginator(\"list_read_sets\")\nlist_reference_import_jobs_paginator: ListReferenceImportJobsPaginator = client.get_paginator(\n    \"list_reference_import_jobs\"\n)\nlist_reference_stores_paginator: ListReferenceStoresPaginator = client.get_paginator(\n    \"list_reference_stores\"\n)\nlist_references_paginator: ListReferencesPaginator = client.get_paginator(\"list_references\")\nlist_run_caches_paginator: ListRunCachesPaginator = client.get_paginator(\"list_run_caches\")\nlist_run_groups_paginator: ListRunGroupsPaginator = client.get_paginator(\"list_run_groups\")\nlist_run_tasks_paginator: ListRunTasksPaginator = client.get_paginator(\"list_run_tasks\")\nlist_runs_paginator: ListRunsPaginator = client.get_paginator(\"list_runs\")\nlist_sequence_stores_paginator: ListSequenceStoresPaginator = client.get_paginator(\n    \"list_sequence_stores\"\n)\nlist_shares_paginator: ListSharesPaginator = client.get_paginator(\"list_shares\")\nlist_variant_import_jobs_paginator: ListVariantImportJobsPaginator = client.get_paginator(\n    \"list_variant_import_jobs\"\n)\nlist_variant_stores_paginator: ListVariantStoresPaginator = client.get_paginator(\n    \"list_variant_stores\"\n)\nlist_workflows_paginator: ListWorkflowsPaginator = client.get_paginator(\"list_workflows\")\n```\n\n<a id=\"waiters-annotations\"></a>\n\n### Waiters annotations\n\n`mypy_boto3_omics.waiter` module contains type annotations for all waiters.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_omics import OmicsClient\nfrom mypy_boto3_omics.waiter import (\n    AnnotationImportJobCreatedWaiter,\n    AnnotationStoreCreatedWaiter,\n    AnnotationStoreDeletedWaiter,\n    AnnotationStoreVersionCreatedWaiter,\n    AnnotationStoreVersionDeletedWaiter,\n    ReadSetActivationJobCompletedWaiter,\n    ReadSetExportJobCompletedWaiter,\n    ReadSetImportJobCompletedWaiter,\n    ReferenceImportJobCompletedWaiter,\n    RunCompletedWaiter,\n    RunRunningWaiter,\n    TaskCompletedWaiter,\n    TaskRunningWaiter,\n    VariantImportJobCreatedWaiter,\n    VariantStoreCreatedWaiter,\n    VariantStoreDeletedWaiter,\n    WorkflowActiveWaiter,\n)\n\nclient: OmicsClient = Session().client(\"omics\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nannotation_import_job_created_waiter: AnnotationImportJobCreatedWaiter = client.get_waiter(\n    \"annotation_import_job_created\"\n)\nannotation_store_created_waiter: AnnotationStoreCreatedWaiter = client.get_waiter(\n    \"annotation_store_created\"\n)\nannotation_store_deleted_waiter: AnnotationStoreDeletedWaiter = client.get_waiter(\n    \"annotation_store_deleted\"\n)\nannotation_store_version_created_waiter: AnnotationStoreVersionCreatedWaiter = client.get_waiter(\n    \"annotation_store_version_created\"\n)\nannotation_store_version_deleted_waiter: AnnotationStoreVersionDeletedWaiter = client.get_waiter(\n    \"annotation_store_version_deleted\"\n)\nread_set_activation_job_completed_waiter: ReadSetActivationJobCompletedWaiter = client.get_waiter(\n    \"read_set_activation_job_completed\"\n)\nread_set_export_job_completed_waiter: ReadSetExportJobCompletedWaiter = client.get_waiter(\n    \"read_set_export_job_completed\"\n)\nread_set_import_job_completed_waiter: ReadSetImportJobCompletedWaiter = client.get_waiter(\n    \"read_set_import_job_completed\"\n)\nreference_import_job_completed_waiter: ReferenceImportJobCompletedWaiter = client.get_waiter(\n    \"reference_import_job_completed\"\n)\nrun_completed_waiter: RunCompletedWaiter = client.get_waiter(\"run_completed\")\nrun_running_waiter: RunRunningWaiter = client.get_waiter(\"run_running\")\ntask_completed_waiter: TaskCompletedWaiter = client.get_waiter(\"task_completed\")\ntask_running_waiter: TaskRunningWaiter = client.get_waiter(\"task_running\")\nvariant_import_job_created_waiter: VariantImportJobCreatedWaiter = client.get_waiter(\n    \"variant_import_job_created\"\n)\nvariant_store_created_waiter: VariantStoreCreatedWaiter = client.get_waiter(\"variant_store_created\")\nvariant_store_deleted_waiter: VariantStoreDeletedWaiter = client.get_waiter(\"variant_store_deleted\")\nworkflow_active_waiter: WorkflowActiveWaiter = client.get_waiter(\"workflow_active\")\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_omics.literals` module contains literals extracted from shapes that\ncan be used in user code for type checking.\n\nFull list of `Omics` Literals can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/literals/).\n\n```python\nfrom mypy_boto3_omics.literals import AcceleratorsType\n\n\ndef check_value(value: AcceleratorsType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`mypy_boto3_omics.type_defs` module contains structures and shapes assembled to\ntyped dictionaries and unions for additional type checking.\n\nFull list of `Omics` TypeDefs can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/type_defs/).\n\n```python\nfrom mypy_boto3_omics.type_defs import AbortMultipartReadSetUploadRequestRequestTypeDef\n\n\ndef get_value() -> AbortMultipartReadSetUploadRequestRequestTypeDef:\n    return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n  annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n  libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n  compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n  annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n  calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`mypy-boto3-omics` version is the same as related `boto3` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n  this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n  tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n  [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n  for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n  Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Type annotations for boto3 Omics 1.35.68 service generated with mypy-boto3-builder 8.3.1",
    "version": "1.35.68",
    "project_urls": {
        "Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_omics/",
        "Homepage": "https://github.com/youtype/mypy_boto3_builder",
        "Source": "https://github.com/youtype/mypy_boto3_builder",
        "Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
    },
    "split_keywords": [
        "boto3",
        "omics",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42a0e0cd94952a4219aa6769fef8cb0280d1bf1e49f9e90676936b026e3f287a",
                "md5": "5dee3e6f2dcb7e6d0d1d8ae6805bafe2",
                "sha256": "bcfa2ba719591c00af2cab7f55c5fd31aba7a9bcbc5195912865f2c6a3682dff"
            },
            "downloads": -1,
            "filename": "mypy_boto3_omics-1.35.68-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5dee3e6f2dcb7e6d0d1d8ae6805bafe2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 56846,
            "upload_time": "2024-11-22T20:34:49",
            "upload_time_iso_8601": "2024-11-22T20:34:49.118552Z",
            "url": "https://files.pythonhosted.org/packages/42/a0/e0cd94952a4219aa6769fef8cb0280d1bf1e49f9e90676936b026e3f287a/mypy_boto3_omics-1.35.68-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9cb93810870696646307f0bcc7caba1f9f7a7c8e78348eab2d6901710b75dc1f",
                "md5": "65f3c218ea4165071c2488139d05accb",
                "sha256": "fc8183aefd58ca4d1e7837dd413564c61ac034f3c2aa77e36ad49122d9065913"
            },
            "downloads": -1,
            "filename": "mypy_boto3_omics-1.35.68.tar.gz",
            "has_sig": false,
            "md5_digest": "65f3c218ea4165071c2488139d05accb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 48843,
            "upload_time": "2024-11-22T20:34:50",
            "upload_time_iso_8601": "2024-11-22T20:34:50.532426Z",
            "url": "https://files.pythonhosted.org/packages/9c/b9/3810870696646307f0bcc7caba1f9f7a7c8e78348eab2d6901710b75dc1f/mypy_boto3_omics-1.35.68.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-22 20:34:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "youtype",
    "github_project": "mypy_boto3_builder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mypy-boto3-omics"
}
Vlad Emelianov
Elapsed time: 0.55875s