Type annotations for boto3.EFS 1.18.50 service, generated by mypy-boto3-builder 5.4.0
Project description
mypy-boto3-efs
Type annotations for boto3.EFS 1.18.50 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.
Generated by mypy-boto3-builder 5.4.0.
More information can be found on boto3-stubs page and in mypy-boto3-efs docs
See how it helps to find and fix potential bugs:
How to install
Install boto3-stubs
for EFS
service.
python -m pip install boto3-stubs[efs]
Usage
VSCode
- Install Python extension
- Install Pylance extension
- Set
Pylance
as your Python Language Server - Install
boto-stubs[efs]
in your environment:python -m pip install 'boto3-stubs[efs]'
Both type checking and auto-complete should work for EFS
service. No explicit
type annotations required, write your boto3
code as usual.
PyCharm
- Install
boto-stubs[efs]
in your environment:python -m pip install 'boto3-stubs[efs]'
Both type checking and auto-complete should work for EFS
service. No explicit
type annotations required, write your boto3
code as usual. Auto-complete can
be slow on big projects or if you have a lot of installed boto3-stubs
submodules.
Other IDEs
Not tested, but as long as your IDE supports mypy
or pyright
, everything
should work.
mypy
- Install
mypy
:python -m pip install mypy
- Install
boto-stubs[efs]
in your environment:python -m pip install 'boto3-stubs[efs]'
- Run
mypy
as usual
Type checking should work for EFS
service. No explicit type annotations
required, write your boto3
code as usual.
pyright
- Install
pyright
:yarn global add pyright
- Install
boto-stubs[efs]
in your environment:python -m pip install 'boto3-stubs[efs]'
- Optionally, you can install
boto3-stubs
totypings
folder.
Type checking should work for EFS
service. No explicit type annotations
required, write your boto3
code as usual.
Explicit type annotations
Client annotations
EFSClient
provides annotations for boto3.client("efs")
.
import boto3
from mypy_boto3_efs import EFSClient
client: EFSClient = boto3.client("efs")
# 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: EFSClient = session.client("efs")
Paginators annotations
mypy_boto3_efs.paginator
module contains type annotations for all paginators.
from mypy_boto3_efs import EFSClient
from mypy_boto3_efs.paginator import (
DescribeFileSystemsPaginator,
DescribeMountTargetsPaginator,
DescribeTagsPaginator,
)
client: EFSClient = boto3.client("efs")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator("describe_file_systems")
describe_mount_targets_paginator: DescribeMountTargetsPaginator = client.get_paginator("describe_mount_targets")
describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
Literals
mypy_boto3_efs.literals
module contains literals extracted from shapes that
can be used in user code for type checking.
from mypy_boto3_efs.literals import (
DescribeFileSystemsPaginatorName,
DescribeMountTargetsPaginatorName,
DescribeTagsPaginatorName,
LifeCycleStateType,
PerformanceModeType,
ResourceIdTypeType,
ResourceType,
StatusType,
ThroughputModeType,
TransitionToIARulesType,
TransitionToPrimaryStorageClassRulesType,
ServiceName,
PaginatorName,
)
def check_value(value: DescribeFileSystemsPaginatorName) -> bool:
...
Typed dictionaries
mypy_boto3_efs.type_defs
module contains structures and shapes assembled to
typed dictionaries for additional type checking.
from mypy_boto3_efs.type_defs import (
AccessPointDescriptionResponseMetadataTypeDef,
AccessPointDescriptionTypeDef,
BackupPolicyDescriptionTypeDef,
BackupPolicyTypeDef,
CreateAccessPointRequestRequestTypeDef,
CreateFileSystemRequestRequestTypeDef,
CreateMountTargetRequestRequestTypeDef,
CreateTagsRequestRequestTypeDef,
CreationInfoTypeDef,
DeleteAccessPointRequestRequestTypeDef,
DeleteFileSystemPolicyRequestRequestTypeDef,
DeleteFileSystemRequestRequestTypeDef,
DeleteMountTargetRequestRequestTypeDef,
DeleteTagsRequestRequestTypeDef,
DescribeAccessPointsRequestRequestTypeDef,
DescribeAccessPointsResponseTypeDef,
DescribeAccountPreferencesRequestRequestTypeDef,
DescribeAccountPreferencesResponseTypeDef,
DescribeBackupPolicyRequestRequestTypeDef,
DescribeFileSystemPolicyRequestRequestTypeDef,
DescribeFileSystemsRequestRequestTypeDef,
DescribeFileSystemsResponseTypeDef,
DescribeLifecycleConfigurationRequestRequestTypeDef,
DescribeMountTargetSecurityGroupsRequestRequestTypeDef,
DescribeMountTargetSecurityGroupsResponseTypeDef,
DescribeMountTargetsRequestRequestTypeDef,
DescribeMountTargetsResponseTypeDef,
DescribeTagsRequestRequestTypeDef,
DescribeTagsResponseTypeDef,
FileSystemDescriptionResponseMetadataTypeDef,
FileSystemDescriptionTypeDef,
FileSystemPolicyDescriptionTypeDef,
FileSystemSizeTypeDef,
LifecycleConfigurationDescriptionTypeDef,
LifecyclePolicyTypeDef,
ListTagsForResourceRequestRequestTypeDef,
ListTagsForResourceResponseTypeDef,
ModifyMountTargetSecurityGroupsRequestRequestTypeDef,
MountTargetDescriptionResponseMetadataTypeDef,
MountTargetDescriptionTypeDef,
PaginatorConfigTypeDef,
PosixUserTypeDef,
PutAccountPreferencesRequestRequestTypeDef,
PutAccountPreferencesResponseTypeDef,
PutBackupPolicyRequestRequestTypeDef,
PutFileSystemPolicyRequestRequestTypeDef,
PutLifecycleConfigurationRequestRequestTypeDef,
ResourceIdPreferenceTypeDef,
ResponseMetadataTypeDef,
RootDirectoryTypeDef,
TagResourceRequestRequestTypeDef,
TagTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateFileSystemRequestRequestTypeDef,
)
def get_structure() -> AccessPointDescriptionResponseMetadataTypeDef:
return {
...
}
Versioning
mypy-boto3-efs
version is the same as related boto3
version and follows
PEP 440 format.
Documentation
All type annotations can be found in mypy-boto3-efs docs
Support and contributing
This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.
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_efs-1.18.50-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fa4f8ad197f81f2ef1bbae77fc3aa851769fa7afd3deecc38db417bca2c570e |
|
MD5 | 9b78570b172c0a1820a6bdc523ce342e |
|
BLAKE2b-256 | b5b5718d3aafed760cfa93b41ea863df45c93370342c013038636014c2ad9fb9 |