Skip to main content

Type hints → UI metadata. Build forms from Python function signatures.

Project description

pytypeinput 0.1.1

PyPI version Python Tests License

Extract structured metadata from Python type hints.


pytypeinput analyzes Python type hints and extracts structured metadata. Use this metadata to build UIs, CLIs, config editors, or anything that needs input specifications.

from dataclasses import dataclass
from pytypeinput import Field, Annotated, analyze_dataclass

@dataclass
class User:
    username: Annotated[str, Field(min_length=3, max_length=20)]
    age: Annotated[int, Field(ge=18, le=120)]
    bio: str | None = None

# Extract metadata
params = analyze_dataclass(User)
# Use it to build: HTML forms, CLIs, GUIs, validators...

Design Goals

  • Single source of truth - Define once with type hints, use everywhere (forms, CLIs, validation)
  • Minimal code - Maximum features with minimum boilerplate
  • Type-safe - Full IDE autocomplete and type checking
  • Pure Python - Build UIs with Python code, not templates or DSLs

Installation

Core only:

pip install pytypeinput

With HTML renderer:

pip install pytypeinput[html]

Requirements: Python 3.10+ • Pydantic 2.0+

Documentation

Complete Documentation with interactive examples

Type System:

  • Basic Types: int, float, str, bool, date, time
  • Special Types: Email, Color, File, ImageFile, etc.
  • Lists: list[Type] with item and list-level validation
  • Optionals: Type | None with toggle switches
  • Choices: Literal, Enum, Dropdown(func)
  • Constraints: Field(min=, max=, pattern=) for validation
  • UI Metadata: Custom labels, descriptions, placeholders, sliders, etc.

Renderers:

Reference:

What pytypeinput does

✅ Extracts metadata from type hints
✅ Works with functions, dataclasses, Pydantic models, classes
✅ Optional HTML renderer with client-side validation
✅ Framework-agnostic

❌ No server-side validation
❌ No form submission handling

pytypeinput is a building block, not a complete solution.

Validation: Type hints validated when extracting metadata. HTML forms validate client-side. Server-side is your responsibility (use Pydantic with same type hints).

Contributing

Found a bug or have a suggestion? Open an issue

License

MIT • Beltrán Offerrall

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytypeinput-0.1.1.tar.gz (484.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytypeinput-0.1.1-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file pytypeinput-0.1.1.tar.gz.

File metadata

  • Download URL: pytypeinput-0.1.1.tar.gz
  • Upload date:
  • Size: 484.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for pytypeinput-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ea75511cd4033c2ce058276961a30be839573a21c7f5afebb34dcf88c92c519c
MD5 8fd7e0e24b01f8964ff583db30cb16f9
BLAKE2b-256 3c7b2f57c2c84447e0c89f4c88e3d0fe9f02267af971c4c511763877e23c840f

See more details on using hashes here.

File details

Details for the file pytypeinput-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: pytypeinput-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 26.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for pytypeinput-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 864fcefb0a58a574596e50cfc2410b2b550746b57c3fa07f242f83d6e85c5d84
MD5 a0f2cc9acab74e77a4670582ffc3b872
BLAKE2b-256 84ca5b986f3b2d154a0a2a64b4eca49ad79d1db4adc7e8d96423af9b859f8284

See more details on using hashes here.

Supported by

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