Type annotations for boto3.WorkSpaces 1.14.0 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-workspaces
Type annotations for boto3.WorkSpaces 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for WorkSpaces
service.
python -m pip install boto3-stubs[workspaces]
How to use
Client annotations
WorkSpacesClient
provides annotations for boto3.client("workspaces")
.
import boto3
from mypy_boto3_workspaces import WorkSpacesClient
from mypy_boto3_workspaces.paginator import (
DescribeAccountModificationsPaginator,
DescribeIpGroupsPaginator,
DescribeWorkspaceBundlesPaginator,
DescribeWorkspaceDirectoriesPaginator,
DescribeWorkspaceImagesPaginator,
DescribeWorkspacesConnectionStatusPaginator,
DescribeWorkspacesPaginator,
ListAvailableManagementCidrRangesPaginator,
)
from mypy_boto3_workspaces.type_defs import AccountModificationTypeDef, ...
client: WorkSpacesClient = boto3.client("workspaces")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: WorkSpacesClient = session.client("workspaces")
Paginators annotations
mypy_boto3_workspaces.paginator
module contains type annotations for all paginators.
client: WorkSpacesClient = boto3.client("workspaces")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_account_modifications_paginator: DescribeAccountModificationsPaginator = client.get_paginator("describe_account_modifications")
describe_ip_groups_paginator: DescribeIpGroupsPaginator = client.get_paginator("describe_ip_groups")
describe_workspace_bundles_paginator: DescribeWorkspaceBundlesPaginator = client.get_paginator("describe_workspace_bundles")
describe_workspace_directories_paginator: DescribeWorkspaceDirectoriesPaginator = client.get_paginator("describe_workspace_directories")
describe_workspace_images_paginator: DescribeWorkspaceImagesPaginator = client.get_paginator("describe_workspace_images")
describe_workspaces_paginator: DescribeWorkspacesPaginator = client.get_paginator("describe_workspaces")
describe_workspaces_connection_status_paginator: DescribeWorkspacesConnectionStatusPaginator = client.get_paginator("describe_workspaces_connection_status")
list_available_management_cidr_ranges_paginator: ListAvailableManagementCidrRangesPaginator = client.get_paginator("list_available_management_cidr_ranges")
Typed dictionations
mypy_boto3_workspaces.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccountModificationTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_workspaces
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
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("workspaces")
session_client = boto3.Session().client("workspaces")
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-workspaces-1.14.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | beccfe727e889c92bcf67a605ac517d4511dfee68186611e98c72d4d336fef7d |
|
MD5 | 00940f90bf58307e757d71ceeb912896 |
|
BLAKE2b-256 | 870514f9d3950425e95f28b5d0a268df5fa635b16e3779b795bd93a69cccb435 |
Hashes for mypy_boto3_workspaces-1.14.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19f6d6f315a3d11aa30865e21f0a707e87f2bdf4a4cdafca2aad1c5b806dcdf1 |
|
MD5 | 9cdd7630ed7d7b9cd6c410c47bfe5d88 |
|
BLAKE2b-256 | e831a60f70df1d96eaba78d422ab4d48e637179166302fab1a7e1c2afbe1488f |