{"author":"Vlad Emelianov","author_email":"vlad.emelianov.nz@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Console","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Natural Language :: English","Operating System :: OS Independent","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.14","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Typing :: Stubs Only"],"description":"\n\n# mypy-boto3-workdocs\n\n[![PyPI - mypy-boto3-workdocs](https://img.shields.io/pypi/v/mypy-boto3-workdocs.svg?color=blue)](https://pypi.org/project/mypy-boto3-workdocs/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-workdocs.svg?color=blue)](https://pypi.org/project/mypy-boto3-workdocs/)\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-workdocs)](https://pypistats.org/packages/mypy-boto3-workdocs)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for [boto3 WorkDocs 1.38.0](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 with\n[mypy-boto3-builder 8.10.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-workdocs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_workdocs/).\n\nSee how it helps you find and fix potential bugs:\n\n![types-boto3 demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [mypy-boto3-workdocs](#mypy-boto3-workdocs)\n - [How to install](#how-to-install)\n - [Generate locally (recommended)](<#generate-locally-(recommended)>)\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 - [Pylint compatibility](#pylint-compatibility)\n - [Explicit type annotations](#explicit-type-annotations)\n - [Client annotations](#client-annotations)\n - [Paginators annotations](#paginators-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\n\n## How to install\n\n\n\n### Generate locally (recommended)\n\nYou can generate type annotations for `boto3` package locally with\n`mypy-boto3-builder`. Use\n[uv](https://docs.astral.sh/uv/getting-started/installation/) for build\nisolation.\n\n1. Run mypy-boto3-builder in your package root directory:\n `uvx --with 'boto3==1.38.0' mypy-boto3-builder`\n2. Select `boto3-stubs` AWS SDK.\n3. Add `WorkDocs` service.\n4. Use provided commands to install generated packages.\n\n\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 `WorkDocs`.\n\n\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `WorkDocs` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[workdocs]'\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[workdocs]'\n\n# standalone installation\npython -m pip install mypy-boto3-workdocs\n```\n\n\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-workdocs\n```\n\n\n\n## Usage\n\n\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[workdocs]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[workdocs]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n\n\n### PyCharm\n\n> ⚠️ 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> ⚠️ 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> ⚠️ 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[workdocs]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[workdocs]'\n```\n\nBoth type checking and code completion should now work.\n\n\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[workdocs]'\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\n\n### Sublime Text\n\n- Install `boto3-stubs[workdocs]` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[workdocs]'\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\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs[workdocs]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[workdocs]'\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `boto3-stubs[workdocs]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[workdocs]'\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\n\n### Pylint compatibility\n\nIt is totally safe to use `TYPE_CHECKING` flag in order to avoid\n`mypy-boto3-workdocs` dependency in production. However, there is an issue in\n`pylint` that it complains about undefined variables. To fix it, set all types\nto `object` in non-`TYPE_CHECKING` mode.\n\n```python\nfrom typing import TYPE_CHECKING\n\nif TYPE_CHECKING:\n from mypy_boto3_ec2 import EC2Client, EC2ServiceResource\n from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter\n from mypy_boto3_ec2.paginators import DescribeVolumesPaginator\nelse:\n EC2Client = object\n EC2ServiceResource = object\n BundleTaskCompleteWaiter = object\n DescribeVolumesPaginator = object\n\n...\n```\n\n\n\n## Explicit type annotations\n\n\n\n### Client annotations\n\n`WorkDocsClient` provides annotations for `boto3.client(\"workdocs\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_workdocs import WorkDocsClient\n\nclient: WorkDocsClient = Session().client(\"workdocs\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n\n\n### Paginators annotations\n\n`mypy_boto3_workdocs.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_workdocs import WorkDocsClient\nfrom mypy_boto3_workdocs.paginator import (\n DescribeActivitiesPaginator,\n DescribeCommentsPaginator,\n DescribeDocumentVersionsPaginator,\n DescribeFolderContentsPaginator,\n DescribeGroupsPaginator,\n DescribeNotificationSubscriptionsPaginator,\n DescribeResourcePermissionsPaginator,\n DescribeRootFoldersPaginator,\n DescribeUsersPaginator,\n SearchResourcesPaginator,\n)\n\nclient: WorkDocsClient = Session().client(\"workdocs\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\ndescribe_activities_paginator: DescribeActivitiesPaginator = client.get_paginator(\n \"describe_activities\"\n)\ndescribe_comments_paginator: DescribeCommentsPaginator = client.get_paginator(\"describe_comments\")\ndescribe_document_versions_paginator: DescribeDocumentVersionsPaginator = client.get_paginator(\n \"describe_document_versions\"\n)\ndescribe_folder_contents_paginator: DescribeFolderContentsPaginator = client.get_paginator(\n \"describe_folder_contents\"\n)\ndescribe_groups_paginator: DescribeGroupsPaginator = client.get_paginator(\"describe_groups\")\ndescribe_notification_subscriptions_paginator: DescribeNotificationSubscriptionsPaginator = (\n client.get_paginator(\"describe_notification_subscriptions\")\n)\ndescribe_resource_permissions_paginator: DescribeResourcePermissionsPaginator = (\n client.get_paginator(\"describe_resource_permissions\")\n)\ndescribe_root_folders_paginator: DescribeRootFoldersPaginator = client.get_paginator(\n \"describe_root_folders\"\n)\ndescribe_users_paginator: DescribeUsersPaginator = client.get_paginator(\"describe_users\")\nsearch_resources_paginator: SearchResourcesPaginator = client.get_paginator(\"search_resources\")\n```\n\n\n\n### Literals\n\n`mypy_boto3_workdocs.literals` module contains literals extracted from shapes\nthat can be used in user code for type checking.\n\nFull list of `WorkDocs` Literals can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_workdocs/literals/).\n\n```python\nfrom mypy_boto3_workdocs.literals import ActivityTypeType\n\n\ndef check_value(value: ActivityTypeType) -> bool: ...\n```\n\n\n\n### Type definitions\n\n`mypy_boto3_workdocs.type_defs` module contains structures and shapes assembled\nto typed dictionaries and unions for additional type checking.\n\nFull list of `WorkDocs` TypeDefs can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_workdocs/type_defs/).\n\n```python\n# TypedDict usage example\nfrom mypy_boto3_workdocs.type_defs import AbortDocumentVersionUploadRequestTypeDef\n\n\ndef get_value() -> AbortDocumentVersionUploadRequestTypeDef:\n return {\n \"DocumentId\": ...,\n }\n```\n\n\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\n\n## What's new\n\n\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\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n\n\n## Versioning\n\n`mypy-boto3-workdocs` version is the same as related `boto3` version and\nfollows\n[Python Packaging version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).\n\n\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\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_workdocs/)\n\n\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","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Author","Author-Email","Classifier","Description","Description-Content-Type","Home-Page","Keywords","License","License-File","Project-Url","Requires-Dist","Requires-Python","Summary"],"home_page":"https://github.com/youtype/mypy_boto3_builder","keywords":"boto3 workdocs boto3-stubs type-annotations mypy typeshed autocomplete","license":"MIT License","license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"mypy-boto3-workdocs","package_url":"https://pypi.org/project/mypy-boto3-workdocs/","platform":null,"project_url":"https://pypi.org/project/mypy-boto3-workdocs/","project_urls":{"Documentation":"https://youtype.github.io/boto3_stubs_docs/mypy_boto3_workdocs/","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"},"provides_extra":null,"release_url":"https://pypi.org/project/mypy-boto3-workdocs/1.38.0/","requires_dist":["typing-extensions; python_version < \"3.12\""],"requires_python":">=3.8","summary":"Type annotations for boto3 WorkDocs 1.38.0 service generated with mypy-boto3-builder 8.10.1","version":"1.38.0","yanked":false,"yanked_reason":null}

Package search

mypy-boto3-workdocs

project_urls

Dependencies

All package metadata

Releases