Typing Stubs for humanfriendly

10.0.1.20250319 · deprecated · verified Mon Apr 13

This is a PEP 561 type stub package providing static type annotations for the `humanfriendly` library. It enables type-checking tools like MyPy, Pyright, and PyCharm to analyze code that uses `humanfriendly`. While available on PyPI, this package is part of the Typeshed project, and direct maintenance for it has ceased; fixes should be contributed upstream to Typeshed. This version aims to provide accurate annotations for `humanfriendly==10.0.*`.

Warnings

deprecated The `types-humanfriendly` package is officially unmaintained on PyPI, and the `humanfriendly` stubs were removed from the upstream Typeshed project in March 2025. This means no further updates or fixes will be provided.
Fix: Consider vendoring the stubs if critical, or migrating away from `humanfriendly` if type-checking is a strict requirement for newer Python versions or accurate types. Alternatively, disable type checking for this library.
gotcha Stub versions can introduce breaking changes for type checkers even if the runtime library does not. Due to the unmaintained status, future `humanfriendly` versions may not be accurately stubbed, leading to type-checking errors.
Fix: Pin `types-humanfriendly` to a specific version (e.g., `types-humanfriendly==10.0.1.20250319`) to prevent unexpected type-checking failures if newer versions of `humanfriendly` are installed and their APIs diverge from the stubbed `10.0.*` version. Always ensure the stub version aligns with your `humanfriendly` runtime version.
gotcha The underlying `humanfriendly` library itself has not been updated since September 2021 (version 10.0) and was noted as not working with Python 3.13 during the Typeshed removal discussion, which implies potential runtime issues with newer Python versions, separate from the stubs.
Fix: Test `humanfriendly` thoroughly with your target Python version. If you encounter runtime issues, consider alternative libraries with active maintenance.

Install

pip install types-humanfriendly Install types-humanfriendly
pip install humanfriendly Install the runtime library

Imports

format_size
```
from humanfriendly import format_size
```
Imports are from the `humanfriendly` library itself; `types-humanfriendly` provides the `.pyi` files used by type checkers.
parse_size
```
from humanfriendly import parse_size
```
Imports are from the `humanfriendly` library itself; `types-humanfriendly` provides the `.pyi` files used by type checkers.
prompt_for_input
```
from humanfriendly.prompts import prompt_for_input
```
Imports are from the `humanfriendly` library itself; `types-humanfriendly` provides the `.pyi` files used by type checkers.

Quickstart

Install `humanfriendly` and `types-humanfriendly`. Then, import and use functions from `humanfriendly` with type annotations. Your type checker will leverage the stubs provided by `types-humanfriendly`.

import os
from humanfriendly import format_size, parse_size

def process_size(size_str: str) -> str:
    try:
        num_bytes = parse_size(size_str)
        return f"You entered: {format_size(num_bytes)}"
    except Exception as e:
        return f"Error parsing size: {e}"

# Example usage (usually from user input or a configuration)
user_input = os.environ.get('EXAMPLE_FILE_SIZE', '10GB') # Simulate input
print(process_size(user_input))

view raw JSON →