dictclasses 1.0.0

A simple yet powerful decorator to create custom classes with dict-like behavior.

dictclasses

A simple yet powerful decorator to create custom classes with dict-like behavior.

Installation

pip install dictclasses

Description

dictclasses provides the @dictclass decorator that transforms any Python class into a dict-like object. The decorated class accepts a dictionary as its first argument and exposes all standard dictionary methods (keys, values, items, get, pop, update, etc.) while allowing you to define custom methods and properties.

Usage

Basic usage

from dictclasses import dictclass

@dictclass
class Person:
    @property
    def full_name(self):
        return f"{self['first_name']} {self['last_name']}"

person = Person({"first_name": "John", "last_name": "Doe"})
print(person["first_name"])  # John
print(person.full_name)      # John Doe
print(person.keys())         # dict_keys(['first_name', 'last_name'])

From JSON / HJSON files

@dictclass
class Config:
    pass

config = Config.from_json("config.json")
# or
config = Config.from_hjson("config.hjson")

Available methods

The decorator adds the following dict methods (unless already defined in the class):

• __getitem__, __setitem__
• __len__, __iter__
• keys, values, items
• get, pop, popitem
• copy, deepcopy
• update, clear, setdefault
• fromkeys
• from_json, from_hjson (class methods)