python.Utilities.ldict Class Reference

Inheritance diagram for python.Utilities.ldict:

Collaboration diagram for python.Utilities.ldict:

Public Member Functions
	__init__ (self, **args)
	__setitem__ (self, k, v)
	update (self, **args)
	clone (self, **args)

Detailed Description

A dictionnary which items can not be modified once set.

Also implements 2 additional features :
 - a clone method to conveniently create a new version with only some items changed
 - all items are also attributes (i.e. d['a'] can be accessed by d.a : this is mostly for easier interactive inspection)

Definition at line 139 of file Utilities.py.

Constructor & Destructor Documentation

__init__()

python.Utilities.ldict.__init__	(		self,
		**	args )

Definition at line 146 of file Utilities.py.

    def __init__(self, **args):
        super().__init__(**args)
        # make key aivailable as attribute
        for k,v in args.items():
            super().__setattr__(k,v)
        

Member Function Documentation

__setitem__()

python.Utilities.ldict.__setitem__	(		self,
			k,
			v )

Definition at line 152 of file Utilities.py.

    def __setitem__(self, k, v):
        if k in self:
            if v!=self[k]:
                raise KeyError(f"Can't override self[{k}] == {self[k]} with new value {v}")
        else:
            super().__setitem__(k,v)
            super().__setattr__(k,v)
 

clone()

python.Utilities.ldict.clone	(		self,
		**	args )

Definition at line 164 of file Utilities.py.

    def clone(self,**args):
        from copy import deepcopy
        o = deepcopy(self)
        for k,v in args.items():
            # bypass the protection to update the user given items
            dict.__setitem__(o,k,v)            
            dict.__setattr__(o,k,v)
        return o
            

update()

python.Utilities.ldict.update	(		self,
		**	args )

Definition at line 160 of file Utilities.py.

    def update(self, **args): # we need to redefine it
        for k,v in args.items():
            self[k]=v
 

---

The documentation for this class was generated from the following file:

• Utilities.py