mypy-boto3-clouddirectory
Type annotations for boto3 CloudDirectory 1.43.69 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 boto3-stubs page and in mypy-boto3-clouddirectory docs.
See how it helps you find and fix potential bugs:
- mypy-boto3-clouddirectory
How to install
Generate locally (recommended)
You can generate type annotations for boto3 package locally with
mypy-boto3-builder. Use
uv for build
isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.43.69' mypy-boto3-builder - Select
boto3-stubsAWS SDK. - Add
CloudDirectoryservice. - 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 CloudDirectory.
From PyPI with pip
Install boto3-stubs for CloudDirectory service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[clouddirectory]'
# 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[clouddirectory]'
# standalone installation
python -m pip install mypy-boto3-clouddirectory
How to uninstall
python -m pip uninstall -y mypy-boto3-clouddirectory
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylanceas your Python Language Server - Install
boto3-stubs[clouddirectory]in your environment:
python -m pip install 'boto3-stubs[clouddirectory]'
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
Literaloverloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.
⚠️ If you experience slow performance and high CPU usage, try to disable
PyCharmtype checker and use mypy or pyright instead.
⚠️ To continue using
PyCharmtype checker, you can try to replaceboto3-stubswith boto3-stubs-lite:
pip uninstall boto3-stubs
pip install boto3-stubs-lite
Install boto3-stubs[clouddirectory] in your environment:
python -m pip install 'boto3-stubs[clouddirectory]'
Both type checking and code completion should now work.
Emacs
- Install
boto3-stubswith services you use in your environment:
python -m pip install 'boto3-stubs[clouddirectory]'
- Install use-package, lsp, company and flycheck packages
- Install lsp-pyright package
(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.
Sublime Text
- Install
boto3-stubs[clouddirectory]with services you use in your environment:
python -m pip install 'boto3-stubs[clouddirectory]'
- Install LSP-pyright package
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
boto3-stubs[clouddirectory]in your environment:
python -m pip install 'boto3-stubs[clouddirectory]'
Type checking should now work. No explicit type annotations required, write
your boto3 code as usual.
pyright
- Install
pyright:npm i -g pyright - Install
boto3-stubs[clouddirectory]in your environment:
python -m pip install 'boto3-stubs[clouddirectory]'
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.
Pylint compatibility
It is totally safe to use TYPE_CHECKING flag in order to avoid
mypy-boto3-clouddirectory 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
EC2Client = object
EC2ServiceResource = object
BundleTaskCompleteWaiter = object
DescribeVolumesPaginator = object
...
Explicit type annotations
Client annotations
CloudDirectoryClient provides annotations for
boto3.client("clouddirectory").
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
client: CloudDirectoryClient = Session().client("clouddirectory")
# now client usage is checked by mypy and IDE should provide code completion
Paginators annotations
mypy_boto3_clouddirectory.paginator module contains type annotations for all
paginators.
from boto3.session import Session
from mypy_boto3_clouddirectory import CloudDirectoryClient
from mypy_boto3_clouddirectory.paginator import (
ListAppliedSchemaArnsPaginator,
ListAttachedIndicesPaginator,
ListDevelopmentSchemaArnsPaginator,
ListDirectoriesPaginator,
ListFacetAttributesPaginator,
ListFacetNamesPaginator,
ListIncomingTypedLinksPaginator,
ListIndexPaginator,
ListManagedSchemaArnsPaginator,
ListObjectAttributesPaginator,
ListObjectParentPathsPaginator,
ListObjectPoliciesPaginator,
ListOutgoingTypedLinksPaginator,
ListPolicyAttachmentsPaginator,
ListPublishedSchemaArnsPaginator,
ListTagsForResourcePaginator,
ListTypedLinkFacetAttributesPaginator,
ListTypedLinkFacetNamesPaginator,
LookupPolicyPaginator,
)
client: CloudDirectoryClient = Session().client("clouddirectory")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_applied_schema_arns_paginator: ListAppliedSchemaArnsPaginator = client.get_paginator(
"list_applied_schema_arns"
)
list_attached_indices_paginator: ListAttachedIndicesPaginator = client.get_paginator(
"list_attached_indices"
)
list_development_schema_arns_paginator: ListDevelopmentSchemaArnsPaginator = client.get_paginator(
"list_development_schema_arns"
)
list_directories_paginator: ListDirectoriesPaginator = client.get_paginator("list_directories")
list_facet_attributes_paginator: ListFacetAttributesPaginator = client.get_paginator(
"list_facet_attributes"
)
list_facet_names_paginator: ListFacetNamesPaginator = client.get_paginator("list_facet_names")
list_incoming_typed_links_paginator: ListIncomingTypedLinksPaginator = client.get_paginator(
"list_incoming_typed_links"
)
list_index_paginator: ListIndexPaginator = client.get_paginator("list_index")
list_managed_schema_arns_paginator: ListManagedSchemaArnsPaginator = client.get_paginator(
"list_managed_schema_arns"
)
list_object_attributes_paginator: ListObjectAttributesPaginator = client.get_paginator(
"list_object_attributes"
)
list_object_parent_paths_paginator: ListObjectParentPathsPaginator = client.get_paginator(
"list_object_parent_paths"
)
list_object_policies_paginator: ListObjectPoliciesPaginator = client.get_paginator(
"list_object_policies"
)
list_outgoing_typed_links_paginator: ListOutgoingTypedLinksPaginator = client.get_paginator(
"list_outgoing_typed_links"
)
list_policy_attachments_paginator: ListPolicyAttachmentsPaginator = client.get_paginator(
"list_policy_attachments"
)
list_published_schema_arns_paginator: ListPublishedSchemaArnsPaginator = client.get_paginator(
"list_published_schema_arns"
)
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
"list_tags_for_resource"
)
list_typed_link_facet_attributes_paginator: ListTypedLinkFacetAttributesPaginator = (
client.get_paginator("list_typed_link_facet_attributes")
)
list_typed_link_facet_names_paginator: ListTypedLinkFacetNamesPaginator = client.get_paginator(
"list_typed_link_facet_names"
)
lookup_policy_paginator: LookupPolicyPaginator = client.get_paginator("lookup_policy")
Literals
mypy_boto3_clouddirectory.literals module contains literals extracted from
shapes that can be used in user code for type checking.
Full list of CloudDirectory Literals can be found in
docs.
from mypy_boto3_clouddirectory.literals import BatchReadExceptionTypeType
def check_value(value: BatchReadExceptionTypeType) -> bool: ...
Type definitions
mypy_boto3_clouddirectory.type_defs module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.
Full list of CloudDirectory TypeDefs can be found in
docs.
# TypedDict usage example
from mypy_boto3_clouddirectory.type_defs import ObjectReferenceTypeDef
def get_value() -> ObjectReferenceTypeDef:
return {
"Selector": ...,
}
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
boto3services are covered. - Each public class and method of every
boto3service gets valid type annotations extracted frombotocoreschemas. - 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,aiobotocoreandaioboto3libraries mypy,pyright,VSCode,PyCharm,Sublime TextandEmacscompatibilityClient,ServiceResource,Resource,WaiterPaginatortype annotations for each service- Generated
TypeDefsfor each service - Generated
Literalsfor each service - Auto discovery of types for
boto3.clientandboto3.resourcecalls - Auto discovery of types for
session.clientandsession.resourcecalls - Auto discovery of types for
client.get_waiterandclient.get_paginatorcalls - Auto discovery of types for
ServiceResourceandResourcecollections - Auto discovery of types for
aiobotocore.Session.create_clientcalls
Latest changes
Builder changelog can be found in Releases.
Versioning
mypy-boto3-clouddirectory version is the same as related boto3 version and
follows
Python Packaging version specifiers.
Thank you
- Allie Fitter for boto3-type-annotations, this package is based on top of his work
- black developers for an awesome formatting tool
- Timothy Edmund Crosley for isort and how flexible it is
- mypy developers for doing all dirty work for us
- pyright team for the new era of typed Python
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mypy_boto3_clouddirectory-1.43.69.tar.gz.
File metadata
- Download URL: mypy_boto3_clouddirectory-1.43.69.tar.gz
- Upload date:
- Size: 39.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
886588b06dadecb4b880c6cd0153f26abadcf2a9a1b6995ea6cfce843227636e
|
|
| MD5 |
efd8b9598e4e3375a54d47f1d26e1e2d
|
|
| BLAKE2b-256 |
cc58b8eb89f1c7b93e830e7dab8e96219952a021ca1b1c9e2c9e545ab427fe77
|
File details
Details for the file mypy_boto3_clouddirectory-1.43.69-py3-none-any.whl.
File metadata
- Download URL: mypy_boto3_clouddirectory-1.43.69-py3-none-any.whl
- Upload date:
- Size: 44.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
935b1cb6f61201aaa2a17763ace21352cac842f30277e6814a7a988e06cfd437
|
|
| MD5 |
a52781b7aa23877fda4b40f19aea9553
|
|
| BLAKE2b-256 |
62eccbc2e53348ea88aa7c91ac7c56798a70ccbd566a0691861c969bf4483c50
|
