Skip to main content

Infer type hints from runtime Python data

Project description

📦 typepeek

typepeek is a lightweight Python package that infers accurate, human-readable type hints from runtime data — including nested and complex containers like lists, dictionaries, tuples, sets, and even third-party objects like PyTorch tensors.


🚀 Quick Start

Installation

pip install typepeek

Example Usage

from typepeek import infer_type
import torch

data = [torch.tensor(1), torch.tensor(2), 3]
print(infer_type(data))
# Output: List[Union[torch.Tensor, int]]
print(infer_type(data, agnostic=False))
#typing.List[torch.Tensor, torch.Tensor, int]

✨ Features

  • Precise Type Inference — Accurately infers human-readable type hints from runtime values
  • 🔁 Deep Nested Structure Support — Handles arbitrarily nested containers (e.g., List[Dict[str, Tuple[int, float]]])
  • 🧹 Third-Party Object Compatibility — Understands common libraries like torch.Tensor, np.ndarray, and more
  • 🔄 Ordered and Unordered Type Support — Handles both ordered collections (e.g., List[int, float, str, int]) and unordered collections (e.g., List[Union[int, float, str]]).

📚 Examples

infer_type([1, 2, 3])
# typing.List[int]

infer_type(["a", 1, 3.14])
# typing.List[typing.Union[str, int, float]]

infer_type({"name": "Alice", "age": 30})
# typing.Dict[str, Union[str, int]]

infer_type((1, "hello", 3.5), agnostic=False)
#typing.Tuple[int, str, float]

infer_type([[1, 2], [3, 4]])
# typing.List[typing.List[int]]

infer_type([torch.tensor(1), np.array(2)], agnostic=False)
#typing.List[torch.Tensor, numpy.ndarray]

🛠 Use Cases

  • 📦 Auto-generate type hints for untyped or runtime-generated data
  • 🧪 Write better tests for dynamic outputs
  • 🧠 Debug and inspect complex runtime object structures

🙌 Contributing

Contributions are welcome! If you have an idea, bug, or feature request, feel free to open an issue or submit a pull request.


📄 License

This project is licensed under the MIT License. See the LICENSE file for details.


👤 Author

👨‍💻 Le Hoang Viet
🐙 GitHub: Mikyx-1

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

typepeek-0.3.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

typepeek-0.3.0-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file typepeek-0.3.0.tar.gz.

File metadata

  • Download URL: typepeek-0.3.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for typepeek-0.3.0.tar.gz
Algorithm Hash digest
SHA256 64d2b3f9a31f90479a378cf76cdec6ce978a1861a57917c9f3215c5a988ed937
MD5 cc12a0ad1d7f0b26e4b9e0ae78c45d24
BLAKE2b-256 39608fc85eab83d6c0c3df60448bfcadef1d76fbf2757b419e85d865e3256c6c

See more details on using hashes here.

File details

Details for the file typepeek-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: typepeek-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for typepeek-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd0d09a2b518abebafa87d47a670f3a92151e465da892b1099c39faf805a6de9
MD5 1342a954f5fdc3d3da8a8c5e4dfbb4e1
BLAKE2b-256 c2d8323aa6a4fac7ff68df70b64de065a41572d9a8ddcfd078d67c4fe14ae6b9

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