Skip to main content

Type annotations for boto3 EFS 1.39.0 service generated with mypy-boto3-builder 8.11.0

Project description

mypy-boto3-efs

PyPI - mypy-boto3-efs PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3 EFS 1.39.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.11.0.

More information can be found on boto3-stubs page and in mypy-boto3-efs docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

How to install

Generate locally (recommended)

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.39.0' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add EFS service.
  4. Use provided commands to install generated packages.

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and EFS.

From PyPI with pip

Install boto3-stubs for EFS service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[efs]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[efs]'

# standalone installation
python -m pip install mypy-boto3-efs

How to uninstall

python -m pip uninstall -y mypy-boto3-efs

Usage

VSCode

python -m pip install 'boto3-stubs[efs]'

Both type checking and code completion should now work. No explicit type annotations required, write your boto3 code as usual.

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[efs] in your environment:

python -m pip install 'boto3-stubs[efs]'

Both type checking and code completion should now work.

Emacs

  • Install boto3-stubs with services you use in your environment:
python -m pip install 'boto3-stubs[efs]'
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
  • Make sure emacs uses the environment where you have installed boto3-stubs

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Sublime Text

  • Install boto3-stubs[efs] with services you use in your environment:
python -m pip install 'boto3-stubs[efs]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

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 boto3-stubs[efs] in your environment:
python -m pip install 'boto3-stubs[efs]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

pyright

  • Install pyright: npm i -g pyright
  • Install boto3-stubs[efs] in your environment:
python -m pip install 'boto3-stubs[efs]'

Optionally, you can install boto3-stubs to typings directory.

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid mypy-boto3-efs dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
    from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

EFSClient provides annotations for boto3.client("efs").

from boto3.session import Session

from mypy_boto3_efs import EFSClient

client: EFSClient = Session().client("efs")

# now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

mypy_boto3_efs.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_efs import EFSClient
from mypy_boto3_efs.paginator import (
    DescribeAccessPointsPaginator,
    DescribeFileSystemsPaginator,
    DescribeMountTargetsPaginator,
    DescribeReplicationConfigurationsPaginator,
    DescribeTagsPaginator,
)

client: EFSClient = Session().client("efs")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_access_points_paginator: DescribeAccessPointsPaginator = client.get_paginator(
    "describe_access_points"
)
describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator(
    "describe_file_systems"
)
describe_mount_targets_paginator: DescribeMountTargetsPaginator = client.get_paginator(
    "describe_mount_targets"
)
describe_replication_configurations_paginator: DescribeReplicationConfigurationsPaginator = (
    client.get_paginator("describe_replication_configurations")
)
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.

Full list of EFS Literals can be found in docs.

from mypy_boto3_efs.literals import DeletionModeType


def check_value(value: DeletionModeType) -> bool: ...

Type definitions

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

Full list of EFS TypeDefs can be found in docs.

# TypedDict usage example
from mypy_boto3_efs.type_defs import PosixUserOutputTypeDef


def get_value() -> PosixUserOutputTypeDef:
    return {
        "Uid": ...,
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers 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 botocore schemas.
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by ruff for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
  • mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
  • Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
  • Generated TypeDefs for each service
  • Generated Literals for each service
  • Auto discovery of types for boto3.client and boto3.resource calls
  • Auto discovery of types for session.client and session.resource calls
  • Auto discovery of types for client.get_waiter and client.get_paginator calls
  • Auto discovery of types for ServiceResource and Resource collections
  • Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

mypy-boto3-efs version is the same as related boto3 version and follows Python Packaging version specifiers.

Thank you

Documentation

All services type annotations can be found in boto3 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

mypy_boto3_efs-1.39.0.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_efs-1.39.0-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file mypy_boto3_efs-1.39.0.tar.gz.

File metadata

  • Download URL: mypy_boto3_efs-1.39.0.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for mypy_boto3_efs-1.39.0.tar.gz
Algorithm Hash digest
SHA256 255e7dda0f017fe9e7c6018ebccc8ee484576e2c5c86aa1295edba7c384de6a3
MD5 cd17a8eb8030b50c95c00cef954de4ce
BLAKE2b-256 5b743c841579daf34e69ca95c7129888b9cbf1ef58c6cf5e2fb28313adca7395

See more details on using hashes here.

File details

Details for the file mypy_boto3_efs-1.39.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mypy_boto3_efs-1.39.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1322c6cf742cc406e5ed39f0fadb013cb460c01b8dbe1d6add6c0d5e4a3fe8ad
MD5 e2ab35f4d46cf1f6b0b500b3263ae7a1
BLAKE2b-256 9c3681fa649db41c6312175c16eef8db558c3fa0f8cca1ad5ffadce615cd7ab4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page