mypy-boto3-workspaces 1.11.0.1

Type annotations for boto3.WorkSpaces 1.11.0 service.

mypy-boto3-workspaces

Type annotations for boto3.WorkSpaces 1.11.0 service compatible with mypy, VSCode, PyCharm and other tools.

More information can be found here.

• mypy-boto3-workspaces
  • How to use
    • Type checking
    • Code auto-complete
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for WorkSpaces service.

python -m pip install boto3-stubs[mypy-boto3-workspaces]

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import workspaces
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_workspaces as workspaces

# 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("workspaces")
client: workspaces.WorkSpacesClient = boto3.client("workspaces")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: workspaces.WorkSpacesClient = session.client("workspaces")


# Paginators need type annotation on creation
describe_account_modifications_paginator: workspaces.DescribeAccountModificationsPaginator = client.get_paginator("describe_account_modifications")
describe_ip_groups_paginator: workspaces.DescribeIpGroupsPaginator = client.get_paginator("describe_ip_groups")
describe_workspace_bundles_paginator: workspaces.DescribeWorkspaceBundlesPaginator = client.get_paginator("describe_workspace_bundles")
describe_workspace_directories_paginator: workspaces.DescribeWorkspaceDirectoriesPaginator = client.get_paginator("describe_workspace_directories")
describe_workspace_images_paginator: workspaces.DescribeWorkspaceImagesPaginator = client.get_paginator("describe_workspace_images")
describe_workspaces_paginator: workspaces.DescribeWorkspacesPaginator = client.get_paginator("describe_workspaces")
describe_workspaces_connection_status_paginator: workspaces.DescribeWorkspacesConnectionStatusPaginator = client.get_paginator("describe_workspaces_connection_status")
list_available_management_cidr_ranges_paginator: workspaces.ListAvailableManagementCidrRangesPaginator = client.get_paginator("list_available_management_cidr_ranges")

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 (blame botocore 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.