API Reference

Warning

Component Migration Notice (Version 0.2.0)

Several components previously documented here have been moved to separate packages:

For enumeration documentation, see true-enumeration docs
For type system documentation, see true-types docs
For blob handling documentation, see true-blobs docs

The following components are no longer available:

Pointer class has been removed
Recyclebin functionality has been temporarily removed

Please update your dependencies and code accordingly.

Collections and File System

File System Objects

OSUtils

Time Management

Time

Event

Schedule

Regular Expressions

Username Patterns

true.re.USERNAME_ONLY_LETTERS_MIN_3

true.re.USERNAME_LETTERS_AND_NUMBERS_MIN_3

true.re.USERNAME_WITH_UNDERSCORES_MIN_3

true.re.USERNAME_WITH_DASHES_AND_UNDERSCORES_MIN_3

true.re.USERNAME_NO_CONSECUTIVE_SPECIAL_CHARS

true.re.USERNAME_STARTS_WITH_LETTER

true.re.USERNAME_MAX_20_CHARACTERS

true.re.USERNAME_NOT_NUMERIC_ONLY

true.re.USERNAME_NO_PREFIX_SUFFIX

true.re.USERNAME_INCLUDE_LETTER_AND_NUMBER

Password Patterns

true.re.PASSWORD_MIN_8

true.re.PASSWORD_MIN_8_WITH_NUMBER

true.re.PASSWORD_MIN_8_UPPER_LOWER_NUMBER

true.re.PASSWORD_MIN_8_UPPER_LOWER_NUMBER_SPECIAL

true.re.PASSWORD_NO_WHITESPACE

Email Patterns

true.re.EMAIL_BASIC

true.re.EMAIL_RFC_5322

true.re.EMAIL_WITH_SUBDOMAINS

true.re.EMAIL_WITH_UNICODE

Exceptions

Enum Exceptions

exception true.exceptions.InvalidEnumTypeError[source]: Raised when an invalid enum type is provided.

exception true.exceptions.EnumMetadataError[source]: Custom exception for enum metadata-related errors.

exception true.exceptions.EnumValidationError[source]: Custom error for invalid enum values.

exception true.exceptions.EnumTypeError(expected_type, actual_type)[source]

Custom error for type mismatches in enum.

__init__(expected_type, actual_type)[source]

File System Exceptions

exception true.exceptions.StorageFullError[source]: Raised when recycle bin storage limit is exceeded.

exception true.exceptions.ItemNotFoundError[source]: Raised when an item is not found in the recycle bin.

exception true.exceptions.RestoreError[source]: Raised when item restoration fails.

Type Exceptions

exception true.exceptions.UnsuitableBigIntError[source]: Raised when an integer value is unsuitable.

exception true.exceptions.UnsuitableBigDecimalError[source]: Raised when a decimal value is unsuitable.

exception true.exceptions.InvalidUUIDError[source]: Exception raised for invalid UUIDs.

exception true.exceptions.InvalidUUIDVersionError[source]: Exception raised when a UUID does not match the expected version.

exception true.exceptions.InvalidULIDError[source]: Exception raised for invalid ULIDs.

Time Exceptions

exception true.exceptions.ScheduleError[source]: Base exception for schedule-related errors.

exception true.exceptions.ScheduleConflictError[source]: Raised when there is a conflict between scheduled events.

exception true.exceptions.ScheduleValidationError[source]: Raised when schedule validation fails.