Typing Stubs for Cryptography

3.3.23.2 · active · verified Thu Apr 09

This package provides static type checking stubs for the `cryptography` library, enabling tools like MyPy to verify type correctness in Python code that uses `cryptography`. It is part of the broader Typeshed project, which maintains a repository of type stubs for many popular Python libraries. As of this entry, the current version is 3.3.23.2, with updates typically following `cryptography` releases.

Warnings

gotcha `types-cryptography` only provides type hints. You *must* install the actual `cryptography` library (`pip install cryptography`) for your code to run.
Fix: Ensure both `cryptography` and `types-cryptography` are installed in your environment.
gotcha Do not attempt to import symbols directly from `types_cryptography` or `cryptography-stubs`. This package is purely for type checkers and does not expose runtime objects. Imports should always be from `cryptography` itself.
Fix: Always import from `cryptography` (e.g., `from cryptography.fernet import Fernet`). Type checkers will automatically discover the stubs provided by `types-cryptography`.
gotcha The version of `types-cryptography` might not always be perfectly in sync with the very latest release of `cryptography`. This can occasionally lead to minor type checking errors (e.g., missing attributes for newly added features) until the stubs are updated.
Fix: If you encounter type errors for new `cryptography` features, check for an updated `types-cryptography` version or consider using `type: ignore` comments as a temporary workaround until stubs are released.

Install

pip install types-cryptography Install package

Imports

Fernet
```
from cryptography.fernet import Fernet
```
Type stubs are not imported directly. Instead, they provide type information for symbols imported from the actual `cryptography` library, which type checkers consume automatically.

Quickstart

This quickstart demonstrates a basic usage of the `cryptography` library. `types-cryptography` is installed to allow static type checkers like MyPy to verify the type correctness of this code. After installing `cryptography`, `types-cryptography`, and `mypy`, you can run `mypy <your_script_name>.py` to check for type errors.

import os
from cryptography.fernet import Fernet

# Example usage of cryptography, for which types-cryptography provides stubs
key = Fernet.generate_key()
f = Fernet(key)

message: bytes = b"my secret data"
encrypted_message: bytes = f.encrypt(message)
decrypted_message: bytes = f.decrypt(encrypted_message)

print(f"Original: {message}")
print(f"Encrypted: {encrypted_message}")
print(f"Decrypted: {decrypted_message}")

# To type-check this file:
# 1. pip install cryptography types-cryptography mypy
# 2. mypy your_script_name.py

view raw JSON →