twilkit 1.1.3

Lightweight Python toolkit: validators, colors, decorators, and FlexVar

twilkit

A lightweight toolkit for everyday Python work:

• Validators – clean, reusable descriptors for attribute validation
• Colors – simple ANSI color formatting for terminal output
• Decorators – exception handling and per-function logging
• FlexVar – a flexible, chainable dict-like container with a pretty __str__

---

Table of Contents

• Installation

• Quick Start

• API

  • Validators
    • Start with
    • End with
    • In between
    • Less than
    • More than
  • Colors
  • Decorators
    • Catch Execptions
    • Log Function
  • FlexVar
  • Return
  • PyTxt
  • Copy helper function

• Mini Project: “User Registry” CLI

• Contributing

• License

---

Installation

pip install twilkit

back to menu

---

Supports Python 3.10+

---

Quick Start

from twilkit import validators, color, FlexVar, catch_exceptions, log_function

class User:
    name  = validators.StartWith("Mr ", "Ms ", "Dr ")
    email = validators.EndsWith("@example.com", "@corp.local")
    age   = validators.InBetween(0, 130)

@catch_exceptions
@log_function
def create_profile(name, email, age):
    u = User()
    u.name = name
    u.email = email
    u.age = age
    profile = FlexVar("Profile").add("name", name).add("email", email).add("age", age)
    print(color("User created").green)
    print(profile)
    return profile

create_profile("Dr Jane Doe", "[e-mail]", 34)

back to menu

---

API

Validators

Reusable data descriptors that enforce constraints on attributes when you set them. Import them via the grouped namespace or directly:

from twilkit import validators
# or:
from twilkit import StartWith, EndsWith, MoreThan, LessThan, InBetween

back to menu

---

StartWith(*prefixes: str)

Validate that a string starts with any of the provided prefixes.

class Person:
    title = validators.StartWith("Mr ", "Ms ", "Dr ")

p = Person()
p.title = "Dr Alice"      # OK
# p.title = "Alice"       # raises ValidationError

back to menu

---

EndsWith(*suffixes: str)

Validate that a string ends with any of the provided suffixes.

class Account:
    email = validators.EndsWith("@example.com", "@corp.local")

a = Account()
a.email = "[e-mail]"  # OK
# a.email = "[e-mail]" # raises ValidationError

back to menu

---

MoreThan(value: int | float)

Validate that a number is strictly greater than value.

class Metrics:
    height_cm = validators.MoreThan(0)

m = Metrics()
m.height_cm = 172  # OK
# m.height_cm = 0  # raises ValidationError

back to menu

---

LessThan(value: int | float)

Validate that a number is strictly less than value.

class Bio:
    age = validators.LessThan(150)

b = Bio()
b.age = 42     # OK
# b.age = 200  # raises ValidationError

back to menu

---

InBetween(minv: int | float, maxv: int | float)

Validate that minv <= value <= maxv.

class Exam:
    score = validators.InBetween(0, 100)

e = Exam()
e.score = 88    # OK
# e.score = -5  # raises ValidationError

back to menu

---

All validators raise twilkit.ValidationError with a clear, colored message on failure.

---

Colors

Minimal ANSI color helpers for terminals.

• color(value) → wraps the value and provides properties:

  • .red, .light_green, .green, .yellow, .blue, .light_blue, .magenta, .cyan, .black, .purple, .orange

• Colors enum → raw escape codes

• Cprint class → underlying helper

from twilkit import color, Colors

print(color("Success").green)
print(color("Warning").yellow)
print(f"{Colors.RED.value}Error{Colors.RESET.value}")

back to menu

---

Decorators

@catch_exceptions

Catch any exception, print a colored error (<func> <error>), return None.

from twilkit import catch_exceptions, color

@catch_exceptions
def risky_div(a, b):
    return a / b

print(color("Result:").blue, risky_div(6, 3))  # 2.0
risky_div(1, 0)  # Prints colored error, returns None

back to menu

---

@log_function

Log function start, arguments, return values, and exceptions to <func_name>.log.

from twilkit import log_function

@log_function
def compute_total(prices):
    return sum(prices)

compute_total([10, 20, 30])  # Logs to compute_total.log

back to menu

---

FlexVar

A small, chainable dict-like container with a pretty string output.

from twilkit import FlexVar

cfg = (
    FlexVar("Server Config")
      .add("host", "localhost")
      .add("port", 8080)
      .update("port", 9090)
)

