Type annotations for boto3.WorkDocs 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-workdocs
Type annotations for boto3.WorkDocs 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for WorkDocs
service.
python -m pip install boto3-stubs[workdocs]
Use boto3
with mypy_boto3_workdocs
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_workdocs import WorkDocsClient
# Now mypy can check if your code is valid.
client: WorkDocsClient = boto3.client("workdocs")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: WorkDocsClient = session.client("workdocs")
# Annotated paginators are included as well
import mypy_boto3_workdocs.paginator as workdocs_paginators
describe_activities_paginator: workdocs_paginators.DescribeActivitiesPaginator = client.get_paginator("describe_activities")
describe_comments_paginator: workdocs_paginators.DescribeCommentsPaginator = client.get_paginator("describe_comments")
describe_document_versions_paginator: workdocs_paginators.DescribeDocumentVersionsPaginator = client.get_paginator("describe_document_versions")
describe_folder_contents_paginator: workdocs_paginators.DescribeFolderContentsPaginator = client.get_paginator("describe_folder_contents")
describe_groups_paginator: workdocs_paginators.DescribeGroupsPaginator = client.get_paginator("describe_groups")
describe_notification_subscriptions_paginator: workdocs_paginators.DescribeNotificationSubscriptionsPaginator = client.get_paginator("describe_notification_subscriptions")
describe_resource_permissions_paginator: workdocs_paginators.DescribeResourcePermissionsPaginator = client.get_paginator("describe_resource_permissions")
describe_root_folders_paginator: workdocs_paginators.DescribeRootFoldersPaginator = client.get_paginator("describe_root_folders")
describe_users_paginator: workdocs_paginators.DescribeUsersPaginator = client.get_paginator("describe_users")
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_workdocs
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("workdocs")
session_client = boto3.Session().client("workdocs")
Project details
Release history Release notifications | RSS feed
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
Hashes for mypy-boto3-workdocs-1.14.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10a1879f3bd2fe0a218b82a0d1b6baa7fd29cd7a3e8efd94343120313cfa0a79 |
|
MD5 | ad13ea4f65c52d0300fefb1abea0b837 |
|
BLAKE2b-256 | c3e5bcece5c484c929583c2ff23ae69105406988fc82d4a5c9ff763d57f09141 |
Hashes for mypy_boto3_workdocs-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2551e645810f2f8144ffed36f76d146feec5d6dd3e8be4eed79a48d09a71f095 |
|
MD5 | 9b1589b6f8a0810f75ebb2d90af4ddbb |
|
BLAKE2b-256 | 76d88170657f1d9f72c8d93a2e9e67342efcea8a2d23f1147a59ad7b086a59b7 |