Type annotations for boto3.WorkDocs 1.13.26 service, generated by mypy-boto3-buider 2.0.3
Project description
mypy-boto3-workdocs
Type annotations for boto3.WorkDocs 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.3.
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]
# update installed packages index for automated type discovery
python -m mypy_boto3
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")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_workdocs
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
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 carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_workdocs as workdocs
from mypy_boto3_workdocs import WorkDocsClient
# with these
from mypy_boto3 import workdocs
from mypy_boto3.workdocs import WorkDocsClient
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.13.26.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f7ba0bc056e4ad0e05ef7258cd4846adb2b18946b63a7168a44470df87e73f8 |
|
MD5 | 76e1d1ae5aa99d8a42b938397f4cb766 |
|
BLAKE2b-256 | 5ca5bcdac4b7d3c430d9c70cc7fa5b3a7880427c4aa98678b7e7f6bc92a56e62 |
Hashes for mypy_boto3_workdocs-1.13.26.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5c0a8f374be07a9a936e3bde2876df629b2a46bc28be82e4cfe4f1cfea4bcd9 |
|
MD5 | be5a730100b29adf0e5fc74668bb212a |
|
BLAKE2b-256 | 295437ecbf4e9e7198c6d1b42fb988b444d771b738f629bcab338e44c0be6e91 |