print(cfg["host"])  # "localhost"
print(cfg.port)     # "9090"
print(cfg)          # Pretty formatted block

"host" in cfg       # True
del cfg["port"]     # Remove key
for key, val in cfg:
    print(key, val)

Error behavior:

• .add(name, _) → KeyError if attribute exists
• .update(name, _) / .remove(name) → KeyError if missing
• .__getattr__(name) → AttributeError if missing
• .__getitem__ / .__delitem__ → KeyError if missing

back to menu

---

Mini Project: User Registry CLI

Combining validators, colors, decorators, and FlexVar.

# file: user_registry.py
from twilkit import validators, color, log_function, catch_exceptions, FlexVar

class User:
    name  = validators.StartWith("Mr ", "Ms ", "Dr ")
    email = validators.EndsWith("@example.com", "@corp.local")
    age   = validators.InBetween(0, 130)

    def __init__(self, name: str, email: str, age: int):
        self.name = name
        self.email = email
        self.age = age

class Registry:
    def __init__(self):
        self._db = []

    @log_function
    @catch_exceptions
    def add_user(self, name: str, email: str, age: int):
        user = User(name, email, age)
        entry = (
            FlexVar("User")
            .add("name", user.name)
            .add("email", user.email)
            .add("age", user.age)
        )
        self._db.append(entry)
        print(color("User added").green)
        print(entry)
        return entry

    @log_function
    def list_users(self):
        if not self._db:
            print(color("No users found").yellow)
            return []
        print(color(f"Total users: {len(self._db)}").cyan)
        for i, entry in enumerate(self._db, start=1):
            print(color(f"[{i}]").purple)
            print(entry)
        return list(self._db)

    @log_function
    @catch_exceptions
    def update_email(self, index: int, new_email: str):
        entry = self._db[index]
        tmp = User(entry.name, new_email, entry.age)  # re-validation
        entry["email"] = tmp.email
        print(color("Email updated").light_green)
        print(entry)
        return entry

if __name__ == "__main__":
    reg = Registry()
    reg.add_user("Dr Alice", "[e-mail]", 34)
    reg.add_user("Ms Eve", "[e-mail]", 29)  # invalid -> ValidationError
    reg.list_users()
    reg.update_email(0, "[e-mail]")
    reg.list_users()

This demonstrates:

• Validation: descriptors enforce constraints
• Colors: feedback messages
• Logging: each method logs to its own file
• FlexVar: flexible, human-readable data storage

back to menu

---

Contributing

• Issues and PRs are welcome.
• Keep scope small, API tidy, docs clear.
• Include tests for new features .

---

License

This project is licensed under the terms of the MIT License.

back to menu

---

Extra Tools (PyTxt, Return, Copy helpers)

New in 1.1.0 – Utility helpers under twilkit.extra_tools and re-exported at the top level.

back to menu

---

PyTxt

A lightweight text/file wrapper that lets you work with an in-memory buffer or a bound file (via ADVfile_manager.TextFile).

from twilkit import PyTxt
p = PyTxt("hello")
p.text                       # 'hello'
p.file = "backups/example.txt"  # binds to a file (created if missing)
p.text = "new content"          # writes to disk via ADVfile_manager

Key notes:

• read_only=True blocks writes and raises PermissionError when setting .text.
• Assigning .file = <path> auto-creates a TextFile using basename/dirname.
• Deleting del p.file pulls content back into memory and removes the file on disk.

back to menu

---

Return

A tiny “result” object for returning a payload + success/error state.

from twilkit import Return
ok = Return(True, file="out.txt", size=123)
if ok:
    print(ok["file"], ok.get("size"))

err = Return.fail("not found", query="*.txt")
if not err:
    print("Error:", err.error)

Conveniences: .ok (alias for success), .dict(), .unwrap(key, default), and .raise_for_error().

back to menu

---

Copy helpers

Create a counted copy of a Python module with a header and optional removal of the __main__ block.

from twilkit import copy_this_module
res = copy_this_module("backups", new_name="final.py", include_main=False)
print("Created:", res["file_name"], "at", res["file_path"])

Parameters:

• new_copy_file_path: target folder.
• copy_num: start index for numbering; if the target exists, numbering auto-increments.
• new_name: optional output file name (suffix optional; source suffix is inherited if missing).
• include_main: keep or remove the if __name__ == '__main__': block in the copy.

These helpers rely on ADVfile_manager for safe file operations. Install with extras: pip install twilkit[extra_tools].

back to menu

---