Typing Stubs for MarkupSafe

1.1.10 · active · verified Thu Apr 09

This is a PEP 561 type stub package providing external type annotations for the MarkupSafe library. It enables static type-checking tools like MyPy, PyCharm, or Pyright to analyze code that uses MarkupSafe. The current version is 1.1.10. These stub packages are automatically released by the Typeshed project, ensuring they follow typing specification standards.

Warnings

breaking The `MarkupSafe` library itself includes type annotations since version 2.0. If you are using `MarkupSafe` 2.0 or newer, you MUST uninstall `types-MarkupSafe` to avoid conflicts and ensure correct type checking, as `types-MarkupSafe` is intended for `MarkupSafe` versions older than 2.0.
Fix: Uninstall `types-markupsafe` using `pip uninstall types-markupsafe`. Keep `markupsafe` installed.
gotcha Ensure the version of `types-markupsafe` you install is compatible with your installed `markupsafe` version. The `types-markupsafe` version number (excluding the last part) aims to match the `markupsafe` version it provides stubs for. `types-markupsafe 1.1.x` is for `markupsafe 1.1.x`.
Fix: Pin `types-markupsafe` to a version compatible with your `markupsafe` installation. For `markupsafe < 2.0`, typically `types-markupsafe` matches the minor version.
gotcha `types-markupsafe` is a stub-only package and provides no runtime functionality. It should not be imported directly in your application code, nor does it expose any objects or functions at runtime. Its sole purpose is to be consumed by static type checkers.
Fix: Do not attempt to import from or use `types-markupsafe` in your Python code. Continue to import `Markup` and `escape` from `markupsafe`.

Install

pip install types-markupsafe Install types-markupsafe

Imports

Markup
```
from markupsafe import Markup
```
types-markupsafe provides type hints for the actual markupsafe library. There are no runtime objects to import directly from types-markupsafe.
escape
```
from markupsafe import escape
```
types-markupsafe provides type hints for the actual markupsafe library. There are no runtime objects to import directly from types-markupsafe.

Quickstart

This quickstart demonstrates how to install `types-markupsafe` and use a type checker like MyPy to verify the types in code that uses `MarkupSafe`. Note that `types-markupsafe` is only needed for `MarkupSafe` versions prior to 2.0, as newer versions include their own type annotations.

# 1. Install MarkupSafe (if not already present)
pip install MarkupSafe==1.1.1

# 2. Install types-markupsafe (for MarkupSafe versions < 2.0)
pip install types-markupsafe

# 3. Create a Python file (e.g., app.py) to use MarkupSafe
#    Note: This quickstart is for MarkupSafe < 2.0
from markupsafe import escape, Markup

def process_user_input(user_input: str) -> Markup:
    escaped_input = escape(user_input)
    return Markup(f"<p>You entered: {escaped_input}</p>")

html_output = process_user_input("<script>alert('xss')</script>")
print(html_output)

# 4. Run a type checker (e.g., MyPy)
# pip install mypy
# mypy app.py

view raw JSON →