Type annotations for boto3.WorkDocs 1.11.11 service, generated by mypy-boto3-buider 1.0.0
Project description
mypy-boto3-workdocs
Type annotations for boto3.WorkDocs 1.11.11 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 1.0.0.
More information can be found on boto3-stubs page.
How to use
Type checking
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for WorkDocs
service.
python -m pip install boto3-stubs[mypy-boto3-workdocs]
Use boto3
with mypy_boto3
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3 import workdocs
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_workdocs as workdocs
# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("workdocs")
client: workdocs.WorkDocsClient = boto3.client("workdocs")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: workdocs.WorkDocsClient = session.client("workdocs")
# Paginators need type annotation on creation
describe_activities_paginator: workdocs.DescribeActivitiesPaginator = client.get_paginator("describe_activities")
describe_comments_paginator: workdocs.DescribeCommentsPaginator = client.get_paginator("describe_comments")
describe_document_versions_paginator: workdocs.DescribeDocumentVersionsPaginator = client.get_paginator("describe_document_versions")
describe_folder_contents_paginator: workdocs.DescribeFolderContentsPaginator = client.get_paginator("describe_folder_contents")
describe_groups_paginator: workdocs.DescribeGroupsPaginator = client.get_paginator("describe_groups")
describe_notification_subscriptions_paginator: workdocs.DescribeNotificationSubscriptionsPaginator = client.get_paginator("describe_notification_subscriptions")
describe_resource_permissions_paginator: workdocs.DescribeResourcePermissionsPaginator = client.get_paginator("describe_resource_permissions")
describe_root_folders_paginator: workdocs.DescribeRootFoldersPaginator = client.get_paginator("describe_root_folders")
describe_users_paginator: workdocs.DescribeUsersPaginator = client.get_paginator("describe_users")
How it works
Fully automated builder carefully generates
type annotations for each service, patiently waiting for boto3
updates. It delivers
a 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 the documentation (blamebotocore
docs if types are incorrect). - Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by black for readability.
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
Hashes for mypy-boto3-workdocs-1.11.11.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c9d8e2d35c9f5523c0237fc157dc407ff608469c6baae860afc6d22390d9cb7 |
|
MD5 | da81119ce192e042f22d1ea66cf59c5e |
|
BLAKE2b-256 | 547cd5e47bc6b7d0fec1bb20c61356ec8ae463c0b3249683a0311b1e1d818894 |