Type annotations for boto3.FSx 1.13.26 service, generated by mypy-boto3-buider 2.0.3
Project description
mypy-boto3-fsx
Type annotations for boto3.FSx 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 FSx
service.
python -m pip install boto3-stubs[fsx]
# update installed packages index for automated type discovery
python -m mypy_boto3
Use boto3
with mypy_boto3_fsx
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_fsx import FSxClient
# Now mypy can check if your code is valid.
client: FSxClient = boto3.client("fsx")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: FSxClient = session.client("fsx")
# Annotated paginators are included as well
import mypy_boto3_fsx.paginator as fsx_paginators
describe_backups_paginator: fsx_paginators.DescribeBackupsPaginator = client.get_paginator("describe_backups")
describe_file_systems_paginator: fsx_paginators.DescribeFileSystemsPaginator = client.get_paginator("describe_file_systems")
list_tags_for_resource_paginator: fsx_paginators.ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_fsx
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_fsx as fsx
from mypy_boto3_fsx import FSxClient
# with these
from mypy_boto3 import fsx
from mypy_boto3.fsx import FSxClient
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_fsx-1.13.26.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bcafd136db91bc82477b96259d72b85a58361cd26bb68dce739c6350cd5419e |
|
MD5 | 6bf9a47371f96b9c7d390707bbb8bddf |
|
BLAKE2b-256 | ad4429fe35f3efa872a13707a0f34af62829d3156191a999a9eb391daa9f3ac7 |