Typing Stubs for six

1.17.0.20260408 · active · verified Thu Apr 09

This package provides typing stubs for the `six` library, enabling static type checking for code that uses `six`. It is part of the community-maintained Typeshed project, which regularly releases updated stubs for third-party packages. The current version, 1.17.0.20260408, aims for compatibility with `six==1.17.*` and is designed for modern Python 3 environments.

Warnings

gotcha The `six` library is primarily intended for maintaining Python 2 and 3 compatibility in a single codebase. For new Python 3-only projects, it is generally recommended to use native Python 3 features directly (e.g., `urllib.parse` instead of `six.moves.urllib.parse`) to avoid unnecessary abstraction layers and potential confusion.
Fix: For new Python 3 projects, refactor code to use standard Python 3 library functions directly. Only use `six` if maintaining a codebase that must run on both Python 2 and Python 3.
gotcha `types-six` (and Typeshed stubs generally) are designed for modern Python versions. Specifically, `types-six` requires Python `>=3.10`, even though the runtime `six` library itself supports Python `2.7` and `3.3+`. This means `types-six` cannot be used to provide type hints for older Python 2 or Python 3 projects.
Fix: Ensure your development environment's Python version meets the `types-six` requirement (`>=3.10`). For type-checking older Python projects that use `six`, `types-six` is not suitable.
gotcha `types-six` is a stub-only package. It provides type information solely for static analysis tools (like Mypy, Pyright, PyCharm) and does not contain any executable code or influence runtime behavior. You must install the `six` runtime library separately (`pip install six`) for your application to function.
Fix: Always install the `six` runtime library (`pip install six`) alongside `types-six` if your project actually uses `six`.

Install

pip install types-six Install types-six

Imports

six.moves.urllib.parse
```
import six.moves.urllib.parse
```
You import the runtime `six` library, and `types-six` provides the type hints automatically for type checkers. There are no direct imports from `types-six` itself.

Quickstart

This example demonstrates using a common utility from the `six` library (`six.moves.urllib.parse`) and applying type hints from `types-six`. After installing `six`, `types-six`, and a type checker like `mypy`, you can run `mypy example.py` to verify the types. `types-six` ensures that `mypy` understands the types of `six`'s functions and constants, such as `six.text_type`.

import six.moves.urllib.parse

def get_scheme(url: six.text_type) -> six.text_type:
    parsed_url = six.moves.urllib.parse.urlparse(url)
    return parsed_url.scheme

url_str: six.text_type = 'http://example.com/path'
scheme: six.text_type = get_scheme(url_str)
print(f"The scheme is: {scheme}")

# To type-check this:
# 1. pip install six types-six mypy
# 2. Save the code above as example.py
# 3. Run: mypy example.py

view raw JSON →