Skip to content

Latest commit

 

History

History
307 lines (247 loc) · 6.77 KB

EXAMPLES.md

File metadata and controls

307 lines (247 loc) · 6.77 KB

Usage Examples

Comprehensive examples for using Python Utilities functions.

String Utilities

Capitalize Words

from utils import string_utils

# Capitalize each word in a sentence
text = "hello world from python"
result = string_utils.capitalize_words(text)
print(result)  # Output: "Hello World From Python"

Reverse String

message = "Hello, Python!"
reversed_msg = string_utils.reverse_string(message)
print(reversed_msg)  # Output: "!nohtyP ,olleH"

Count Vowels

sentence = "Python is awesome"
vowel_count = string_utils.count_vowels(sentence)
print(f"Vowels: {vowel_count}")  # Output: Vowels: 6

Truncate Text

long_text = "This is a very long text that needs truncation"
short_text = string_utils.truncate(long_text, 20)
print(short_text)  # Output: "This is a very lo..."

Math Utilities

Calculate Average

from utils import math_utils

numbers = [85, 90, 78, 92, 88]
average = math_utils.calculate_average(numbers)
print(f"Average: {average}")  # Output: Average: 86.6

Find Median

data = [15, 20, 35, 40, 50]
median = math_utils.find_median(data)
print(f"Median: {median}")  # Output: Median: 35.0

Calculate Percentage

score = 85
total = 100
percentage = math_utils.calculate_percentage(score, total)
print(f"Score: {percentage}%")  # Output: Score: 85.0%

Check Prime Number

number = 17
if math_utils.is_prime(number):
    print(f"{number} is prime")
else:
    print(f"{number} is not prime")

File Utilities

Read File Lines

from utils import file_utils

# Read all lines from a file
lines = file_utils.read_file_lines("data.txt")
for line in lines:
    print(line.strip())

Write File Lines

content = ["Line 1\n", "Line 2\n", "Line 3\n"]
file_utils.write_file_lines("output.txt", content)

Get File Extension

filepath = "/path/to/document.pdf"
ext = file_utils.get_file_extension(filepath)
print(f"Extension: {ext}")  # Output: Extension: pdf

List Files in Directory

# List all Python files in a directory
python_files = file_utils.list_files_in_directory("./src", "py")
for file in python_files:
    print(file)

Create Directory

# Create a new directory if it doesn't exist
was_created = file_utils.create_directory_if_not_exists("./output/results")
if was_created:
    print("Directory created")

Date Utilities

Get Current Timestamp

from utils import date_utils

timestamp = date_utils.get_current_timestamp()
print(f"Now: {timestamp}")

Format Date

from datetime import datetime

date = datetime(2026, 1, 26)
formatted = date_utils.format_date(date, "%B %d, %Y")
print(formatted)  # Output: January 26, 2026

Parse Date String

date_string = "2026-01-26"
date_obj = date_utils.parse_date(date_string)
print(date_obj)

Add Days to Date

from datetime import datetime

today = datetime.now()
next_week = date_utils.add_days(today, 7)
print(f"Next week: {next_week}")

Calculate Days Between Dates

from datetime import datetime

start = datetime(2026, 1, 1)
end = datetime(2026, 1, 31)
days = date_utils.get_days_between(start, end)
print(f"Days: {days}")  # Output: Days: 30

Check Weekend

from datetime import datetime

date = datetime(2026, 1, 24)  # Saturday
if date_utils.is_weekend(date):
    print("It's weekend!")

Validation Utilities

Validate Email

from utils import validation_utils

email = "user@example.com"
if validation_utils.is_valid_email(email):
    print("Valid email")
else:
    print("Invalid email")

Validate URL

url = "https://github.com/aptus0"
if validation_utils.is_valid_url(url):
    print("Valid URL")

Validate Phone Number

phone = "555-123-4567"
if validation_utils.is_valid_phone(phone, "US"):
    print("Valid US phone number")

Check Empty or None

value = ""
if validation_utils.is_empty_or_none(value):
    print("Value is empty or none")

Check Numeric String

value = "123.45"
if validation_utils.is_numeric(value):
    number = float(value)
    print(f"Numeric value: {number}")

Validate Range

age = 25
if validation_utils.is_in_range(age, 18, 100):
    print("Age is valid")

Check Minimum Length

password = "mypassword123"
if validation_utils.has_minimum_length(password, 8):
    print("Password meets minimum length")

Combined Examples

User Registration Validation

from utils import validation_utils, string_utils

def validate_user_registration(email, password, name):
    errors = []
    
    # Validate email
    if not validation_utils.is_valid_email(email):
        errors.append("Invalid email format")
    
    # Validate password length
    if not validation_utils.has_minimum_length(password, 8):
        errors.append("Password must be at least 8 characters")
    
    # Validate name
    if validation_utils.is_empty_or_none(name):
        errors.append("Name is required")
    
    if errors:
        return False, errors
    
    # Process valid registration
    formatted_name = string_utils.capitalize_words(name)
    return True, {"email": email, "name": formatted_name}

# Test
success, result = validate_user_registration(
    "user@example.com",
    "securepass123",
    "john doe"
)
if success:
    print(f"Registration successful: {result}")
else:
    print(f"Errors: {result}")

Data Processing Pipeline

from utils import file_utils, string_utils, math_utils

def process_data_file(input_file, output_file):
    # Read data
    lines = file_utils.read_file_lines(input_file)
    
    # Process each line
    processed = []
    numbers = []
    
    for line in lines:
        clean_line = line.strip()
        if validation_utils.is_numeric(clean_line):
            numbers.append(float(clean_line))
        else:
            # Capitalize text lines
            processed.append(string_utils.capitalize_words(clean_line) + "\n")
    
    # Calculate statistics
    if numbers:
        avg = math_utils.calculate_average(numbers)
        median = math_utils.find_median(numbers)
        processed.append(f"\nStatistics:\n")
        processed.append(f"Average: {avg}\n")
        processed.append(f"Median: {median}\n")
    
    # Write output
    file_utils.write_file_lines(output_file, processed)

# Usage
process_data_file("input.txt", "output.txt")

Testing Your Code

Run these examples to test the utilities:

python3 -c "from utils import string_utils; print(string_utils.capitalize_words('hello world'))"
python3 -c "from utils import math_utils; print(math_utils.calculate_average([10,20,30]))"
python3 -c "from utils import validation_utils; print(validation_utils.is_valid_email('test@example.com'))"