TypeID Python

Warnings

• breaking Python 3.8 and 3.9 support was dropped. The library now requires Python 3.10 or newer.
  Fix: Upgrade your Python environment to version 3.10 or later. For example, `pyenv install 3.10.12 && pyenv local 3.10.12`.
• breaking The prefix validation was updated in v0.3.0 to adhere strictly to the TypeID specification regex (`[a-z]{0,63}`). Prefixes that were previously accepted but did not conform will now raise an error.
  Fix: Ensure all TypeID prefixes conform to the regex `[a-z]{0,63}` (lowercase alphanumeric, max 63 characters).
• gotcha Starting from v0.3.5, the library introduced optional Rust acceleration, which became standard in v0.3.7 for improved performance in base32 encoding/decoding and UUIDv7 generation. While a pure-Python fallback exists, users might experience performance differences on platforms where native wheels aren't available or if the Rust extension fails to build.
  Fix: No direct fix is typically needed as the library handles fallbacks. However, for optimal performance, ensure a compatible environment for Rust-powered wheels. Check documentation for specific platform build troubleshooting if performance is critical and seems suboptimal.
• gotcha Prior to v0.3.9, there was an issue with Pydantic JSON schema generation for FastAPI/OpenAPI, leading to incorrect schema definitions. This was fixed in v0.3.9.
  Fix: Upgrade to `typeid-python` version 0.3.9 or later to ensure correct Pydantic JSON schema generation for FastAPI/OpenAPI integrations.

Install

• pip install typeid-python Install stable version

Imports

• TypeID

  from typeid import TypeID

Quickstart

This example demonstrates how to generate a new TypeID, extract its components, convert it to and from its string representation, and compare TypeID objects.

from typeid import TypeID

# Generate a new TypeID with a prefix (uses a new UUIDv7 internally)
user_id = TypeID("user")
print(f"Generated TypeID: {user_id}")
print(f"Prefix: {user_id.prefix}")
print(f"UUID: {user_id.uuid}") # Raw UUID object

# Get the string representation
user_id_str = str(user_id)
print(f"String representation: {user_id_str}")

# Parse a TypeID from a string
parsed_id = TypeID.from_string(user_id_str)
print(f"Parsed TypeID: {parsed_id}")

# Compare TypeIDs
assert user_id == parsed_id