mypy-boto3-fsx 1.14.34.0

Type annotations for boto3.FSx 1.14.34 service, generated by mypy-boto3-buider 2.2.0

mypy-boto3-fsx

Type annotations for boto3.FSx 1.14.34 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 FSx service.

python -m pip install boto3-stubs[fsx]

How to use

Client annotations

FSxClient provides annotations for boto3.client("fsx").

import boto3

from mypy_boto3_fsx import FSxClient
from mypy_boto3_fsx.paginator import (
    DescribeBackupsPaginator,
    DescribeFileSystemsPaginator,
    ListTagsForResourcePaginator,
)
from mypy_boto3_fsx.type_defs import ActiveDirectoryBackupAttributesTypeDef, ...

client: FSxClient = boto3.client("fsx")

# 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: FSxClient = session.client("fsx")

Paginators annotations

mypy_boto3_fsx.paginator module contains type annotations for all paginators.

client: FSxClient = boto3.client("fsx")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_backups_paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups")
describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator("describe_file_systems")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")

Typed dictionations

mypy_boto3_fsx.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

def get_structure() -> ActiveDirectoryBackupAttributesTypeDef:
    return {
      ...
    }

Dynamic type annotations

mypy_boto3 command generates boto3.client/resource type annotations for mypy_boto3_fsx 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 expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
• VSCode 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("fsx")

session_client = boto3.Session().client("fsx")