mypy-boto3-cloudformation


Namemypy-boto3-cloudformation JSON
Version 1.35.64 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for boto3 CloudFormation 1.35.64 service generated with mypy-boto3-builder 8.3.0
upload_time2024-11-18 20:38:47
maintainerNone
docs_urlNone
authorVlad Emelianov
requires_python>=3.8
licenseMIT License
keywords boto3 cloudformation 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-cloudformation"></a>

# mypy-boto3-cloudformation

[![PyPI - mypy-boto3-cloudformation](https://img.shields.io/pypi/v/mypy-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudformation/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudformation/)
[![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-cloudformation)](https://pypistats.org/packages/mypy-boto3-cloudformation)

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

Type annotations for
[boto3 CloudFormation 1.35.64](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.0](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-cloudformation docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/).

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-cloudformation](#mypy-boto3-cloudformation)
  - [How to install](#how-to-install)
    - [VSCode extension](#vscode-extension)
    - [From PyPI with pip](#from-pypi-with-pip)
    - [From conda-forge](#from-conda-forge)
  - [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)
    - [Service Resource annotations](#service-resource-annotations)
    - [Other resources annotations](#other-resources-annotations)
    - [Collections annotations](#collections-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 `CloudFormation`.

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

### From PyPI with pip

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

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


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


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

<a id="from-conda-forge"></a>

### From conda-forge

Installing `mypy-boto3-cloudformation` from the `conda-forge` channel can be
achieved by adding `conda-forge` to your channels with:

```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
```

Once the `conda-forge` channel has been enabled, `mypy-boto3-cloudformation`
can be installed with:

```bash
conda install mypy-boto3-cloudformation
```

It is possible to list all of the versions of `mypy-boto3-cloudformation`
available on your platform with:

```bash
conda search mypy-boto3-cloudformation --channel conda-forge
```

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

## How to uninstall

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

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

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

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

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

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[cloudformation]'
```

- 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[cloudformation]` with services you use in your
  environment:

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

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

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

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

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

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

`CloudFormationClient` provides annotations for
`boto3.client("cloudformation")`.

```python
from boto3.session import Session

from mypy_boto3_cloudformation import CloudFormationClient

client: CloudFormationClient = Session().client("cloudformation")

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

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

### Paginators annotations

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

```python
from boto3.session import Session

from mypy_boto3_cloudformation import CloudFormationClient
from mypy_boto3_cloudformation.paginator import (
    DescribeAccountLimitsPaginator,
    DescribeChangeSetPaginator,
    DescribeStackEventsPaginator,
    DescribeStacksPaginator,
    ListChangeSetsPaginator,
    ListExportsPaginator,
    ListGeneratedTemplatesPaginator,
    ListImportsPaginator,
    ListResourceScanRelatedResourcesPaginator,
    ListResourceScanResourcesPaginator,
    ListResourceScansPaginator,
    ListStackInstancesPaginator,
    ListStackResourcesPaginator,
    ListStackSetOperationResultsPaginator,
    ListStackSetOperationsPaginator,
    ListStackSetsPaginator,
    ListStacksPaginator,
    ListTypesPaginator,
)

client: CloudFormationClient = Session().client("cloudformation")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_account_limits_paginator: DescribeAccountLimitsPaginator = client.get_paginator(
    "describe_account_limits"
)
describe_change_set_paginator: DescribeChangeSetPaginator = client.get_paginator(
    "describe_change_set"
)
describe_stack_events_paginator: DescribeStackEventsPaginator = client.get_paginator(
    "describe_stack_events"
)
describe_stacks_paginator: DescribeStacksPaginator = client.get_paginator("describe_stacks")
list_change_sets_paginator: ListChangeSetsPaginator = client.get_paginator("list_change_sets")
list_exports_paginator: ListExportsPaginator = client.get_paginator("list_exports")
list_generated_templates_paginator: ListGeneratedTemplatesPaginator = client.get_paginator(
    "list_generated_templates"
)
list_imports_paginator: ListImportsPaginator = client.get_paginator("list_imports")
list_resource_scan_related_resources_paginator: ListResourceScanRelatedResourcesPaginator = (
    client.get_paginator("list_resource_scan_related_resources")
)
list_resource_scan_resources_paginator: ListResourceScanResourcesPaginator = client.get_paginator(
    "list_resource_scan_resources"
)
list_resource_scans_paginator: ListResourceScansPaginator = client.get_paginator(
    "list_resource_scans"
)
list_stack_instances_paginator: ListStackInstancesPaginator = client.get_paginator(
    "list_stack_instances"
)
list_stack_resources_paginator: ListStackResourcesPaginator = client.get_paginator(
    "list_stack_resources"
)
list_stack_set_operation_results_paginator: ListStackSetOperationResultsPaginator = (
    client.get_paginator("list_stack_set_operation_results")
)
list_stack_set_operations_paginator: ListStackSetOperationsPaginator = client.get_paginator(
    "list_stack_set_operations"
)
list_stack_sets_paginator: ListStackSetsPaginator = client.get_paginator("list_stack_sets")
list_stacks_paginator: ListStacksPaginator = client.get_paginator("list_stacks")
list_types_paginator: ListTypesPaginator = client.get_paginator("list_types")
```

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

### Waiters annotations

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

```python
from boto3.session import Session

from mypy_boto3_cloudformation import CloudFormationClient
from mypy_boto3_cloudformation.waiter import (
    ChangeSetCreateCompleteWaiter,
    StackCreateCompleteWaiter,
    StackDeleteCompleteWaiter,
    StackExistsWaiter,
    StackImportCompleteWaiter,
    StackRollbackCompleteWaiter,
    StackUpdateCompleteWaiter,
    TypeRegistrationCompleteWaiter,
)

client: CloudFormationClient = Session().client("cloudformation")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
change_set_create_complete_waiter: ChangeSetCreateCompleteWaiter = client.get_waiter(
    "change_set_create_complete"
)
stack_create_complete_waiter: StackCreateCompleteWaiter = client.get_waiter("stack_create_complete")
stack_delete_complete_waiter: StackDeleteCompleteWaiter = client.get_waiter("stack_delete_complete")
stack_exists_waiter: StackExistsWaiter = client.get_waiter("stack_exists")
stack_import_complete_waiter: StackImportCompleteWaiter = client.get_waiter("stack_import_complete")
stack_rollback_complete_waiter: StackRollbackCompleteWaiter = client.get_waiter(
    "stack_rollback_complete"
)
stack_update_complete_waiter: StackUpdateCompleteWaiter = client.get_waiter("stack_update_complete")
type_registration_complete_waiter: TypeRegistrationCompleteWaiter = client.get_waiter(
    "type_registration_complete"
)
```

<a id="service-resource-annotations"></a>

### Service Resource annotations

`CloudFormationServiceResource` provides annotations for
`boto3.resource("cloudformation")`.

```python
from boto3.session import Session

from mypy_boto3_cloudformation import CloudFormationServiceResource

resource: CloudFormationServiceResource = Session().resource("cloudformation")

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

<a id="other-resources-annotations"></a>

### Other resources annotations

`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all resources.

```python
from boto3.session import Session

from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_boto3_cloudformation.service_resource import (
    Event,
    Stack,
    StackResource,
    StackResourceSummary,
)

resource: CloudFormationServiceResource = Session().resource("cloudformation")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_event: Event = resource.Event(...)
my_stack: Stack = resource.Stack(...)
my_stack_resource: StackResource = resource.StackResource(...)
my_stack_resource_summary: StackResourceSummary = resource.StackResourceSummary(...)
```

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

### Collections annotations

`mypy_boto3_cloudformation.service_resource` module contains type annotations
for all `CloudFormationServiceResource` collections.

```python
from boto3.session import Session

from mypy_boto3_cloudformation import CloudFormationServiceResource
from mypy_boto3_cloudformation.service_resource import ServiceResourceStacksCollection

resource: CloudFormationServiceResource = Session().resource("cloudformation")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
stacks: cloudformation_resources.ServiceResourceStacksCollection = resource.stacks
```

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

### Literals

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

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

```python
from mypy_boto3_cloudformation.literals import AccountFilterTypeType


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

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

### Type definitions

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

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

```python
from mypy_boto3_cloudformation.type_defs import AccountGateResultTypeDef


def get_value() -> AccountGateResultTypeDef:
    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-cloudformation` 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_cloudformation/)

<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-cloudformation",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "boto3 cloudformation type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/4f/97/04c21049fb94ea9b5dc52cb5350042b822a5e3f8495e06403e442abc510a/mypy_boto3_cloudformation-1.35.64.tar.gz",
    "platform": null,
    "description": "<a id=\"mypy-boto3-cloudformation\"></a>\n\n# mypy-boto3-cloudformation\n\n[![PyPI - mypy-boto3-cloudformation](https://img.shields.io/pypi/v/mypy-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudformation/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cloudformation.svg?color=blue)](https://pypi.org/project/mypy-boto3-cloudformation/)\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-cloudformation)](https://pypistats.org/packages/mypy-boto3-cloudformation)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3 CloudFormation 1.35.64](https://pypi.org/project/boto3/) compatible with\n[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.0](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-cloudformation docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/).\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-cloudformation](#mypy-boto3-cloudformation)\n  - [How to install](#how-to-install)\n    - [VSCode extension](#vscode-extension)\n    - [From PyPI with pip](#from-pypi-with-pip)\n    - [From conda-forge](#from-conda-forge)\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    - [Service Resource annotations](#service-resource-annotations)\n    - [Other resources annotations](#other-resources-annotations)\n    - [Collections annotations](#collections-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 `CloudFormation`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `CloudFormation` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[cloudformation]'\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[cloudformation]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-cloudformation\n```\n\n<a id=\"from-conda-forge\"></a>\n\n### From conda-forge\n\nInstalling `mypy-boto3-cloudformation` from the `conda-forge` channel can be\nachieved by adding `conda-forge` to your channels with:\n\n```bash\nconda config --add channels conda-forge\nconda config --set channel_priority strict\n```\n\nOnce the `conda-forge` channel has been enabled, `mypy-boto3-cloudformation`\ncan be installed with:\n\n```bash\nconda install mypy-boto3-cloudformation\n```\n\nIt is possible to list all of the versions of `mypy-boto3-cloudformation`\navailable on your platform with:\n\n```bash\nconda search mypy-boto3-cloudformation --channel conda-forge\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-cloudformation\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[cloudformation]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[cloudformation]'\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[cloudformation]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[cloudformation]'\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[cloudformation]'\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[cloudformation]` with services you use in your\n  environment:\n\n```bash\npython -m pip install 'boto3-stubs[cloudformation]'\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[cloudformation]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[cloudformation]'\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[cloudformation]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[cloudformation]'\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`CloudFormationClient` provides annotations for\n`boto3.client(\"cloudformation\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_cloudformation import CloudFormationClient\n\nclient: CloudFormationClient = Session().client(\"cloudformation\")\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_cloudformation.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_cloudformation import CloudFormationClient\nfrom mypy_boto3_cloudformation.paginator import (\n    DescribeAccountLimitsPaginator,\n    DescribeChangeSetPaginator,\n    DescribeStackEventsPaginator,\n    DescribeStacksPaginator,\n    ListChangeSetsPaginator,\n    ListExportsPaginator,\n    ListGeneratedTemplatesPaginator,\n    ListImportsPaginator,\n    ListResourceScanRelatedResourcesPaginator,\n    ListResourceScanResourcesPaginator,\n    ListResourceScansPaginator,\n    ListStackInstancesPaginator,\n    ListStackResourcesPaginator,\n    ListStackSetOperationResultsPaginator,\n    ListStackSetOperationsPaginator,\n    ListStackSetsPaginator,\n    ListStacksPaginator,\n    ListTypesPaginator,\n)\n\nclient: CloudFormationClient = Session().client(\"cloudformation\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\ndescribe_account_limits_paginator: DescribeAccountLimitsPaginator = client.get_paginator(\n    \"describe_account_limits\"\n)\ndescribe_change_set_paginator: DescribeChangeSetPaginator = client.get_paginator(\n    \"describe_change_set\"\n)\ndescribe_stack_events_paginator: DescribeStackEventsPaginator = client.get_paginator(\n    \"describe_stack_events\"\n)\ndescribe_stacks_paginator: DescribeStacksPaginator = client.get_paginator(\"describe_stacks\")\nlist_change_sets_paginator: ListChangeSetsPaginator = client.get_paginator(\"list_change_sets\")\nlist_exports_paginator: ListExportsPaginator = client.get_paginator(\"list_exports\")\nlist_generated_templates_paginator: ListGeneratedTemplatesPaginator = client.get_paginator(\n    \"list_generated_templates\"\n)\nlist_imports_paginator: ListImportsPaginator = client.get_paginator(\"list_imports\")\nlist_resource_scan_related_resources_paginator: ListResourceScanRelatedResourcesPaginator = (\n    client.get_paginator(\"list_resource_scan_related_resources\")\n)\nlist_resource_scan_resources_paginator: ListResourceScanResourcesPaginator = client.get_paginator(\n    \"list_resource_scan_resources\"\n)\nlist_resource_scans_paginator: ListResourceScansPaginator = client.get_paginator(\n    \"list_resource_scans\"\n)\nlist_stack_instances_paginator: ListStackInstancesPaginator = client.get_paginator(\n    \"list_stack_instances\"\n)\nlist_stack_resources_paginator: ListStackResourcesPaginator = client.get_paginator(\n    \"list_stack_resources\"\n)\nlist_stack_set_operation_results_paginator: ListStackSetOperationResultsPaginator = (\n    client.get_paginator(\"list_stack_set_operation_results\")\n)\nlist_stack_set_operations_paginator: ListStackSetOperationsPaginator = client.get_paginator(\n    \"list_stack_set_operations\"\n)\nlist_stack_sets_paginator: ListStackSetsPaginator = client.get_paginator(\"list_stack_sets\")\nlist_stacks_paginator: ListStacksPaginator = client.get_paginator(\"list_stacks\")\nlist_types_paginator: ListTypesPaginator = client.get_paginator(\"list_types\")\n```\n\n<a id=\"waiters-annotations\"></a>\n\n### Waiters annotations\n\n`mypy_boto3_cloudformation.waiter` module contains type annotations for all\nwaiters.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_cloudformation import CloudFormationClient\nfrom mypy_boto3_cloudformation.waiter import (\n    ChangeSetCreateCompleteWaiter,\n    StackCreateCompleteWaiter,\n    StackDeleteCompleteWaiter,\n    StackExistsWaiter,\n    StackImportCompleteWaiter,\n    StackRollbackCompleteWaiter,\n    StackUpdateCompleteWaiter,\n    TypeRegistrationCompleteWaiter,\n)\n\nclient: CloudFormationClient = Session().client(\"cloudformation\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nchange_set_create_complete_waiter: ChangeSetCreateCompleteWaiter = client.get_waiter(\n    \"change_set_create_complete\"\n)\nstack_create_complete_waiter: StackCreateCompleteWaiter = client.get_waiter(\"stack_create_complete\")\nstack_delete_complete_waiter: StackDeleteCompleteWaiter = client.get_waiter(\"stack_delete_complete\")\nstack_exists_waiter: StackExistsWaiter = client.get_waiter(\"stack_exists\")\nstack_import_complete_waiter: StackImportCompleteWaiter = client.get_waiter(\"stack_import_complete\")\nstack_rollback_complete_waiter: StackRollbackCompleteWaiter = client.get_waiter(\n    \"stack_rollback_complete\"\n)\nstack_update_complete_waiter: StackUpdateCompleteWaiter = client.get_waiter(\"stack_update_complete\")\ntype_registration_complete_waiter: TypeRegistrationCompleteWaiter = client.get_waiter(\n    \"type_registration_complete\"\n)\n```\n\n<a id=\"service-resource-annotations\"></a>\n\n### Service Resource annotations\n\n`CloudFormationServiceResource` provides annotations for\n`boto3.resource(\"cloudformation\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_cloudformation import CloudFormationServiceResource\n\nresource: CloudFormationServiceResource = Session().resource(\"cloudformation\")\n\n# now resource usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"other-resources-annotations\"></a>\n\n### Other resources annotations\n\n`mypy_boto3_cloudformation.service_resource` module contains type annotations\nfor all resources.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_cloudformation import CloudFormationServiceResource\nfrom mypy_boto3_cloudformation.service_resource import (\n    Event,\n    Stack,\n    StackResource,\n    StackResourceSummary,\n)\n\nresource: CloudFormationServiceResource = Session().resource(\"cloudformation\")\n\n# Explicit type annotations are optional here\n# Type should be correctly discovered by mypy and IDEs\nmy_event: Event = resource.Event(...)\nmy_stack: Stack = resource.Stack(...)\nmy_stack_resource: StackResource = resource.StackResource(...)\nmy_stack_resource_summary: StackResourceSummary = resource.StackResourceSummary(...)\n```\n\n<a id=\"collections-annotations\"></a>\n\n### Collections annotations\n\n`mypy_boto3_cloudformation.service_resource` module contains type annotations\nfor all `CloudFormationServiceResource` collections.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_cloudformation import CloudFormationServiceResource\nfrom mypy_boto3_cloudformation.service_resource import ServiceResourceStacksCollection\n\nresource: CloudFormationServiceResource = Session().resource(\"cloudformation\")\n\n# Explicit type annotations are optional here\n# Type should be correctly discovered by mypy and IDEs\nstacks: cloudformation_resources.ServiceResourceStacksCollection = resource.stacks\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_cloudformation.literals` module contains literals extracted from\nshapes that can be used in user code for type checking.\n\nFull list of `CloudFormation` Literals can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/literals/).\n\n```python\nfrom mypy_boto3_cloudformation.literals import AccountFilterTypeType\n\n\ndef check_value(value: AccountFilterTypeType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`mypy_boto3_cloudformation.type_defs` module contains structures and shapes\nassembled to typed dictionaries and unions for additional type checking.\n\nFull list of `CloudFormation` TypeDefs can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/type_defs/).\n\n```python\nfrom mypy_boto3_cloudformation.type_defs import AccountGateResultTypeDef\n\n\ndef get_value() -> AccountGateResultTypeDef:\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-cloudformation` version is the same as related `boto3` version and\nfollows [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_cloudformation/)\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 CloudFormation 1.35.64 service generated with mypy-boto3-builder 8.3.0",
    "version": "1.35.64",
    "project_urls": {
        "Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cloudformation/",
        "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",
        "cloudformation",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9c3c7de8091b98747e134c68f94442ea906b1ee91e7b3e1831088b708e2da85",
                "md5": "eeafd6b49607952b5cc1d88d9c454793",
                "sha256": "aba213f3411a65096a8d95633c36e0c57a775ac6ac9ccf1e6fd9bea4002073bc"
            },
            "downloads": -1,
            "filename": "mypy_boto3_cloudformation-1.35.64-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eeafd6b49607952b5cc1d88d9c454793",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 65168,
            "upload_time": "2024-11-18T20:38:41",
            "upload_time_iso_8601": "2024-11-18T20:38:41.090461Z",
            "url": "https://files.pythonhosted.org/packages/f9/c3/c7de8091b98747e134c68f94442ea906b1ee91e7b3e1831088b708e2da85/mypy_boto3_cloudformation-1.35.64-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4f9704c21049fb94ea9b5dc52cb5350042b822a5e3f8495e06403e442abc510a",
                "md5": "60595d13e3f1362a7c8ca382e9c49390",
                "sha256": "d1a1500df811ac8ebd459640f5b31c14daac784d8a00fc4f67bc6eb391e7b5a8"
            },
            "downloads": -1,
            "filename": "mypy_boto3_cloudformation-1.35.64.tar.gz",
            "has_sig": false,
            "md5_digest": "60595d13e3f1362a7c8ca382e9c49390",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 53575,
            "upload_time": "2024-11-18T20:38:47",
            "upload_time_iso_8601": "2024-11-18T20:38:47.628872Z",
            "url": "https://files.pythonhosted.org/packages/4f/97/04c21049fb94ea9b5dc52cb5350042b822a5e3f8495e06403e442abc510a/mypy_boto3_cloudformation-1.35.64.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-18 20:38:47",
    "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-cloudformation"
}
Vlad Emelianov
Elapsed time: 0.43054s