JSON to Func

A Python library that converts JSON keys to callable methods on a class.

Installation

pip install json-to-func

Usage

Basic Usage

from json_to_func import JsonToFunc, load

# Load from a JSON file
translator = JsonToFunc("messages.json")

# Or use the convenience function
translator = load("messages.json")

# Or load from a dictionary
translator = JsonToFunc({
    "hello": "Hello, World!",
    "greeting": "Hello, %s!"
})

Calling Methods

JSON keys are automatically transformed into valid Python method names:

# Simple key
translator.hello()  # Returns: "Hello, World!"

# With placeholder
translator.greeting("John")  # Returns: "Hello, John!"

Key Transformation Rules

Rules:

• Dashes (-) become single underscores (_)
• Colons (:) become double underscores (__)
• Other invalid characters become underscores
• Keys starting with numbers get a leading underscore

Format String Support

The library supports %s placeholders in values:

data = {
    "field-required": "%s is required",
    "range-error": "Value must be between %s and %s"
}

translator = JsonToFunc(data)

translator.field_required("Email")  # "Email is required"
translator.range_error("1", "10")   # "Value must be between 1 and 10"

Alternative Access Methods

# Get by original key name
translator.get("field-required", "Email")

# Get by transformed function name
translator.get_by_func_name("field_required", "Email")

# With default value
translator.get("nonexistent", default="fallback")

Utility Methods

# List all original keys
translator.keys()  # ["hello", "field-required", ...]

# List all method names
translator.func_names()  # ["hello", "field_required", ...]

# Check if key exists
"hello" in translator  # True
"field_required" in translator  # True

# Get count
len(translator)  # Number of entries

Example with i18n/Translation Files

{
  "tomans": "تومان",
  "field-required": "%s الزامی است",
  "entity-not-exists": "چنین %s وجود ندارد",
  "hint-bar:title:welcome": "خوش آمدید"
}

from json_to_func import JsonToFunc

messages = JsonToFunc("fa.json")

print(messages.tomans())  # تومان
print(messages.field_required("ایمیل"))  # ایمیل الزامی است
print(messages.entity_not_exists("کاربر"))  # چنین کاربر وجود ندارد
print(messages.hint_bar__title__welcome())  # خوش آمدید

License

MIT