Package couchdbkit :: Package schema :: Module properties :: Class DictProperty

Class DictProperty

object --+    
         |    
  Property --+
             |
            DictProperty

A property that stores a dict of things

Nested Classes

[hide private]

data_type
dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list.

Instance Methods

[hide private]

__init__(self, verbose_name=None, default=None, required=False, **kwds)
:args verbose_name: Optional verbose name.

source code

validate(self, value, required=True)
validate value

source code

validate_dict_contents(self, value)

source code

default_value(self)
Default value for list.

source code

to_python(self, value)
convert to python type

source code

to_json(self, value)
convert to json, Converted value is saved in couchdb.

source code

Inherited from Property: __delete__, __get__, __property_config__, __property_init__, __set__, empty

Inherited from Property (private): _to_json, _to_python

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

Inherited from Property: creation_counter

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, verbose_name=None, default=None, required=False, **kwds)
(Constructor)

source code

:args verbose_name: Optional verbose name. :args default: Optional default value; if omitted, an empty list is used. :args**kwds: Optional additional keyword arguments, passed to base class.

Note that the only permissible value for 'required' is True.

Overrides: object.__init__

validate(self, value, required=True)

source code

validate value

Overrides: Property.validate: (inherited documentation)

default_value(self)

source code

Default value for list.

Because the property supplied to 'default' is a static value,
that value must be shallow copied to prevent all fields with
default values from sharing the same instance.

Returns:
  Copy of the default value.

Overrides: Property.default_value

to_python(self, value)

source code

convert to python type

Overrides: Property.to_python: (inherited documentation)

to_json(self, value)

source code

convert to json, Converted value is saved in couchdb.

Overrides: Property.to_json: (inherited documentation)

Class DictProperty

__init__(self, verbose_name=None, default=None, required=False, **kwds) (Constructor)

validate(self, value, required=True)

default_value(self)

to_python(self, value)

to_json(self, value)

init(self, verbose_name=None, default=None, required=False, **kwds)
(Constructor)